@unikvs/memory 0.0.7 → 0.0.9

package/dist/src/errors.d.ts

@@ -1,17 +1,37 @@
 import { ErrorBase, type ErrorOptions } from "@unikvs/core";
+/**
+ * 指定されたキーがストレージ内に存在しないことを示すエラーメタデータ型です。
+ */
 export type KeyNotFoundErrorMeta = {
     readonly key: string;
 };
+/**
+ * {@link KeyNotFoundError} のコンストラクター引数型です。
+ */
 export type KeyNotFoundErrorArgs = KeyNotFoundErrorMeta;
+/**
+ * 読み取りまたは削除を実行しようとしたキーがストレージ内に存在しない場合に投げられるエラーです。
+ */
 export declare class KeyNotFoundError extends ErrorBase<KeyNotFoundErrorMeta> {
     constructor(args: KeyNotFoundErrorArgs, options?: ErrorOptions);
 }
+/**
+ * ストリーム書き込み時に無効なチャンク型が渡されたことを示すエラーメタデータ型です。
+ */
 export type InvalidChunkTypeErrorMeta = {
     readonly key: string;
     readonly chunk: unknown;
     readonly chunkType: string;
 };
+/**
+ * {@link InvalidChunkTypeError} のコンストラクター引数型です。
+ *
+ * `chunkType` はコンストラクター内部で自動的に設定されるため、引数からは除外されています。
+ */
 export type InvalidChunkTypeErrorArgs = Omit<InvalidChunkTypeErrorMeta, "chunkType">;
+/**
+ * `getWritable` が返すストリームに `Uint8Array<ArrayBuffer>` 以外の値が書き込まれた場合に投げられるエラーです。
+ */
 export declare class InvalidChunkTypeError extends ErrorBase<InvalidChunkTypeErrorMeta> {
     constructor(args: InvalidChunkTypeErrorArgs, options?: ErrorOptions);
 }

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

