@unikvs/indexeddb 0.0.8 → 0.0.9

package/dist/src/indexeddb.d.ts

@@ -17,23 +17,79 @@ export default class Indexeddb implements IStorage {
      * 使用するオブジェクトストア名です。
      */
     private readonly storeName;
+    /**
+     * ストレージの名前です。デバッグメッセージなどに使用されます。
+     */
     readonly name: string;
     /**
      * Indexeddb インスタンスを初期化します。
      *
-     * @param dbName データベース名です。
-     * @param storeName データを保存するオブジェクトストア名です。
+     * @param dbName データベース名です。デフォルトは `"unikvs_db"` です。
+     * @param storeName データを保存するオブジェクトストア名です。デフォルトは `"kvs_store"` です。
      */
     constructor(dbName?: string, storeName?: string);
+    /** ストレージが現在利用可能な状態であるかを示します。 */
     get isOpen(): boolean;
+    /**
+     * ストレージをオープンし、IndexedDB データベースへの接続を確立します。
+     *
+     * 既にオープンされている場合は何も行いません。
+     */
     open(): Promise<void>;
+    /**
+     * ストレージを安全にクローズします。
+     *
+     * データベース接続を閉じ、内部状態を初期化します。
+     */
     close(): Promise<void>;
+    /**
+     * 指定されたデータを、対応するキーでストレージに保存します。
+     *
+     * @param args.key 保存先のキーです。
+     * @param args.data 保存するデータです。
+     */
     write(args: Pick<IStorage.WriteArgs<any>, "key" | "data">): Promise<void>;
+    /**
+     * 指定されたキーに対応するデータをストレージから取得します。
+     *
+     * @param args.key 取得元のキーです。
+     * @returns キーに対応するデータです。存在しない場合は DOMException (NotFoundError) を投げます。
+     */
     read(args: Pick<IStorage.ReadArgs, "key">): Promise<any>;
+    /**
+     * 指定されたキーに対応するデータがストレージ内に存在するかを確認します。
+     *
+     * @param args.key 確認するキーです。
+     * @returns キーに対応するデータが存在する場合は true、それ以外は false です。
+     */
     exists(args: Pick<IStorage.ExistsArgs, "key">): Promise<boolean>;
+    /**
+     * 指定されたキーに対応するデータをストレージから削除します。
+     *
+     * @param args.key 削除するキーです。
+     */
     delete(args: Pick<IStorage.DeleteArgs, "key">): Promise<void>;
+    /**
+     * ストレージ内のすべてのデータを完全に消去します。
+     */
     clear(): Promise<void>;
+    /**
+     * 指定されたキーに対応する書き込み可能なストリームを取得します。
+     *
+     * IndexedDB にはネイティブなストリームがないため、書き込まれたチャンクをメモリー上に保持し、ストリームがクローズされたときにまとめて保存します。
+     *
+     * @param args.key 書き込み先のキーです。
+     * @returns 書き込み可能なストリームです。
+     */
     getWritable(args: Pick<IStorage.GetWritableArgs, "key">): WritableStream<Uint8Array>;
+    /**
+     * 指定されたキーに対応する読み取り可能なストリームを取得します。
+     *
+     * IndexedDB にはネイティブなストリームがないため、データ全体をメモリーにロードしてから単一チャンクとしてストリームで送出します。
+     *
+     * @param args.key 読み取り元のキーです。
+     * @returns 読み取り可能なストリームです。
+     */
     getReadable(args: Pick<IStorage.GetReadableArgs, "key">): ReadableStream<Uint8Array>;
 }
 //# sourceMappingURL=indexeddb.d.ts.map

