Jelajahi Sumber

Add missing typedoc

bghgary 5 tahun lalu
induk
melakukan
5ff126f37c
1 mengubah file dengan 33 tambahan dan 0 penghapusan
  1. 33 0
      src/Misc/dataStorage.ts

+ 33 - 0
src/Misc/dataStorage.ts

@@ -29,29 +29,62 @@ export class DataStorage {
         }
     }
 
+    /**
+     * Reads a string from the data storage
+     * @param key The key to read
+     * @param defaultValue The value if the key doesn't exist
+     * @returns The string value
+     */
     public static ReadString(key: string, defaultValue: string): string {
         const value = this._Storage.getItem(key);
         return (value !== null ? value : defaultValue);
     }
 
+    /**
+     * Writes a string to the data storage
+     * @param key The key to write
+     * @param value The value to write
+     */
     public static WriteString(key: string, value: string): void {
         this._Storage.setItem(key, value);
     }
 
+    /**
+     * Reads a boolean from the data storage
+     * @param key The key to read
+     * @param defaultValue The value if the key doesn't exist
+     * @returns The boolean value
+     */
     public static ReadBoolean(key: string, defaultValue: boolean): boolean {
         const value = this._Storage.getItem(key);
         return (value !== null ? (value === "true") : defaultValue);
     }
 
+    /**
+     * Writes a boolean to the data storage
+     * @param key The key to write
+     * @param value The value to write
+     */
     public static WriteBoolean(key: string, value: boolean) {
         this._Storage.setItem(key, value ? "true" : "false");
     }
 
+    /**
+     * Reads a number from the data storage
+     * @param key The key to read
+     * @param defaultValue The value if the key doesn't exist
+     * @returns The number value
+     */
     public static ReadNumber(key: string, defaultValue: number): number {
         const value = this._Storage.getItem(key);
         return (value !== null ? parseFloat(value) : defaultValue);
     }
 
+    /**
+     * Writes a number to the data storage
+     * @param key The key to write
+     * @param value The value to write
+     */
     public static WriteNumber(key: string, value: number) {
         this._Storage.setItem(key, value.toString());
     }