@@ -1 +1 @@
-{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,YAAY,EAAmB,MAAM,cAAc,CAAC;AAG7E,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAExD,qBAAa,gBAAiB,SAAQ,SAAS,CAAC,oBAAoB,CAAC;gBAKhD,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,YAAY;CAGtE;AAID,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,yBAAyB,EAAE,WAAW,CAAC,CAAC;AAErF,qBAAa,qBAAsB,SAAQ,SAAS,CAAC,yBAAyB,CAAC;gBAK1D,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,YAAY;CAW3E"}
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,KAAK,YAAY,EAAmB,MAAM,cAAc,CAAC;AAG7E;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC;AAExD;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,SAAS,CAAC,oBAAoB,CAAC;gBAKhD,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,YAAY;CAGtE;AAID;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAAC,yBAAyB,EAAE,WAAW,CAAC,CAAC;AAErF;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,SAAS,CAAC,yBAAyB,CAAC;gBAK1D,IAAI,EAAE,yBAAyB,EAAE,OAAO,CAAC,EAAE,YAAY;CAW3E"}

package/dist/src/errors.js

@@ -1,6 +1,9 @@
 var _a, _b;
 import { ErrorBase, setErrorMessage } from "@unikvs/core";
 import getTypeName from "type-name";
+/**
+ * 読み取りまたは削除を実行しようとしたキーがストレージ内に存在しない場合に投げられるエラーです。
+ */
 export class KeyNotFoundError extends ErrorBase {
     constructor(args, options) {
         super(args, ({ key }) => `Key not found: ${key}`, options);
@@ -11,6 +14,9 @@ _a = KeyNotFoundError;
     _a.prototype.name = "MemoryKeyNotFoundError";
 })();
 setErrorMessage(KeyNotFoundError, ({ key }) => `キー ${key} が見つかりません`, "ja");
+/**
+ * `getWritable` が返すストリームに `Uint8Array<ArrayBuffer>` 以外の値が書き込まれた場合に投げられるエラーです。
+ */
 export class InvalidChunkTypeError extends ErrorBase {
     constructor(args, options) {
         super({

package/dist/src/memory.d.ts

@@ -1,12 +1,21 @@
 import type { IStorage } from "@unikvs/core";
 /**
  * メモリーを永続化先として使用するストレージクラスです。
+ *
+ * アプリケーションの実行中のみデータを保持し、プロセス終了時に破棄されます。
+ * 全ての操作が同期で完了するため、非同期処理のオーバーヘッドがありません。
  */
 export default class Memory implements IStorage {
+    /**
+     * キーと値のペアを保持する内部マップです。
+     */
     private readonly map;
+    /** ストレージの名前です。デバッグやエラーメッセージなどに使用されます。 */
     readonly name: string;
     /**
      * Memory インスタンスを初期化します。
+     *
+     * 内部のマップを初期化し、常にオープン状態として動作します。
      */
     constructor();
     get isOpen(): boolean;

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

@@ -1 +1 @@
-{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAI7C;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,YAAW,QAAQ;IAC7C,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAmB;IAEvC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;OAEG;;IAMH,IAAW,MAAM,IAAI,OAAO,CAE3B;IAEM,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,GAAG,IAAI;IAKhE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,GAAG;IAW/C,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO;IAOvD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,IAAI;IASpD,KAAK,IAAI,IAAI;IAIb,WAAW,CAChB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAC1C,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IA4BnC,WAAW,CAChB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAC1C,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAoB3C"}
+{"version":3,"file":"memory.d.ts","sourceRoot":"","sources":["../../src/memory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAI7C;;;;;GAKG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,YAAW,QAAQ;IAC7C;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAmB;IAEvC,yCAAyC;IACzC,SAAgB,IAAI,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;;IAMH,IAAW,MAAM,IAAI,OAAO,CAE3B;IAEM,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC,GAAG,IAAI;IAKhE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,KAAK,CAAC,GAAG,GAAG;IAW/C,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,OAAO;IAOvD,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,KAAK,CAAC,GAAG,IAAI;IASpD,KAAK,IAAI,IAAI;IAIb,WAAW,CAChB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAC1C,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;IA6BnC,WAAW,CAChB,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,eAAe,EAAE,KAAK,CAAC,GAC1C,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;CAqB3C"}

package/dist/src/memory.js

@@ -1,10 +1,15 @@
-import { InvalidChunkTypeError, KeyNotFoundError } from "./errors.js";
+import { KeyNotFoundError, InvalidChunkTypeError } from "./errors.js";
 /**
  * メモリーを永続化先として使用するストレージクラスです。
+ *
+ * アプリケーションの実行中のみデータを保持し、プロセス終了時に破棄されます。
+ * 全ての操作が同期で完了するため、非同期処理のオーバーヘッドがありません。
  */
 export default class Memory {
     /**
      * Memory インスタンスを初期化します。
+     *
+     * 内部のマップを初期化し、常にオープン状態として動作します。
      */
     constructor() {
         this.name = "Memory";
@@ -42,6 +47,7 @@ export default class Memory {
     }
     getWritable(args) {
         const { key } = args;
+        // メモリーストレージにはネイティブなストリームがないため、書き込まれたチャンクを配列に保持し、クローズ時に結合して保存します。
         const chunks = [];
         const stream = new WritableStream({
             write: (chunk) => {
@@ -68,6 +74,7 @@ export default class Memory {
         if (!this.map.has(key)) {
             throw new KeyNotFoundError({ key });
         }
+        // メモリーストレージにはネイティブなストリームがないため、既存の値を単一チャンクとしてストリームで送出します。
         const value = this.map.get(key);
         const stream = new ReadableStream({
             pull: (controller) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@unikvs/memory",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "",
   "homepage": "https://github.com/tai-kun/unikvs",
   "license": "MIT",
@@ -25,20 +25,20 @@
     }
   },
   "dependencies": {
-    "@unikvs/core": "0.0.7",
+    "@unikvs/core": "0.0.9",
     "type-name": "^2.0.2"
   },
   "devDependencies": {
     "@tsconfig/node24": "^24.0.4",
     "@tsconfig/strictest": "^2.0.8",
-    "@types/node": "^24.12.2",
+    "@types/node": "^24.12.4",
     "@types/type-name": "^1.0.32",
-    "@vitest/browser": "^4.1.5",
-    "@vitest/browser-playwright": "^4.1.5",
+    "@vitest/browser": "^4.1.6",
+    "@vitest/browser-playwright": "^4.1.6",
     "npm-check-updates": "^20.0.2",
-    "playwright": "^1.59.1",
-    "vite": "^8.0.10",
-    "vitest": "^4.1.5"
+    "playwright": "^1.60.0",
+    "vite": "^8.0.12",
+    "vitest": "^4.1.6"
   },
   "peerDependencies": {
     "@logtape/logtape": "^2.0.0"

package/src/errors.ts

@@ -1,12 +1,21 @@
 import { ErrorBase, type ErrorOptions, setErrorMessage } from "@unikvs/core";
 import getTypeName from "type-name";
 
+/**
+ * 指定されたキーがストレージ内に存在しないことを示すエラーメタデータ型です。
+ */
 export type KeyNotFoundErrorMeta = {
   readonly key: string;
 };
 
+/**
+ * {@link KeyNotFoundError} のコンストラクター引数型です。
+ */
 export type KeyNotFoundErrorArgs = KeyNotFoundErrorMeta;
 
+/**
+ * 読み取りまたは削除を実行しようとしたキーがストレージ内に存在しない場合に投げられるエラーです。
+ */
 export class KeyNotFoundError extends ErrorBase<KeyNotFoundErrorMeta> {
   static {
     this.prototype.name = "MemoryKeyNotFoundError";
@@ -19,14 +28,25 @@ export class KeyNotFoundError extends ErrorBase<KeyNotFoundErrorMeta> {
 
 setErrorMessage(KeyNotFoundError, ({ key }) => `キー ${key} が見つかりません`, "ja");
 
+/**
+ * ストリーム書き込み時に無効なチャンク型が渡されたことを示すエラーメタデータ型です。
+ */
 export type InvalidChunkTypeErrorMeta = {
   readonly key: string;
   readonly chunk: unknown;
   readonly chunkType: string;
 };
 
+/**
+ * {@link InvalidChunkTypeError} のコンストラクター引数型です。
+ *
+ * `chunkType` はコンストラクター内部で自動的に設定されるため、引数からは除外されています。
+ */
 export type InvalidChunkTypeErrorArgs = Omit<InvalidChunkTypeErrorMeta, "chunkType">;
 
+/**
+ * `getWritable` が返すストリームに `Uint8Array<ArrayBuffer>` 以外の値が書き込まれた場合に投げられるエラーです。
+ */
 export class InvalidChunkTypeError extends ErrorBase<InvalidChunkTypeErrorMeta> {
   static {
     this.prototype.name = "MemoryInvalidChunkTypeError";

package/src/memory.ts

@@ -1,17 +1,26 @@
 import type { IStorage } from "@unikvs/core";
 
-import { InvalidChunkTypeError, KeyNotFoundError } from "./errors.js";
+import { KeyNotFoundError, InvalidChunkTypeError } from "./errors.js";
 
 /**
  * メモリーを永続化先として使用するストレージクラスです。
+ *
+ * アプリケーションの実行中のみデータを保持し、プロセス終了時に破棄されます。
+ * 全ての操作が同期で完了するため、非同期処理のオーバーヘッドがありません。
  */
 export default class Memory implements IStorage {
+  /**
+   * キーと値のペアを保持する内部マップです。
+   */
   private readonly map: Map<string, any>;
 
+  /** ストレージの名前です。デバッグやエラーメッセージなどに使用されます。 */
   public readonly name: string;
 
   /**
    * Memory インスタンスを初期化します。
+   *
+   * 内部のマップを初期化し、常にオープン状態として動作します。
    */
   public constructor() {
     this.name = "Memory";
@@ -62,6 +71,7 @@ export default class Memory implements IStorage {
     args: Pick<IStorage.GetWritableArgs, "key">,
   ): WritableStream<Uint8Array<ArrayBuffer>> {
     const { key } = args;
+    // メモリーストレージにはネイティブなストリームがないため、書き込まれたチャンクを配列に保持し、クローズ時に結合して保存します。
     const chunks: Uint8Array[] = [];
     const stream = new WritableStream<Uint8Array<ArrayBuffer>>({
       write: (chunk) => {
@@ -96,6 +106,7 @@ export default class Memory implements IStorage {
       throw new KeyNotFoundError({ key });
     }
 
+    // メモリーストレージにはネイティブなストリームがないため、既存の値を単一チャンクとしてストリームで送出します。
     const value = this.map.get(key);
     const stream = new ReadableStream<Uint8Array<ArrayBuffer>>({
       pull: (controller) => {