package/dist/src/indexeddb.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"indexeddb.d.ts","sourceRoot":"","sources":["../../src/indexeddb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,YAAW,QAAQ;IAChD;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAsB;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;gBACgB,MAAM,GAAE,MAAoB,EAAE,SAAS,GAAE,MAAoB;IAOhF,IAAW,MAAM,IAAI,OAAO,CAE3B;IAEY,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAerB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKtB,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKzE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAaxD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQhE,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAI5B,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;IAwBpF,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;CAY5F"}
+{"version":3,"file":"indexeddb.d.ts","sourceRoot":"","sources":["../../src/indexeddb.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAG7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,SAAU,YAAW,QAAQ;IAChD;;;;OAIG;IACH,OAAO,CAAC,EAAE,CAAsB;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IAEnC;;OAEG;IACH,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;;;;OAKG;gBACgB,MAAM,GAAE,MAAoB,EAAE,SAAS,GAAE,MAAoB;IAOhF,gCAAgC;IAChC,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED;;;;OAIG;IACU,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAelC;;;;OAIG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAKnC;;;;;OAKG;IACU,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKtF;;;;;OAKG;IACU,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC;IAarE;;;;;OAKG;IACU,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAQ7E;;;;OAIG;IACU,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAM1E;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;;;;OAOG;IACI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;IAuB3F;;;;;;;OAOG;IACI,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAAG,cAAc,CAAC,UAAU,CAAC;CAW5F"}

package/dist/src/indexeddb.js

@@ -6,8 +6,8 @@ export default class Indexeddb {
     /**
      * Indexeddb インスタンスを初期化します。
      *
-     * @param dbName データベース名です。
-     * @param storeName データを保存するオブジェクトストア名です。
+     * @param dbName データベース名です。デフォルトは `"unikvs_db"` です。
+     * @param storeName データを保存するオブジェクトストア名です。デフォルトは `"kvs_store"` です。
      */
     constructor(dbName = "unikvs_db", storeName = "kvs_store") {
         this.name = "Indexeddb";
@@ -15,9 +15,15 @@ export default class Indexeddb {
         this.dbName = dbName;
         this.storeName = storeName;
     }
+    /** ストレージが現在利用可能な状態であるかを示します。 */
     get isOpen() {
         return this.db !== null;
     }
+    /**
+     * ストレージをオープンし、IndexedDB データベースへの接続を確立します。
+     *
+     * 既にオープンされている場合は何も行いません。
+     */
     async open() {
         if (this.db) {
             return;
@@ -31,14 +37,31 @@ export default class Indexeddb {
             },
         });
     }
+    /**
+     * ストレージを安全にクローズします。
+     *
+     * データベース接続を閉じ、内部状態を初期化します。
+     */
     async close() {
         this.db.close();
         this.db = null;
     }
+    /**
+     * 指定されたデータを、対応するキーでストレージに保存します。
+     *
+     * @param args.key 保存先のキーです。
+     * @param args.data 保存するデータです。
+     */
     async write(args) {
         const { key, data } = args;
         await this.db.put(this.storeName, data, key);
     }
+    /**
+     * 指定されたキーに対応するデータをストレージから取得します。
+     *
+     * @param args.key 取得元のキーです。
+     * @returns キーに対応するデータです。存在しない場合は DOMException (NotFoundError) を投げます。
+     */
     async read(args) {
         const { key } = args;
         // Opfs の挙動に合わせて、存在しない場合は DOMException (NotFoundError) を投げます
@@ -47,23 +70,44 @@ export default class Indexeddb {
         }
         return await this.db.get(this.storeName, key);
     }
+    /**
+     * 指定されたキーに対応するデータがストレージ内に存在するかを確認します。
+     *
+     * @param args.key 確認するキーです。
+     * @returns キーに対応するデータが存在する場合は true、それ以外は false です。
+     */
     async exists(args) {
         const { key } = args;
         // count() はキーが存在すれば 1 を、存在しなければ 0 を返します
         const count = await this.db.count(this.storeName, key);
         return count > 0;
     }
+    /**
+     * 指定されたキーに対応するデータをストレージから削除します。
+     *
+     * @param args.key 削除するキーです。
+     */
     async delete(args) {
         const { key } = args;
         await this.db.delete(this.storeName, key);
     }
+    /**
+     * ストレージ内のすべてのデータを完全に消去します。
+     */
     async clear() {
         await this.db.clear(this.storeName);
     }
+    /**
+     * 指定されたキーに対応する書き込み可能なストリームを取得します。
+     *
+     * IndexedDB にはネイティブなストリームがないため、書き込まれたチャンクをメモリー上に保持し、ストリームがクローズされたときにまとめて保存します。
+     *
+     * @param args.key 書き込み先のキーです。
+     * @returns 書き込み可能なストリームです。
+     */
     getWritable(args) {
         const { key } = args;
         const chunks = [];
-        // IndexedDB にはネイティブなファイルストリームがないため、書き込まれたチャンクをメモリに保持し、クローズ時にまとめて put します。
         return new WritableStream({
             write: (chunk) => {
                 chunks.push(chunk);
@@ -80,11 +124,18 @@ export default class Indexeddb {
             },
         });
     }
+    /**
+     * 指定されたキーに対応する読み取り可能なストリームを取得します。
+     *
+     * IndexedDB にはネイティブなストリームがないため、データ全体をメモリーにロードしてから単一チャンクとしてストリームで送出します。
+     *
+     * @param args.key 読み取り元のキーです。
+     * @returns 読み取り可能なストリームです。
+     */
     getReadable(args) {
         const { key } = args;
         return new ReadableStream({
             pull: async (controller) => {
-                // データ全体をメモリにロードしてから ReadableStream に流し込みます。
                 const data = await this.read({ key });
                 controller.enqueue(data);
                 controller.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unikvs/indexeddb",
-  "version": "0.0.8",
+  "version": "0.0.9",
   "description": "",
   "homepage": "https://github.com/tai-kun/unikvs",
   "license": "MIT",
@@ -25,7 +25,7 @@
     }
   },
   "dependencies": {
-    "@unikvs/core": "0.0.8",
+    "@unikvs/core": "0.0.9",
     "idb": "^8.0.3"
   },
   "devDependencies": {

package/src/indexeddb.ts

@@ -22,13 +22,16 @@ export default class Indexeddb implements IStorage {
    */
   private readonly storeName: string;
 
+  /**
+   * ストレージの名前です。デバッグメッセージなどに使用されます。
+   */
   public readonly name: string;
 
   /**
    * Indexeddb インスタンスを初期化します。
    *
-   * @param dbName データベース名です。
-   * @param storeName データを保存するオブジェクトストア名です。
+   * @param dbName データベース名です。デフォルトは `"unikvs_db"` です。
+   * @param storeName データを保存するオブジェクトストア名です。デフォルトは `"kvs_store"` です。
    */
   public constructor(dbName: string = "unikvs_db", storeName: string = "kvs_store") {
     this.name = "Indexeddb";
@@ -37,10 +40,16 @@ export default class Indexeddb implements IStorage {
     this.storeName = storeName;
   }
 
+  /** ストレージが現在利用可能な状態であるかを示します。 */
   public get isOpen(): boolean {
     return this.db !== null;
   }
 
+  /**
+   * ストレージをオープンし、IndexedDB データベースへの接続を確立します。
+   *
+   * 既にオープンされている場合は何も行いません。
+   */
   public async open(): Promise<void> {
     if (this.db) {
       return;
@@ -56,16 +65,33 @@ export default class Indexeddb implements IStorage {
     });
   }
 
+  /**
+   * ストレージを安全にクローズします。
+   *
+   * データベース接続を閉じ、内部状態を初期化します。
+   */
   public async close(): Promise<void> {
     this.db!.close();
     this.db = null;
   }
 
+  /**
+   * 指定されたデータを、対応するキーでストレージに保存します。
+   *
+   * @param args.key 保存先のキーです。
+   * @param args.data 保存するデータです。
+   */
   public async write(args: Pick<IStorage.WriteArgs<any>, "key" | "data">): Promise<void> {
     const { key, data } = args;
     await this.db!.put(this.storeName, data, key);
   }
 
+  /**
+   * 指定されたキーに対応するデータをストレージから取得します。
+   *
+   * @param args.key 取得元のキーです。
+   * @returns キーに対応するデータです。存在しない場合は DOMException (NotFoundError) を投げます。
+   */
   public async read(args: Pick<IStorage.ReadArgs, "key">): Promise<any> {
     const { key } = args;
     // Opfs の挙動に合わせて、存在しない場合は DOMException (NotFoundError) を投げます
@@ -79,6 +105,12 @@ export default class Indexeddb implements IStorage {
     return await this.db!.get(this.storeName, key);
   }
 
+  /**
+   * 指定されたキーに対応するデータがストレージ内に存在するかを確認します。
+   *
+   * @param args.key 確認するキーです。
+   * @returns キーに対応するデータが存在する場合は true、それ以外は false です。
+   */
   public async exists(args: Pick<IStorage.ExistsArgs, "key">): Promise<boolean> {
     const { key } = args;
 
@@ -87,21 +119,36 @@ export default class Indexeddb implements IStorage {
     return count > 0;
   }
 
+  /**
+   * 指定されたキーに対応するデータをストレージから削除します。
+   *
+   * @param args.key 削除するキーです。
+   */
   public async delete(args: Pick<IStorage.DeleteArgs, "key">): Promise<void> {
     const { key } = args;
 
     await this.db!.delete(this.storeName, key);
   }
 
+  /**
+   * ストレージ内のすべてのデータを完全に消去します。
+   */
   public async clear(): Promise<void> {
     await this.db!.clear(this.storeName);
   }
 
+  /**
+   * 指定されたキーに対応する書き込み可能なストリームを取得します。
+   *
+   * IndexedDB にはネイティブなストリームがないため、書き込まれたチャンクをメモリー上に保持し、ストリームがクローズされたときにまとめて保存します。
+   *
+   * @param args.key 書き込み先のキーです。
+   * @returns 書き込み可能なストリームです。
+   */
   public getWritable(args: Pick<IStorage.GetWritableArgs, "key">): WritableStream<Uint8Array> {
     const { key } = args;
     const chunks: Uint8Array[] = [];
 
-    // IndexedDB にはネイティブなファイルストリームがないため、書き込まれたチャンクをメモリに保持し、クローズ時にまとめて put します。
     return new WritableStream({
       write: (chunk) => {
         chunks.push(chunk);
@@ -121,12 +168,19 @@ export default class Indexeddb implements IStorage {
     });
   }
 
+  /**
+   * 指定されたキーに対応する読み取り可能なストリームを取得します。
+   *
+   * IndexedDB にはネイティブなストリームがないため、データ全体をメモリーにロードしてから単一チャンクとしてストリームで送出します。
+   *
+   * @param args.key 読み取り元のキーです。
+   * @returns 読み取り可能なストリームです。
+   */
   public getReadable(args: Pick<IStorage.GetReadableArgs, "key">): ReadableStream<Uint8Array> {
     const { key } = args;
 
     return new ReadableStream({
       pull: async (controller) => {
-        // データ全体をメモリにロードしてから ReadableStream に流し込みます。
         const data = await this.read({ key });
         controller.enqueue(data);
         controller.close();