npm - @unikvs/redis.node - Versions diffs - 0.0.13 → 0.0.14 - Mend

@unikvs/redis.node 0.0.13 → 0.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/index.d.ts CHANGED Viewed

@@ -113,20 +113,108 @@ type RedisStorageOptions = Omit<RedisOptions, "keyPrefix" | "lazyConnect"> & {
  */
 declare class Redis implements IStorage {
   #private;
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
+   */
   readonly name: string;
   /**
    * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
    */
   constructor(url?: string, options?: RedisStorageOptions);
+  /**
+   * ストレージがオープン済みかどうかです。
+   *
+   * @returns オープン済みなら真です。
+   */
   get isOpen(): boolean;
+  /**
+   * ストレージをオープンします。
+   *
+   * `ioredis` クライアントを作成して接続します。
+   *
+   * @param _c オープンコンテキストです。
+   *
+   * @returns オープンが完了したら解決します。
+   */
   open(_c: IStorage.OpenContext): Promise<void>;
+  /**
+   * ストレージをクローズします。
+   *
+   * `quit` で丁寧に閉じ、失敗時は `disconnect` で掃除します。
+   *
+   * @param _c クローズコンテキストです。
+   *
+   * @returns クローズが完了したら解決します。
+   */
   close(_c: IStorage.CloseContext): Promise<void>;
+  /**
+   * バイト列を書き込みます。
+   *
+   * 指定したキーで値を上書きします。
+   *
+   * @param c 書き込みコンテキストです。
+   * @param data 保存するバイト列です。
+   *
+   * @returns 書き込みが完了したら解決します。
+   */
   write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void>;
+  /**
+   * バイト列を読み取ります。
+   *
+   * 指定したキーの値を取得します。
+   *
+   * @param c 読み取りコンテキストです。
+   *
+   * @returns 読み取ったバイト列です。
+   */
   read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>>;
+  /**
+   * キーの存在を確認します。
+   *
+   * @param c 存在確認コンテキストです。
+   *
+   * @returns 存在すれば真です。
+   */
   exists(c: IStorage.ExistsContext): Promise<boolean>;
+  /**
+   * キーを削除します。
+   *
+   * 存在しないキーも成功扱いにします。
+   *
+   * @param c 削除コンテキストです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
   delete(c: IStorage.DeleteContext): Promise<void>;
+  /**
+   * 接頭辞に一致するキーをすべて削除します。
+   *
+   * `SCAN` で列挙しながら削除します。
+   *
+   * @param c クリアコンテキストです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
   clear(c: IStorage.ClearContext): Promise<void>;
+  /**
+   * 書き込み用ストリームを取得します。
+   *
+   * 一時キーに追記し、`close` 時に最終キーへ置き換えます。
+   *
+   * @param c 書き込みストリーム取得コンテキストです。
+   *
+   * @returns 書き込み用ストリームです。
+   */
   getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>>;
+  /**
+   * 読み取り用ストリームを取得します。
+   *
+   * 取得した値を単一チャンクとして送出します。
+   *
+   * @param c 読み取りストリーム取得コンテキストです。
+   *
+   * @returns 読み取り用ストリームです。
+   */
   getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>>;
 }
 //#endregion

package/dist/index.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.d.ts","names":[],"sources":["../src/errors.ts","../src/redis.ts"],"mappings":";;;;;;qBAQa,iCAAiC;;;;EAQ5C,YAAmB,UAAU;;;;;KAiBnB;;;;WAID;;;;;KAMC,+BAA+B,eAAe;;;;qBAK7C,iCAAiC,UAAU;;;;EAQtD,YAAmB,MAAM;;;;;KAsBf;;;;WAID;;;;;KAMC,0BAA0B,eAAe;;;;qBAKxC,4BAA4B,UAAU;;;;EAQjD,YAAmB,MAAM;;;;;KAqBf;;;;WAID;;;;;KAMC,wBAAwB,eAAe;;;;qBAKtC,0BAA0B,UAAU;;;;EAQ/C,YAAmB,MAAM;;;;;;;KC7Hf;;;;WAID,gBAAgB;;;;WAKhB,UAAU;;;;;KAMT,sBAAsB,KAAK;;;;WAI5B;;;;WAKA,UAAU;;;;WAKV;;;;;~~cAYU~~,iBAAiB~~;;WAepB~~;;;;~~EAKhB~~,YAAmB,cAAc,UAAS~~;MA4B~~/B~~;EAgBX~~,KAAkB,IAAI,SAAS,cAAc~~;EA+D7C~~,MAAmB,IAAI,SAAS,eAAe~~;EAkD~~/C,MAAmB,GAAG,SAAS,cAAc,MAAM,WAAW,eAAe~~;EAQ7E~~,KAAkB,GAAG,SAAS,cAAc,QAAQ,WAAW~~;EAc~~/D,OAAoB,GAAG,SAAS,gBAAgB~~;EAQhD~~,OAAoB,GAAG,SAAS,gBAAgB~~;EAQhD~~,MAAmB,GAAG,SAAS,eAAe~~;EAU9C~~,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW~~;EA0E9E~~,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW"}
1	+ {"version":3,"file":"index.d.ts","names":[],"sources":["../src/errors.ts","../src/redis.ts"],"mappings":";;;;;;qBAQa,iCAAiC;;;;EAQ5C,YAAmB,UAAU;;;;;KAiBnB;;;;WAID;;;;;KAMC,+BAA+B,eAAe;;;;qBAK7C,iCAAiC,UAAU;;;;EAQtD,YAAmB,MAAM;;;;;KAsBf;;;;WAID;;;;;KAMC,0BAA0B,eAAe;;;;qBAKxC,4BAA4B,UAAU;;;;EAQjD,YAAmB,MAAM;;;;;KAqBf;;;;WAID;;;;;KAMC,wBAAwB,eAAe;;;;qBAKtC,0BAA0B,UAAU;;;;EAQ/C,YAAmB,MAAM;;;;;;;KC7Hf;;;;WAID,gBAAgB;;;;WAKhB,UAAU;;;;;KAMT,sBAAsB,KAAK;;;;WAI5B;;;;WAKA,UAAU;;;;WAKV;;;;;cAiCU,iBAAiB;;;;;WAIpB;;;;EAuChB,YAAmB,cAAc,UAAS;;;;;;MAiC/B;;;;;;;;;;EAaX,KAAkB,IAAI,SAAS,cAAc;;;;;;;;;;EAwE7C,MAAmB,IAAI,SAAS,eAAe;;;;;;;;;;;EAwC/C,MAAmB,GAAG,SAAS,cAAc,MAAM,WAAW,eAAe;;;;;;;;;;EAiB7E,KAAkB,GAAG,SAAS,cAAc,QAAQ,WAAW;;;;;;;;EAqB/D,OAAoB,GAAG,SAAS,gBAAgB;;;;;;;;;;EAiBhD,OAAoB,GAAG,SAAS,gBAAgB;;;;;;;;;;EAiBhD,MAAmB,GAAG,SAAS,eAAe;;;;;;;;;;EAmB9C,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW;;;;;;;;;;EAmF9E,YAAmB,GAAG,SAAS,qBAAqB,eAAe,WAAW"}

package/dist/index.js CHANGED Viewed

@@ -98,8 +98,19 @@ function _classPrivateFieldGet2(s, a) {
 }
 //#endregion
 //#region ../src/redis.ts
+/**
+* `SCAN` 1 回あたりにヒントとして渡すキー数です。
+*
+* 削除の往復回数と 1 回の `DEL` に渡す引数数を抑えるために使用します。
+*/
 const SCAN_COUNT = 1e3;
+/**
+* 接続確立の既定タイムアウト (ミリ秒) です。
+*/
 const DEFAULT_CONNECT_TIMEOUT_MS = 5e3;
+/**
+* 切断処理の既定タイムアウト (ミリ秒) です。
+*/
 const DEFAULT_CLOSE_TIMEOUT_MS = 5e3;
 var _con = /* @__PURE__ */ new WeakMap();
 var _url = /* @__PURE__ */ new WeakMap();
@@ -131,9 +142,23 @@ var Redis = class {
 		_classPrivateFieldSet2(_closeTimeout, this, closeTimeout);
 		_classPrivateFieldSet2(_keyPrefix, this, keyPrefix);
 	}
+	/**
+	* ストレージがオープン済みかどうかです。
+	*
+	* @returns オープン済みなら真です。
+	*/
 	get isOpen() {
 		return _classPrivateFieldGet2(_con, this) !== null;
 	}
+	/**
+	* ストレージをオープンします。
+	*
+	* `ioredis` クライアントを作成して接続します。
+	*
+	* @param _c オープンコンテキストです。
+	*
+	* @returns オープンが完了したら解決します。
+	*/
 	async open(_c) {
 		if (_classPrivateFieldGet2(_con, this)) await this.close(_c);
 		const explicitUrl = _classPrivateFieldGet2(_url, this) === void 0 || _classPrivateFieldGet2(_url, this) === "" ? void 0 : _classPrivateFieldGet2(_url, this);
@@ -163,6 +188,15 @@ var Redis = class {
 		}
 		_classPrivateFieldSet2(_con, this, { client: raw });
 	}
+	/**
+	* ストレージをクローズします。
+	*
+	* `quit` で丁寧に閉じ、失敗時は `disconnect` で掃除します。
+	*
+	* @param _c クローズコンテキストです。
+	*
+	* @returns クローズが完了したら解決します。
+	*/
 	async close(_c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		_classPrivateFieldSet2(_con, this, null);
@@ -180,11 +214,30 @@ var Redis = class {
 			if (timer !== void 0) clearTimeout(timer);
 		}
 	}
+	/**
+	* バイト列を書き込みます。
+	*
+	* 指定したキーで値を上書きします。
+	*
+	* @param c 書き込みコンテキストです。
+	* @param data 保存するバイト列です。
+	*
+	* @returns 書き込みが完了したら解決します。
+	*/
 	async write(c, data) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
 		await client.set(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key), Buffer.from(data));
 	}
+	/**
+	* バイト列を読み取ります。
+	*
+	* 指定したキーの値を取得します。
+	*
+	* @param c 読み取りコンテキストです。
+	*
+	* @returns 読み取ったバイト列です。
+	*/
 	async read(c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
@@ -192,22 +245,56 @@ var Redis = class {
 		if (data === null) throw new KeyNotFoundError$1({ key: c.key });
 		return new Uint8Array(data);
 	}
+	/**
+	* キーの存在を確認します。
+	*
+	* @param c 存在確認コンテキストです。
+	*
+	* @returns 存在すれば真です。
+	*/
 	async exists(c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
 		return await client.exists(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key)) > 0;
 	}
+	/**
+	* キーを削除します。
+	*
+	* 存在しないキーも成功扱いにします。
+	*
+	* @param c 削除コンテキストです。
+	*
+	* @returns 削除が完了したら解決します。
+	*/
 	async delete(c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
 		await client.del(_assertClassBrand(_Redis_brand, this, _toKey).call(this, c.key));
 	}
+	/**
+	* 接頭辞に一致するキーをすべて削除します。
+	*
+	* `SCAN` で列挙しながら削除します。
+	*
+	* @param c クリアコンテキストです。
+	*
+	* @returns 削除が完了したら解決します。
+	*/
 	async clear(c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
 		const pattern = `${_classPrivateFieldGet2(_keyPrefix, this)}*`;
 		await _assertClassBrand(_Redis_brand, this, _clearPattern).call(this, client, pattern, c.signal);
 	}
+	/**
+	* 書き込み用ストリームを取得します。
+	*
+	* 一時キーに追記し、`close` 時に最終キーへ置き換えます。
+	*
+	* @param c 書き込みストリーム取得コンテキストです。
+	*
+	* @returns 書き込み用ストリームです。
+	*/
 	getWritable(c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
@@ -267,6 +354,15 @@ var Redis = class {
 			}
 		});
 	}
+	/**
+	* 読み取り用ストリームを取得します。
+	*
+	* 取得した値を単一チャンクとして送出します。
+	*
+	* @param c 読み取りストリーム取得コンテキストです。
+	*
+	* @returns 読み取り用ストリームです。
+	*/
 	getReadable(c) {
 		const { client } = _assertClassBrand(_Redis_brand, this, _getConnection).call(this);
 		c.signal.throwIfAborted();
@@ -286,14 +382,39 @@ var Redis = class {
 		} });
 	}
 };
+/**
+* 開いている接続を返します。
+*
+* 未オープン時は例外を投げます。
+*
+* @returns オープン済みの接続です。
+*/
 function _getConnection() {
 	const con = _classPrivateFieldGet2(_con, this);
 	if (con === null) throw new TypeError("Redis is not open. Call open() first.");
 	return con;
 }
+/**
+* unikvs のキーにプレフィックスを付与し、Redis のキーへ変換します。
+*
+* @param key 変換する論理キーです。
+*
+* @returns Redis 上の実キーです。
+*/
 function _toKey(key) {
 	return `${_classPrivateFieldGet2(_keyPrefix, this)}${key}`;
 }
+/**
+* 接頭辞に一致するキーを走査して削除します。
+*
+* `SCAN` で頁送りしながら `DEL` します。
+*
+* @param client 操作に使うクライアントです。
+* @param pattern 削除対象の一致パターンです。
+* @param signal 中断を知らせるシグナルです。
+*
+* @returns 削除が完了したら解決します。
+*/
 async function _clearPattern(client, pattern, signal) {
 	let cursor = "0";
 	do {

package/dist/index.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"index.js","names":["Ioredis","KeyNotFoundError"],"sources":["../src/errors.ts","../src/redis.ts"],"sourcesContent":["import { type ErrorOptions, ErrorBase, setErrorMessage, InvalidUsageErrorBase } from \"@unikvs/core\";\n\nexport type { KeyNotFoundErrorArgs, KeyNotFoundErrorMeta } from \"@unikvs/core\";\nexport { KeyNotFoundError } from \"@unikvs/core\";\n\n/*\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)\n /\nexport class ClusterNotSupportedError extends InvalidUsageErrorBase<undefined> {\n static {\n this.prototype.name = \"RedisClusterNotSupportedError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)\n /\n public constructor(options?: ErrorOptions) {\n super(\n \"Redis storage v1 supports standalone mode only: the `cluster` option is not supported.\",\n options,\n );\n }\n}\n\nsetErrorMessage(\n ClusterNotSupportedError,\n \"Redis ストレージ v1 は standalone モードのみに対応します。`cluster` オプションはサポートされていません。\",\n \"ja\",\n);\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\nexport type InvalidCloseTimeoutErrorMeta = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#invalid-close-timeout-actual)\n /\n readonly actual: unknown;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\nexport type InvalidCloseTimeoutErrorArgs = ErrorOptions & InvalidCloseTimeoutErrorMeta;\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\nexport class InvalidCloseTimeoutError extends ErrorBase<InvalidCloseTimeoutErrorMeta> {\n static {\n this.prototype.name = \"RedisInvalidCloseTimeoutError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\n public constructor(args: InvalidCloseTimeoutErrorArgs) {\n const { actual, ...options } = args;\n const meta: InvalidCloseTimeoutErrorMeta = { actual };\n super(\n meta,\n ({ actual: messageActual }) =>\n `\\`closeTimeout\\` must be a finite positive number (ms), but got ${String(messageActual)}.`,\n options,\n );\n }\n}\n\nsetErrorMessage(\n InvalidCloseTimeoutError,\n ({ actual }) =>\n `\\`closeTimeout\\` は有限の正数 (ミリ秒) でなければなりません。受け取った値: ${String(actual)}`,\n \"ja\",\n);\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\nexport type ConnectTimeoutErrorMeta = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#connect-timeout-timeoutms)\n /\n readonly timeoutMs: number;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\nexport type ConnectTimeoutErrorArgs = ErrorOptions & ConnectTimeoutErrorMeta;\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\nexport class ConnectTimeoutError extends ErrorBase<ConnectTimeoutErrorMeta> {\n static {\n this.prototype.name = \"RedisConnectTimeoutError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\n public constructor(args: ConnectTimeoutErrorArgs) {\n const { timeoutMs, ...options } = args;\n const meta: ConnectTimeoutErrorMeta = { timeoutMs };\n super(\n meta,\n ({ timeoutMs: messageTimeoutMs }) =>\n `Timed out connecting to Redis after ${messageTimeoutMs}ms`,\n options,\n );\n }\n}\n\nsetErrorMessage(\n ConnectTimeoutError,\n ({ timeoutMs }) => `Redis への接続が ${timeoutMs}ms でタイムアウトしました`,\n \"ja\",\n);\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\nexport type CloseTimeoutErrorMeta = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#close-timeout-timeoutms)\n /\n readonly timeoutMs: number;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\nexport type CloseTimeoutErrorArgs = ErrorOptions & CloseTimeoutErrorMeta;\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\nexport class CloseTimeoutError extends ErrorBase<CloseTimeoutErrorMeta> {\n static {\n this.prototype.name = \"RedisCloseTimeoutError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\n public constructor(args: CloseTimeoutErrorArgs) {\n const { timeoutMs, ...options } = args;\n const meta: CloseTimeoutErrorMeta = { timeoutMs };\n super(\n meta,\n ({ timeoutMs: messageTimeoutMs }) => `Timed out closing Redis after ${messageTimeoutMs}ms`,\n options,\n );\n }\n}\n\nsetErrorMessage(\n CloseTimeoutError,\n ({ timeoutMs }) => `Redis からの切断処理が ${timeoutMs}ms でタイムアウトしました`,\n \"ja\",\n);\n","import { randomUUID } from \"node:crypto\";\n\nimport { type IStorage, KeyNotFoundError } from \"@unikvs/core\";\nimport {\n type ClusterNode,\n type RedisOptions,\n type ClusterOptions,\n Redis as Ioredis,\n} from \"ioredis\";\n\nimport {\n CloseTimeoutError,\n ConnectTimeoutError,\n ClusterNotSupportedError,\n InvalidCloseTimeoutError,\n} from \"./errors.js\";\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec)\n /\nexport type RedisClusterSpec = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec-nodes)\n /\n readonly nodes: readonly ClusterNode[];\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec-options)\n /\n readonly options?: ClusterOptions \| undefined;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions)\n /\nexport type RedisStorageOptions = Omit<RedisOptions, \"keyPrefix\" \| \"lazyConnect\"> & {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-keyprefix)\n /\n readonly keyPrefix?: string \| undefined;\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-cluster)\n /\n readonly cluster?: RedisClusterSpec \| undefined;\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-closetimeout)\n /\n readonly closeTimeout?: number \| undefined;\n};\n\nconst SCAN_COUNT = 1000;\nconst DEFAULT_CONNECT_TIMEOUT_MS = 5000;\nconst DEFAULT_CLOSE_TIMEOUT_MS = 5000;\n\ntype Connection = { readonly client: Ioredis };\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)\n /\nexport default class Redis implements IStorage {\n #con: Connection \| null;\n\n readonly #url: string \| undefined;\n\n // `closeTimeout` は本パッケージ固有の拡張です。\n // `this.#options` には含めず、別フィールドで保管します。\n // `this.#options` は `new Ioredis` にそのまま spread できる透過バッグです。\n readonly #options: Omit<RedisStorageOptions, \"keyPrefix\" \| \"cluster\" \| \"closeTimeout\">;\n\n // `ioredis` の `disconnectTimeout` (ソケット切断待機) とは別物です。\n readonly #closeTimeout: number;\n\n readonly #keyPrefix: string;\n\n public readonly name: string;\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)\n /\n public constructor(url?: string, options: RedisStorageOptions = {}) {\n const {\n cluster,\n keyPrefix = \"unikvs:\",\n closeTimeout = DEFAULT_CLOSE_TIMEOUT_MS,\n ...redisOptions\n } = options;\n\n // v1 は standalone のみに対応します。\n // `cluster` を指定したときは、`closeTimeout` 検証より先に拒否します。\n if (cluster !== undefined) {\n throw new ClusterNotSupportedError();\n }\n\n // `undefined` は既定値 5000ms になるため対象外とします。\n // 明示値が有限の正数でない場合のみ拒否します。\n if (typeof closeTimeout !== \"number\" \|\| !Number.isFinite(closeTimeout) \|\| closeTimeout <= 0) {\n throw new InvalidCloseTimeoutError({ actual: closeTimeout });\n }\n\n this.name = \"Redis\";\n this.#con = null;\n this.#url = url;\n this.#options = redisOptions;\n this.#closeTimeout = closeTimeout;\n this.#keyPrefix = keyPrefix;\n }\n\n public get isOpen(): boolean {\n return this.#con !== null;\n }\n\n // 開いている接続を返します。\n // 未オープン時は `TypeError` を投げます。\n #getConnection(): Connection {\n const con = this.#con;\n\n if (con === null) {\n throw new TypeError(\"Redis is not open. Call open() first.\");\n }\n\n return con;\n }\n\n public async open(_c: IStorage.OpenContext): Promise<void> {\n // 並行 `open` 同士および `open` 接続待ち中の `close` の同時呼び出しは禁止 (事前条件) です。\n // 呼び出し側で直列化してください。\n // 並行 `close` 同士は一方が `TypeError` reject する形で直列化されます。\n if (this.#con) {\n await this.close(_c as unknown as IStorage.CloseContext);\n }\n\n // 空文字の `url`・環境変数は未指定として扱います (本パッケージ仕様)。\n // `url` は `redis://` / `rediss://` 形式での指定を要求します。\n // 実行時の形式検証は行いません (bare 形式は非サポート・動作未保証)。\n const explicitUrl = this.#url === undefined \|\| this.#url === \"\" ? undefined : this.#url;\n const redisUrl =\n process.env[\"REDIS_URL\"] === undefined \|\| process.env[\"REDIS_URL\"] === \"\"\n ? undefined\n : process.env[\"REDIS_URL\"];\n const valkeyUrl =\n process.env[\"VALKEY_URL\"] === undefined \|\| process.env[\"VALKEY_URL\"] === \"\"\n ? undefined\n : process.env[\"VALKEY_URL\"];\n const url = explicitUrl ?? redisUrl ?? valkeyUrl;\n const connectTimeout = this.#options.connectTimeout ?? DEFAULT_CONNECT_TIMEOUT_MS;\n\n // `ioredis` v6 のコンストラクタ型は `replyMapping` に明示 `undefined` を許しません。\n // `exactOptionalPropertyTypes` 下では spread のまま渡せないため型表明を付けます。\n // 実行時の値は変わらず、`replyMapping` を含む透過は保たれます。\n type ConnectOptions = RedisOptions & { replyMapping?: \"legacy\" };\n\n const options = {\n ...this.#options,\n lazyConnect: true,\n connectTimeout,\n } as ConnectOptions;\n const raw = url === undefined ? new Ioredis(options) : new Ioredis(url, options);\n\n // `ioredis` は接続失敗・再試行時に `error` イベントを emit します。\n // unhandled `error` によるクラッシュを抑止するため no-op リスナを付けます。\n // 可観測性は v1 では提供しません。\n raw.on(\"error\", () => {});\n\n let timer: ReturnType<typeof setTimeout> \| undefined;\n\n try {\n await Promise.race([\n raw.connect(),\n new Promise<never>((_, reject) => {\n timer = setTimeout(() => {\n reject(new ConnectTimeoutError({ timeoutMs: connectTimeout }));\n }, connectTimeout);\n }),\n ]);\n } catch (ex) {\n raw.disconnect();\n throw ex;\n } finally {\n if (timer !== undefined) {\n clearTimeout(timer);\n }\n }\n\n this.#con = { client: raw };\n }\n\n public async close(_c: IStorage.CloseContext): Promise<void> {\n // 未 `open`・二重 `close` は `TypeError` で reject されます。\n // 必ず `await` し、結果を浮かせないでください。\n const { client } = this.#getConnection();\n\n // 先行 null 化により、並行 `close` 同士は二重 `quit` になりません。\n this.#con = null;\n\n const closeTimeout = this.#closeTimeout;\n let timer: ReturnType<typeof setTimeout> \| undefined;\n\n try {\n await Promise.race([\n client.quit(),\n new Promise<never>((_, reject) => {\n timer = setTimeout(() => {\n reject(new CloseTimeoutError({ timeoutMs: closeTimeout }));\n }, closeTimeout);\n }),\n ]);\n } catch {\n // `quit()` の失敗全般 (タイムアウト含む) は `disconnect()` で掃除して正常復帰します。\n client.disconnect();\n } finally {\n if (timer !== undefined) {\n clearTimeout(timer);\n }\n }\n }\n\n #toKey(key: string): string {\n return `${this.#keyPrefix}${key}`;\n }\n\n async #clearPattern(client: Ioredis, pattern: string, signal: AbortSignal): Promise<void> {\n let cursor = \"0\";\n\n do {\n signal.throwIfAborted();\n\n const [nextCursor, keys] = await client.scan(cursor, \"MATCH\", pattern, \"COUNT\", SCAN_COUNT);\n\n if (keys.length > 0) {\n await client.del(...keys);\n }\n\n cursor = nextCursor;\n } while (cursor !== \"0\");\n }\n\n public async write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n await client.set(this.#toKey(c.key), Buffer.from(data));\n }\n\n public async read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n const data = await client.getBuffer(this.#toKey(c.key));\n\n if (data === null) {\n throw new KeyNotFoundError({ key: c.key });\n }\n\n return new Uint8Array(data);\n }\n\n public async exists(c: IStorage.ExistsContext): Promise<boolean> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n return (await client.exists(this.#toKey(c.key))) > 0;\n }\n\n public async delete(c: IStorage.DeleteContext): Promise<void> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n await client.del(this.#toKey(c.key));\n }\n\n public async clear(c: IStorage.ClearContext): Promise<void> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n // prefix が空文字の場合は MATCH \"\" となり、選択中のデータベースの全キーが対象になります。\n const pattern = `${this.#keyPrefix}*`;\n await this.#clearPattern(client, pattern, c.signal);\n }\n\n public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n const dest = this.#toKey(c.key);\n // 一意なサフィックスにより、同一キーへの並行書き込みでも一時キーが衝突しません。\n const tmp = `${dest}.${randomUUID()}.tmp`;\n\n // 中断と失敗のどちらからでも後始末が走るため、完了処理は一度だけ行います。\n let finished = false;\n const removeAbortListener = (): void => {\n c.signal.removeEventListener(\"abort\", onAbort);\n };\n const discardTemporary = async (): Promise<void> => {\n try {\n await client.del(tmp);\n } catch {\n // 後始末としての削除のため、失敗しても無視します。\n }\n };\n const finish = async (): Promise<void> => {\n if (finished) {\n return;\n }\n\n finished = true;\n removeAbortListener();\n await discardTemporary();\n };\n const onAbort = (): void => {\n void finish();\n };\n c.signal.addEventListener(\"abort\", onAbort, { once: true });\n\n return new WritableStream<Uint8Array<ArrayBuffer>>({\n async abort() {\n await finish();\n },\n async close() {\n c.signal.throwIfAborted();\n try {\n // 全チャンクの追記が完了した時点で初めて最終キーへ置き換えます (swap-on-close)。\n await client.rename(tmp, dest);\n } catch (ex) {\n await finish();\n throw ex;\n }\n // rename 後は一時キーが存在しないため、完了済みとして中断時の削除を行いません。\n finished = true;\n removeAbortListener();\n },\n async start() {\n try {\n c.signal.throwIfAborted();\n // 0 バイトの書き込みでも close 時の RENAME が成功するよう、空の文字列で一時キーを作ります。\n await client.set(tmp, \"\");\n } catch (ex) {\n await finish();\n throw ex;\n }\n },\n async write(chunk) {\n c.signal.throwIfAborted();\n try {\n await client.append(tmp, Buffer.from(chunk));\n } catch (ex) {\n await finish();\n throw ex;\n }\n },\n });\n }\n\n public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n const dest = this.#toKey(c.key);\n let sent = false;\n\n // Redis の GET は値を一括で返すため、取得したバイト列を単一のチャンクとして送出します。\n return new ReadableStream<Uint8Array<ArrayBuffer>>({\n async pull(controller) {\n if (sent) {\n controller.close();\n\n return;\n }\n\n sent = true;\n c.signal.throwIfAborted();\n\n const data = await client.getBuffer(dest);\n\n if (data === null) {\n throw new KeyNotFoundError({ key: c.key });\n }\n\n controller.enqueue(new Uint8Array(data));\n controller.close();\n },\n });\n }\n}\n"],"mappings":";;;;;;;;;;;AAQA,IAAa,2BAAb,cAA8C,sBAAiC;;;;CAQ7E,YAAmB,SAAwB;EACzC,MACE,0FACA,OACF;CACF;AACF;;AAZI,0BAAK,UAAU,OAAO;AAc1B,gBACE,0BACA,wEACA,IACF;;;;AAoBA,IAAa,2BAAb,cAA8C,UAAwC;;;;CAQpF,YAAmB,MAAoC;EACrD,MAAM,EAAE,QAAQ,GAAG,YAAY;EAE/B,MACE,EAF2C,OAExC,IACF,EAAE,QAAQ,oBACT,mEAAmE,OAAO,aAAa,EAAE,IAC3F,OACF;CACF;AACF;;AAhBI,0BAAK,UAAU,OAAO;AAkB1B,gBACE,2BACC,EAAE,aACD,oDAAoD,OAAO,MAAM,KACnE,IACF;;;;AAoBA,IAAa,sBAAb,cAAyC,UAAmC;;;;CAQ1E,YAAmB,MAA+B;EAChD,MAAM,EAAE,WAAW,GAAG,YAAY;EAElC,MACE,EAFsC,UAEnC,IACF,EAAE,WAAW,uBACZ,uCAAuC,iBAAiB,KAC1D,OACF;CACF;AACF;;AAhBI,qBAAK,UAAU,OAAO;AAkB1B,gBACE,sBACC,EAAE,gBAAgB,eAAe,UAAU,iBAC5C,IACF;;;;AAoBA,IAAa,oBAAb,cAAuC,UAAiC;;;;CAQtE,YAAmB,MAA6B;EAC9C,MAAM,EAAE,WAAW,GAAG,YAAY;EAElC,MACE,EAFoC,UAEjC,IACF,EAAE,WAAW,uBAAuB,iCAAiC,iBAAiB,KACvF,OACF;CACF;AACF;;AAfI,mBAAK,UAAU,OAAO;AAiB1B,gBACE,oBACC,EAAE,gBAAgB,kBAAkB,UAAU,iBAC/C,IACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AC5GA,MAAM,aAAa;AACnB,MAAM,6BAA6B;AACnC,MAAM,2BAA2B;;;;;;;;;;AAOjC,IAAqB,QAArB,MAA+C;;;;CAoB7C,YAAmB,KAAc,UAA+B,CAAC,GAAG;;;;;;;EAClE,MAAM,EACJ,SACA,YAAY,WACZ,eAAe,0BACf,GAAG,iBACD;EAIJ,IAAI,YAAY,KAAA,GACd,MAAM,IAAI,yBAAyB;EAKrC,IAAI,OAAO,iBAAiB,YAAY,CAAC,OAAO,SAAS,YAAY,KAAK,gBAAgB,GACxF,MAAM,IAAI,yBAAyB,EAAE,QAAQ,aAAa,CAAC;EAG7D,KAAK,OAAO;EACZ,uBAAA,MAAA,MAAY,IAAA;EACZ,uBAAA,MAAA,MAAY,GAAA;EACZ,uBAAA,UAAA,MAAgB,YAAA;EAChB,uBAAA,eAAA,MAAqB,YAAA;EACrB,uBAAA,YAAA,MAAkB,SAAA;CACpB;CAEA,IAAW,SAAkB;EAC3B,OAAA,uBAAA,MAAO,IAAA,MAAc;CACvB;CAcA,MAAa,KAAK,IAAyC;EAIzD,IAAA,uBAAA,MAAI,IAAA,GACF,MAAM,KAAK,MAAM,EAAsC;EAMzD,MAAM,cAAA,uBAAA,MAAc,IAAA,MAAc,KAAA,KAAA,uBAAA,MAAa,IAAA,MAAc,KAAK,KAAA,IAAA,uBAAA,MAAY,IAAA;EAC9E,MAAM,WACJ,QAAQ,IAAI,iBAAiB,KAAA,KAAa,QAAQ,IAAI,iBAAiB,KACnE,KAAA,IACA,QAAQ,IAAI;EAClB,MAAM,YACJ,QAAQ,IAAI,kBAAkB,KAAA,KAAa,QAAQ,IAAI,kBAAkB,KACrE,KAAA,IACA,QAAQ,IAAI;EAClB,MAAM,MAAM,eAAe,YAAY;EACvC,MAAM,iBAAA,uBAAA,UAAiB,IAAA,CAAA,CAAc,kBAAkB;EAOvD,MAAM,UAAU;GACd,GAAA,uBAAA,UAAG,IAAA;GACH,aAAa;GACb;EACF;EACA,MAAM,MAAM,QAAQ,KAAA,IAAY,IAAIA,QAAQ,OAAO,IAAI,IAAIA,QAAQ,KAAK,OAAO;EAK/E,IAAI,GAAG,eAAe,CAAC,CAAC;EAExB,IAAI;EAEJ,IAAI;GACF,MAAM,QAAQ,KAAK,CACjB,IAAI,QAAQ,GACZ,IAAI,SAAgB,GAAG,WAAW;IAChC,QAAQ,iBAAiB;KACvB,OAAO,IAAI,oBAAoB,EAAE,WAAW,eAAe,CAAC,CAAC;IAC/D,GAAG,cAAc;GACnB,CAAC,CACH,CAAC;EACH,SAAS,IAAI;GACX,IAAI,WAAW;GACf,MAAM;EACR,UAAU;GACR,IAAI,UAAU,KAAA,GACZ,aAAa,KAAK;EAEtB;EAEA,uBAAA,MAAA,MAAY,EAAE,QAAQ,IAAI,CAAA;CAC5B;CAEA,MAAa,MAAM,IAA0C;EAG3D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAGvC,uBAAA,MAAA,MAAY,IAAA;EAEZ,MAAM,eAAA,uBAAA,eAAe,IAAA;EACrB,IAAI;EAEJ,IAAI;GACF,MAAM,QAAQ,KAAK,CACjB,OAAO,KAAK,GACZ,IAAI,SAAgB,GAAG,WAAW;IAChC,QAAQ,iBAAiB;KACvB,OAAO,IAAI,kBAAkB,EAAE,WAAW,aAAa,CAAC,CAAC;IAC3D,GAAG,YAAY;GACjB,CAAC,CACH,CAAC;EACH,QAAQ;GAEN,OAAO,WAAW;EACpB,UAAU;GACR,IAAI,UAAU,KAAA,GACZ,aAAa,KAAK;EAEtB;CACF;CAsBA,MAAa,MAAM,GAA0B,MAA8C;EACzF,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,IAAA,kBAAA,cAAI,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,GAAG,OAAO,KAAK,IAAI,CAAC;CACxD;CAEA,MAAa,KAAK,GAA2D;EAC3E,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,MAAM,OAAO,UAAA,kBAAA,cAAU,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;EAEtD,IAAI,SAAS,MACX,MAAM,IAAIC,mBAAiB,EAAE,KAAK,EAAE,IAAI,CAAC;EAG3C,OAAO,IAAI,WAAW,IAAI;CAC5B;CAEA,MAAa,OAAO,GAA6C;EAC/D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,OAAQ,MAAM,OAAO,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC,IAAK;CACrD;CAEA,MAAa,OAAO,GAA0C;EAC5D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,IAAA,kBAAA,cAAI,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;CACrC;CAEA,MAAa,MAAM,GAAyC;EAC1D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAGxB,MAAM,UAAU,GAAA,uBAAA,YAAG,IAAA,EAAgB;EACnC,MAAA,kBAAA,cAAM,MAAA,aAAA,CAAA,CAAA,KAAA,MAAmB,QAAQ,SAAS,EAAE,MAAM;CACpD;CAEA,YAAmB,GAAyE;EAC1F,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG;EAE9B,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,EAAE;EAGpC,IAAI,WAAW;EACf,MAAM,4BAAkC;GACtC,EAAE,OAAO,oBAAoB,SAAS,OAAO;EAC/C;EACA,MAAM,mBAAmB,YAA2B;GAClD,IAAI;IACF,MAAM,OAAO,IAAI,GAAG;GACtB,QAAQ,CAER;EACF;EACA,MAAM,SAAS,YAA2B;GACxC,IAAI,UACF;GAGF,WAAW;GACX,oBAAoB;GACpB,MAAM,iBAAiB;EACzB;EACA,MAAM,gBAAsB;GAC1B,OAAY;EACd;EACA,EAAE,OAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EAE1D,OAAO,IAAI,eAAwC;GACjD,MAAM,QAAQ;IACZ,MAAM,OAAO;GACf;GACA,MAAM,QAAQ;IACZ,EAAE,OAAO,eAAe;IACxB,IAAI;KAEF,MAAM,OAAO,OAAO,KAAK,IAAI;IAC/B,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;IAEA,WAAW;IACX,oBAAoB;GACtB;GACA,MAAM,QAAQ;IACZ,IAAI;KACF,EAAE,OAAO,eAAe;KAExB,MAAM,OAAO,IAAI,KAAK,EAAE;IAC1B,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;GACF;GACA,MAAM,MAAM,OAAO;IACjB,EAAE,OAAO,eAAe;IACxB,IAAI;KACF,MAAM,OAAO,OAAO,KAAK,OAAO,KAAK,KAAK,CAAC;IAC7C,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;GACF;EACF,CAAC;CACH;CAEA,YAAmB,GAAyE;EAC1F,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG;EAC9B,IAAI,OAAO;EAGX,OAAO,IAAI,eAAwC,EACjD,MAAM,KAAK,YAAY;GACrB,IAAI,MAAM;IACR,WAAW,MAAM;IAEjB;GACF;GAEA,OAAO;GACP,EAAE,OAAO,eAAe;GAExB,MAAM,OAAO,MAAM,OAAO,UAAU,IAAI;GAExC,IAAI,SAAS,MACX,MAAM,IAAIA,mBAAiB,EAAE,KAAK,EAAE,IAAI,CAAC;GAG3C,WAAW,QAAQ,IAAI,WAAW,IAAI,CAAC;GACvC,WAAW,MAAM;EACnB,EACF,CAAC;CACH;AACF;AApRE,SAAA,iBAA6B;CAC3B,MAAM,MAAA,uBAAA,MAAM,IAAA;CAEZ,IAAI,QAAQ,MACV,MAAM,IAAI,UAAU,uCAAuC;CAG7D,OAAO;AACT;AA+FA,SAAA,OAAO,KAAqB;CAC1B,OAAO,GAAA,uBAAA,YAAG,IAAA,IAAkB;AAC9B;AAEA,eAAA,cAAoB,QAAiB,SAAiB,QAAoC;CACxF,IAAI,SAAS;CAEb,GAAG;EACD,OAAO,eAAe;EAEtB,MAAM,CAAC,YAAY,QAAQ,MAAM,OAAO,KAAK,QAAQ,SAAS,SAAS,SAAS,UAAU;EAE1F,IAAI,KAAK,SAAS,GAChB,MAAM,OAAO,IAAI,GAAG,IAAI;EAG1B,SAAS;CACX,SAAS,WAAW;AACtB"}
1	+ {"version":3,"file":"index.js","names":["Ioredis","KeyNotFoundError"],"sources":["../src/errors.ts","../src/redis.ts"],"sourcesContent":["import { type ErrorOptions, ErrorBase, setErrorMessage, InvalidUsageErrorBase } from \"@unikvs/core\";\n\nexport type { KeyNotFoundErrorArgs, KeyNotFoundErrorMeta } from \"@unikvs/core\";\nexport { KeyNotFoundError } from \"@unikvs/core\";\n\n/*\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)\n /\nexport class ClusterNotSupportedError extends InvalidUsageErrorBase<undefined> {\n static {\n this.prototype.name = \"RedisClusterNotSupportedError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)\n /\n public constructor(options?: ErrorOptions) {\n super(\n \"Redis storage v1 supports standalone mode only: the `cluster` option is not supported.\",\n options,\n );\n }\n}\n\nsetErrorMessage(\n ClusterNotSupportedError,\n \"Redis ストレージ v1 は standalone モードのみに対応します。`cluster` オプションはサポートされていません。\",\n \"ja\",\n);\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\nexport type InvalidCloseTimeoutErrorMeta = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#invalid-close-timeout-actual)\n /\n readonly actual: unknown;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\nexport type InvalidCloseTimeoutErrorArgs = ErrorOptions & InvalidCloseTimeoutErrorMeta;\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\nexport class InvalidCloseTimeoutError extends ErrorBase<InvalidCloseTimeoutErrorMeta> {\n static {\n this.prototype.name = \"RedisInvalidCloseTimeoutError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)\n /\n public constructor(args: InvalidCloseTimeoutErrorArgs) {\n const { actual, ...options } = args;\n const meta: InvalidCloseTimeoutErrorMeta = { actual };\n super(\n meta,\n ({ actual: messageActual }) =>\n `\\`closeTimeout\\` must be a finite positive number (ms), but got ${String(messageActual)}.`,\n options,\n );\n }\n}\n\nsetErrorMessage(\n InvalidCloseTimeoutError,\n ({ actual }) =>\n `\\`closeTimeout\\` は有限の正数 (ミリ秒) でなければなりません。受け取った値: ${String(actual)}`,\n \"ja\",\n);\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\nexport type ConnectTimeoutErrorMeta = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#connect-timeout-timeoutms)\n /\n readonly timeoutMs: number;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\nexport type ConnectTimeoutErrorArgs = ErrorOptions & ConnectTimeoutErrorMeta;\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\nexport class ConnectTimeoutError extends ErrorBase<ConnectTimeoutErrorMeta> {\n static {\n this.prototype.name = \"RedisConnectTimeoutError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)\n /\n public constructor(args: ConnectTimeoutErrorArgs) {\n const { timeoutMs, ...options } = args;\n const meta: ConnectTimeoutErrorMeta = { timeoutMs };\n super(\n meta,\n ({ timeoutMs: messageTimeoutMs }) =>\n `Timed out connecting to Redis after ${messageTimeoutMs}ms`,\n options,\n );\n }\n}\n\nsetErrorMessage(\n ConnectTimeoutError,\n ({ timeoutMs }) => `Redis への接続が ${timeoutMs}ms でタイムアウトしました`,\n \"ja\",\n);\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\nexport type CloseTimeoutErrorMeta = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#close-timeout-timeoutms)\n /\n readonly timeoutMs: number;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\nexport type CloseTimeoutErrorArgs = ErrorOptions & CloseTimeoutErrorMeta;\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\nexport class CloseTimeoutError extends ErrorBase<CloseTimeoutErrorMeta> {\n static {\n this.prototype.name = \"RedisCloseTimeoutError\";\n }\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)\n /\n public constructor(args: CloseTimeoutErrorArgs) {\n const { timeoutMs, ...options } = args;\n const meta: CloseTimeoutErrorMeta = { timeoutMs };\n super(\n meta,\n ({ timeoutMs: messageTimeoutMs }) => `Timed out closing Redis after ${messageTimeoutMs}ms`,\n options,\n );\n }\n}\n\nsetErrorMessage(\n CloseTimeoutError,\n ({ timeoutMs }) => `Redis からの切断処理が ${timeoutMs}ms でタイムアウトしました`,\n \"ja\",\n);\n","import { randomUUID } from \"node:crypto\";\n\nimport { type IStorage, KeyNotFoundError } from \"@unikvs/core\";\nimport {\n type ClusterNode,\n type RedisOptions,\n type ClusterOptions,\n Redis as Ioredis,\n} from \"ioredis\";\n\nimport {\n CloseTimeoutError,\n ConnectTimeoutError,\n ClusterNotSupportedError,\n InvalidCloseTimeoutError,\n} from \"./errors.js\";\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec)\n /\nexport type RedisClusterSpec = {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec-nodes)\n /\n readonly nodes: readonly ClusterNode[];\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisclusterspec-options)\n /\n readonly options?: ClusterOptions \| undefined;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions)\n /\nexport type RedisStorageOptions = Omit<RedisOptions, \"keyPrefix\" \| \"lazyConnect\"> & {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-keyprefix)\n /\n readonly keyPrefix?: string \| undefined;\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-cluster)\n /\n readonly cluster?: RedisClusterSpec \| undefined;\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redisstorageoptions-closetimeout)\n /\n readonly closeTimeout?: number \| undefined;\n};\n\n/\n `SCAN` 1 回あたりにヒントとして渡すキー数です。\n \n 削除の往復回数と 1 回の `DEL` に渡す引数数を抑えるために使用します。\n /\nconst SCAN_COUNT = 1000;\n\n/\n 接続確立の既定タイムアウト (ミリ秒) です。\n /\nconst DEFAULT_CONNECT_TIMEOUT_MS = 5000;\n\n/\n 切断処理の既定タイムアウト (ミリ秒) です。\n /\nconst DEFAULT_CLOSE_TIMEOUT_MS = 5000;\n\n/\n ストレージの動作に必要な接続を保持する型定義です。\n /\ntype Connection = {\n /\n 操作に使うクライアントです。\n /\n readonly client: Ioredis;\n};\n\n/\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)\n /\nexport default class Redis implements IStorage {\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)\n /\n public readonly name: string;\n\n /\n Redis への接続を保持します。\n \n ストレージがオープンされるまで null です。\n /\n #con: Connection \| null;\n\n /\n 接続先の URL です。\n \n 未指定の場合はクライアントが環境変数 (`REDIS_URL`、`VALKEY_URL`) から解決します。\n /\n readonly #url: string \| undefined;\n\n /\n `closeTimeout` は本パッケージ固有の拡張です。\n \n `this.#options` には含めず、別フィールドで保管します。\n * `this.#options` は `new Ioredis` にそのまま spread できる透過バッグです。\n /\n readonly #options: Omit<RedisStorageOptions, \"keyPrefix\" \| \"cluster\" \| \"closeTimeout\">;\n\n /\n `close` 時の切断待ち時間 (ミリ秒) です。\n \n `ioredis` の `disconnectTimeout` (ソケット切断待機) とは別物です。\n /\n readonly #closeTimeout: number;\n\n /\n すべてのキーの先頭に付与するプレフィックスです。\n /\n readonly #keyPrefix: string;\n\n /\n [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)\n /\n public constructor(url?: string, options: RedisStorageOptions = {}) {\n const {\n cluster,\n keyPrefix = \"unikvs:\",\n closeTimeout = DEFAULT_CLOSE_TIMEOUT_MS,\n ...redisOptions\n } = options;\n\n // v1 は standalone のみに対応します。\n // `cluster` を指定したときは、`closeTimeout` 検証より先に拒否します。\n if (cluster !== undefined) {\n throw new ClusterNotSupportedError();\n }\n\n // `undefined` は既定値 5000ms になるため対象外とします。\n // 明示値が有限の正数でない場合のみ拒否します。\n if (typeof closeTimeout !== \"number\" \|\| !Number.isFinite(closeTimeout) \|\| closeTimeout <= 0) {\n throw new InvalidCloseTimeoutError({ actual: closeTimeout });\n }\n\n this.name = \"Redis\";\n this.#con = null;\n this.#url = url;\n this.#options = redisOptions;\n this.#closeTimeout = closeTimeout;\n this.#keyPrefix = keyPrefix;\n }\n\n /\n ストレージがオープン済みかどうかです。\n \n @returns オープン済みなら真です。\n /\n public get isOpen(): boolean {\n return this.#con !== null;\n }\n\n /\n ストレージをオープンします。\n \n `ioredis` クライアントを作成して接続します。\n \n @param _c オープンコンテキストです。\n \n @returns オープンが完了したら解決します。\n /\n public async open(_c: IStorage.OpenContext): Promise<void> {\n // 並行 `open` 同士および `open` 接続待ち中の `close` の同時呼び出しは禁止 (事前条件) です。\n // 呼び出し側で直列化してください。\n // 並行 `close` 同士は一方が `TypeError` reject する形で直列化されます。\n if (this.#con) {\n await this.close(_c as unknown as IStorage.CloseContext);\n }\n\n // 空文字の `url`・環境変数は未指定として扱います (本パッケージ仕様)。\n // `url` は `redis://` / `rediss://` 形式での指定を要求します。\n // 実行時の形式検証は行いません (bare 形式は非サポート・動作未保証)。\n const explicitUrl = this.#url === undefined \|\| this.#url === \"\" ? undefined : this.#url;\n const redisUrl =\n process.env[\"REDIS_URL\"] === undefined \|\| process.env[\"REDIS_URL\"] === \"\"\n ? undefined\n : process.env[\"REDIS_URL\"];\n const valkeyUrl =\n process.env[\"VALKEY_URL\"] === undefined \|\| process.env[\"VALKEY_URL\"] === \"\"\n ? undefined\n : process.env[\"VALKEY_URL\"];\n const url = explicitUrl ?? redisUrl ?? valkeyUrl;\n const connectTimeout = this.#options.connectTimeout ?? DEFAULT_CONNECT_TIMEOUT_MS;\n\n // `ioredis` v6 のコンストラクタ型は `replyMapping` に明示 `undefined` を許しません。\n // `exactOptionalPropertyTypes` 下では spread のまま渡せないため型表明を付けます。\n // 実行時の値は変わらず、`replyMapping` を含む透過は保たれます。\n type ConnectOptions = RedisOptions & { replyMapping?: \"legacy\" };\n\n const options = {\n ...this.#options,\n lazyConnect: true,\n connectTimeout,\n } as ConnectOptions;\n const raw = url === undefined ? new Ioredis(options) : new Ioredis(url, options);\n\n // `ioredis` は接続失敗・再試行時に `error` イベントを emit します。\n // unhandled `error` によるクラッシュを抑止するため no-op リスナを付けます。\n // 可観測性は v1 では提供しません。\n raw.on(\"error\", () => {});\n\n let timer: ReturnType<typeof setTimeout> \| undefined;\n\n try {\n await Promise.race([\n raw.connect(),\n new Promise<never>((_, reject) => {\n timer = setTimeout(() => {\n reject(new ConnectTimeoutError({ timeoutMs: connectTimeout }));\n }, connectTimeout);\n }),\n ]);\n } catch (ex) {\n raw.disconnect();\n throw ex;\n } finally {\n if (timer !== undefined) {\n clearTimeout(timer);\n }\n }\n\n this.#con = { client: raw };\n }\n\n /\n ストレージをクローズします。\n \n `quit` で丁寧に閉じ、失敗時は `disconnect` で掃除します。\n \n @param _c クローズコンテキストです。\n \n @returns クローズが完了したら解決します。\n /\n public async close(_c: IStorage.CloseContext): Promise<void> {\n // 未 `open`・二重 `close` は `TypeError` で reject されます。\n // 必ず `await` し、結果を浮かせないでください。\n const { client } = this.#getConnection();\n\n // 先行 null 化により、並行 `close` 同士は二重 `quit` になりません。\n this.#con = null;\n\n const closeTimeout = this.#closeTimeout;\n let timer: ReturnType<typeof setTimeout> \| undefined;\n\n try {\n await Promise.race([\n client.quit(),\n new Promise<never>((_, reject) => {\n timer = setTimeout(() => {\n reject(new CloseTimeoutError({ timeoutMs: closeTimeout }));\n }, closeTimeout);\n }),\n ]);\n } catch {\n // `quit()` の失敗全般 (タイムアウト含む) は `disconnect()` で掃除して正常復帰します。\n client.disconnect();\n } finally {\n if (timer !== undefined) {\n clearTimeout(timer);\n }\n }\n }\n\n /\n バイト列を書き込みます。\n \n 指定したキーで値を上書きします。\n \n @param c 書き込みコンテキストです。\n * @param data 保存するバイト列です。\n \n @returns 書き込みが完了したら解決します。\n /\n public async write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n await client.set(this.#toKey(c.key), Buffer.from(data));\n }\n\n /\n バイト列を読み取ります。\n \n 指定したキーの値を取得します。\n \n @param c 読み取りコンテキストです。\n \n @returns 読み取ったバイト列です。\n /\n public async read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n const data = await client.getBuffer(this.#toKey(c.key));\n\n if (data === null) {\n throw new KeyNotFoundError({ key: c.key });\n }\n\n return new Uint8Array(data);\n }\n\n /\n キーの存在を確認します。\n \n @param c 存在確認コンテキストです。\n \n @returns 存在すれば真です。\n /\n public async exists(c: IStorage.ExistsContext): Promise<boolean> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n return (await client.exists(this.#toKey(c.key))) > 0;\n }\n\n /\n キーを削除します。\n \n 存在しないキーも成功扱いにします。\n \n @param c 削除コンテキストです。\n \n @returns 削除が完了したら解決します。\n /\n public async delete(c: IStorage.DeleteContext): Promise<void> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n await client.del(this.#toKey(c.key));\n }\n\n /\n 接頭辞に一致するキーをすべて削除します。\n \n `SCAN` で列挙しながら削除します。\n \n @param c クリアコンテキストです。\n \n @returns 削除が完了したら解決します。\n /\n public async clear(c: IStorage.ClearContext): Promise<void> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n // prefix が空文字の場合は MATCH \"\" となり、選択中のデータベースの全キーが対象になります。\n const pattern = `${this.#keyPrefix}`;\n await this.#clearPattern(client, pattern, c.signal);\n }\n\n /\n 書き込み用ストリームを取得します。\n \n 一時キーに追記し、`close` 時に最終キーへ置き換えます。\n \n @param c 書き込みストリーム取得コンテキストです。\n \n @returns 書き込み用ストリームです。\n /\n public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n const dest = this.#toKey(c.key);\n // 一意なサフィックスにより、同一キーへの並行書き込みでも一時キーが衝突しません。\n const tmp = `${dest}.${randomUUID()}.tmp`;\n\n // 中断と失敗のどちらからでも後始末が走るため、完了処理は一度だけ行います。\n let finished = false;\n const removeAbortListener = (): void => {\n c.signal.removeEventListener(\"abort\", onAbort);\n };\n const discardTemporary = async (): Promise<void> => {\n try {\n await client.del(tmp);\n } catch {\n // 後始末としての削除のため、失敗しても無視します。\n }\n };\n const finish = async (): Promise<void> => {\n if (finished) {\n return;\n }\n\n finished = true;\n removeAbortListener();\n await discardTemporary();\n };\n const onAbort = (): void => {\n void finish();\n };\n c.signal.addEventListener(\"abort\", onAbort, { once: true });\n\n return new WritableStream<Uint8Array<ArrayBuffer>>({\n async abort() {\n await finish();\n },\n async close() {\n c.signal.throwIfAborted();\n try {\n // 全チャンクの追記が完了した時点で初めて最終キーへ置き換えます (swap-on-close)。\n await client.rename(tmp, dest);\n } catch (ex) {\n await finish();\n throw ex;\n }\n // rename 後は一時キーが存在しないため、完了済みとして中断時の削除を行いません。\n finished = true;\n removeAbortListener();\n },\n async start() {\n try {\n c.signal.throwIfAborted();\n // 0 バイトの書き込みでも close 時の RENAME が成功するよう、空の文字列で一時キーを作ります。\n await client.set(tmp, \"\");\n } catch (ex) {\n await finish();\n throw ex;\n }\n },\n async write(chunk) {\n c.signal.throwIfAborted();\n try {\n await client.append(tmp, Buffer.from(chunk));\n } catch (ex) {\n await finish();\n throw ex;\n }\n },\n });\n }\n\n /\n 読み取り用ストリームを取得します。\n \n 取得した値を単一チャンクとして送出します。\n \n @param c 読み取りストリーム取得コンテキストです。\n \n @returns 読み取り用ストリームです。\n /\n public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>> {\n const { client } = this.#getConnection();\n\n c.signal.throwIfAborted();\n\n const dest = this.#toKey(c.key);\n let sent = false;\n\n // Redis の GET は値を一括で返すため、取得したバイト列を単一のチャンクとして送出します。\n return new ReadableStream<Uint8Array<ArrayBuffer>>({\n async pull(controller) {\n if (sent) {\n controller.close();\n\n return;\n }\n\n sent = true;\n c.signal.throwIfAborted();\n\n const data = await client.getBuffer(dest);\n\n if (data === null) {\n throw new KeyNotFoundError({ key: c.key });\n }\n\n controller.enqueue(new Uint8Array(data));\n controller.close();\n },\n });\n }\n\n /\n 開いている接続を返します。\n \n 未オープン時は例外を投げます。\n \n @returns オープン済みの接続です。\n /\n #getConnection(): Connection {\n const con = this.#con;\n\n if (con === null) {\n throw new TypeError(\"Redis is not open. Call open() first.\");\n }\n\n return con;\n }\n\n /\n unikvs のキーにプレフィックスを付与し、Redis のキーへ変換します。\n \n @param key 変換する論理キーです。\n \n @returns Redis 上の実キーです。\n /\n #toKey(key: string): string {\n return `${this.#keyPrefix}${key}`;\n }\n\n /\n 接頭辞に一致するキーを走査して削除します。\n \n `SCAN` で頁送りしながら `DEL` します。\n \n @param client 操作に使うクライアントです。\n * @param pattern 削除対象の一致パターンです。\n * @param signal 中断を知らせるシグナルです。\n \n @returns 削除が完了したら解決します。\n */\n async #clearPattern(client: Ioredis, pattern: string, signal: AbortSignal): Promise<void> {\n let cursor = \"0\";\n\n do {\n signal.throwIfAborted();\n\n const [nextCursor, keys] = await client.scan(cursor, \"MATCH\", pattern, \"COUNT\", SCAN_COUNT);\n\n if (keys.length > 0) {\n await client.del(...keys);\n }\n\n cursor = nextCursor;\n } while (cursor !== \"0\");\n }\n}\n"],"mappings":";;;;;;;;;;;AAQA,IAAa,2BAAb,cAA8C,sBAAiC;;;;CAQ7E,YAAmB,SAAwB;EACzC,MACE,0FACA,OACF;CACF;AACF;;AAZI,0BAAK,UAAU,OAAO;AAc1B,gBACE,0BACA,wEACA,IACF;;;;AAoBA,IAAa,2BAAb,cAA8C,UAAwC;;;;CAQpF,YAAmB,MAAoC;EACrD,MAAM,EAAE,QAAQ,GAAG,YAAY;EAE/B,MACE,EAF2C,OAExC,IACF,EAAE,QAAQ,oBACT,mEAAmE,OAAO,aAAa,EAAE,IAC3F,OACF;CACF;AACF;;AAhBI,0BAAK,UAAU,OAAO;AAkB1B,gBACE,2BACC,EAAE,aACD,oDAAoD,OAAO,MAAM,KACnE,IACF;;;;AAoBA,IAAa,sBAAb,cAAyC,UAAmC;;;;CAQ1E,YAAmB,MAA+B;EAChD,MAAM,EAAE,WAAW,GAAG,YAAY;EAElC,MACE,EAFsC,UAEnC,IACF,EAAE,WAAW,uBACZ,uCAAuC,iBAAiB,KAC1D,OACF;CACF;AACF;;AAhBI,qBAAK,UAAU,OAAO;AAkB1B,gBACE,sBACC,EAAE,gBAAgB,eAAe,UAAU,iBAC5C,IACF;;;;AAoBA,IAAa,oBAAb,cAAuC,UAAiC;;;;CAQtE,YAAmB,MAA6B;EAC9C,MAAM,EAAE,WAAW,GAAG,YAAY;EAElC,MACE,EAFoC,UAEjC,IACF,EAAE,WAAW,uBAAuB,iCAAiC,iBAAiB,KACvF,OACF;CACF;AACF;;AAfI,mBAAK,UAAU,OAAO;AAiB1B,gBACE,oBACC,EAAE,gBAAgB,kBAAkB,UAAU,iBAC/C,IACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;ACvGA,MAAM,aAAa;;;;AAKnB,MAAM,6BAA6B;;;;AAKnC,MAAM,2BAA2B;;;;;;;;;;AAejC,IAAqB,QAArB,MAA+C;;;;CA2C7C,YAAmB,KAAc,UAA+B,CAAC,GAAG;;;;;;;EAClE,MAAM,EACJ,SACA,YAAY,WACZ,eAAe,0BACf,GAAG,iBACD;EAIJ,IAAI,YAAY,KAAA,GACd,MAAM,IAAI,yBAAyB;EAKrC,IAAI,OAAO,iBAAiB,YAAY,CAAC,OAAO,SAAS,YAAY,KAAK,gBAAgB,GACxF,MAAM,IAAI,yBAAyB,EAAE,QAAQ,aAAa,CAAC;EAG7D,KAAK,OAAO;EACZ,uBAAA,MAAA,MAAY,IAAA;EACZ,uBAAA,MAAA,MAAY,GAAA;EACZ,uBAAA,UAAA,MAAgB,YAAA;EAChB,uBAAA,eAAA,MAAqB,YAAA;EACrB,uBAAA,YAAA,MAAkB,SAAA;CACpB;;;;;;CAOA,IAAW,SAAkB;EAC3B,OAAA,uBAAA,MAAO,IAAA,MAAc;CACvB;;;;;;;;;;CAWA,MAAa,KAAK,IAAyC;EAIzD,IAAA,uBAAA,MAAI,IAAA,GACF,MAAM,KAAK,MAAM,EAAsC;EAMzD,MAAM,cAAA,uBAAA,MAAc,IAAA,MAAc,KAAA,KAAA,uBAAA,MAAa,IAAA,MAAc,KAAK,KAAA,IAAA,uBAAA,MAAY,IAAA;EAC9E,MAAM,WACJ,QAAQ,IAAI,iBAAiB,KAAA,KAAa,QAAQ,IAAI,iBAAiB,KACnE,KAAA,IACA,QAAQ,IAAI;EAClB,MAAM,YACJ,QAAQ,IAAI,kBAAkB,KAAA,KAAa,QAAQ,IAAI,kBAAkB,KACrE,KAAA,IACA,QAAQ,IAAI;EAClB,MAAM,MAAM,eAAe,YAAY;EACvC,MAAM,iBAAA,uBAAA,UAAiB,IAAA,CAAA,CAAc,kBAAkB;EAOvD,MAAM,UAAU;GACd,GAAA,uBAAA,UAAG,IAAA;GACH,aAAa;GACb;EACF;EACA,MAAM,MAAM,QAAQ,KAAA,IAAY,IAAIA,QAAQ,OAAO,IAAI,IAAIA,QAAQ,KAAK,OAAO;EAK/E,IAAI,GAAG,eAAe,CAAC,CAAC;EAExB,IAAI;EAEJ,IAAI;GACF,MAAM,QAAQ,KAAK,CACjB,IAAI,QAAQ,GACZ,IAAI,SAAgB,GAAG,WAAW;IAChC,QAAQ,iBAAiB;KACvB,OAAO,IAAI,oBAAoB,EAAE,WAAW,eAAe,CAAC,CAAC;IAC/D,GAAG,cAAc;GACnB,CAAC,CACH,CAAC;EACH,SAAS,IAAI;GACX,IAAI,WAAW;GACf,MAAM;EACR,UAAU;GACR,IAAI,UAAU,KAAA,GACZ,aAAa,KAAK;EAEtB;EAEA,uBAAA,MAAA,MAAY,EAAE,QAAQ,IAAI,CAAA;CAC5B;;;;;;;;;;CAWA,MAAa,MAAM,IAA0C;EAG3D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAGvC,uBAAA,MAAA,MAAY,IAAA;EAEZ,MAAM,eAAA,uBAAA,eAAe,IAAA;EACrB,IAAI;EAEJ,IAAI;GACF,MAAM,QAAQ,KAAK,CACjB,OAAO,KAAK,GACZ,IAAI,SAAgB,GAAG,WAAW;IAChC,QAAQ,iBAAiB;KACvB,OAAO,IAAI,kBAAkB,EAAE,WAAW,aAAa,CAAC,CAAC;IAC3D,GAAG,YAAY;GACjB,CAAC,CACH,CAAC;EACH,QAAQ;GAEN,OAAO,WAAW;EACpB,UAAU;GACR,IAAI,UAAU,KAAA,GACZ,aAAa,KAAK;EAEtB;CACF;;;;;;;;;;;CAYA,MAAa,MAAM,GAA0B,MAA8C;EACzF,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,IAAA,kBAAA,cAAI,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,GAAG,OAAO,KAAK,IAAI,CAAC;CACxD;;;;;;;;;;CAWA,MAAa,KAAK,GAA2D;EAC3E,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,MAAM,OAAO,UAAA,kBAAA,cAAU,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;EAEtD,IAAI,SAAS,MACX,MAAM,IAAIC,mBAAiB,EAAE,KAAK,EAAE,IAAI,CAAC;EAG3C,OAAO,IAAI,WAAW,IAAI;CAC5B;;;;;;;;CASA,MAAa,OAAO,GAA6C;EAC/D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,OAAQ,MAAM,OAAO,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC,IAAK;CACrD;;;;;;;;;;CAWA,MAAa,OAAO,GAA0C;EAC5D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAO,IAAA,kBAAA,cAAI,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG,CAAC;CACrC;;;;;;;;;;CAWA,MAAa,MAAM,GAAyC;EAC1D,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAGxB,MAAM,UAAU,GAAA,uBAAA,YAAG,IAAA,EAAgB;EACnC,MAAA,kBAAA,cAAM,MAAA,aAAA,CAAA,CAAA,KAAA,MAAmB,QAAQ,SAAS,EAAE,MAAM;CACpD;;;;;;;;;;CAWA,YAAmB,GAAyE;EAC1F,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG;EAE9B,MAAM,MAAM,GAAG,KAAK,GAAG,WAAW,EAAE;EAGpC,IAAI,WAAW;EACf,MAAM,4BAAkC;GACtC,EAAE,OAAO,oBAAoB,SAAS,OAAO;EAC/C;EACA,MAAM,mBAAmB,YAA2B;GAClD,IAAI;IACF,MAAM,OAAO,IAAI,GAAG;GACtB,QAAQ,CAER;EACF;EACA,MAAM,SAAS,YAA2B;GACxC,IAAI,UACF;GAGF,WAAW;GACX,oBAAoB;GACpB,MAAM,iBAAiB;EACzB;EACA,MAAM,gBAAsB;GAC1B,OAAY;EACd;EACA,EAAE,OAAO,iBAAiB,SAAS,SAAS,EAAE,MAAM,KAAK,CAAC;EAE1D,OAAO,IAAI,eAAwC;GACjD,MAAM,QAAQ;IACZ,MAAM,OAAO;GACf;GACA,MAAM,QAAQ;IACZ,EAAE,OAAO,eAAe;IACxB,IAAI;KAEF,MAAM,OAAO,OAAO,KAAK,IAAI;IAC/B,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;IAEA,WAAW;IACX,oBAAoB;GACtB;GACA,MAAM,QAAQ;IACZ,IAAI;KACF,EAAE,OAAO,eAAe;KAExB,MAAM,OAAO,IAAI,KAAK,EAAE;IAC1B,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;GACF;GACA,MAAM,MAAM,OAAO;IACjB,EAAE,OAAO,eAAe;IACxB,IAAI;KACF,MAAM,OAAO,OAAO,KAAK,OAAO,KAAK,KAAK,CAAC;IAC7C,SAAS,IAAI;KACX,MAAM,OAAO;KACb,MAAM;IACR;GACF;EACF,CAAC;CACH;;;;;;;;;;CAWA,YAAmB,GAAyE;EAC1F,MAAM,EAAE,WAAA,kBAAA,cAAW,MAAA,cAAA,CAAA,CAAA,KAAA,IAAoB;EAEvC,EAAE,OAAO,eAAe;EAExB,MAAM,OAAA,kBAAA,cAAO,MAAA,MAAA,CAAA,CAAA,KAAA,MAAY,EAAE,GAAG;EAC9B,IAAI,OAAO;EAGX,OAAO,IAAI,eAAwC,EACjD,MAAM,KAAK,YAAY;GACrB,IAAI,MAAM;IACR,WAAW,MAAM;IAEjB;GACF;GAEA,OAAO;GACP,EAAE,OAAO,eAAe;GAExB,MAAM,OAAO,MAAM,OAAO,UAAU,IAAI;GAExC,IAAI,SAAS,MACX,MAAM,IAAIA,mBAAiB,EAAE,KAAK,EAAE,IAAI,CAAC;GAG3C,WAAW,QAAQ,IAAI,WAAW,IAAI,CAAC;GACvC,WAAW,MAAM;EACnB,EACF,CAAC;CACH;AAwDF;;;;;;;;AA/CE,SAAA,iBAA6B;CAC3B,MAAM,MAAA,uBAAA,MAAM,IAAA;CAEZ,IAAI,QAAQ,MACV,MAAM,IAAI,UAAU,uCAAuC;CAG7D,OAAO;AACT;;;;;;;;AASA,SAAA,OAAO,KAAqB;CAC1B,OAAO,GAAA,uBAAA,YAAG,IAAA,IAAkB;AAC9B;;;;;;;;;;;;AAaA,eAAA,cAAoB,QAAiB,SAAiB,QAAoC;CACxF,IAAI,SAAS;CAEb,GAAG;EACD,OAAO,eAAe;EAEtB,MAAM,CAAC,YAAY,QAAQ,MAAM,OAAO,KAAK,QAAQ,SAAS,SAAS,SAAS,UAAU;EAE1F,IAAI,KAAK,SAAS,GAChB,MAAM,OAAO,IAAI,GAAG,IAAI;EAG1B,SAAS;CACX,SAAS,WAAW;AACtB"}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@unikvs/redis.node",
-  "version": "0.0.13",
+  "version": "0.0.14",
   "description": "Storage plugin that stores byte arrays in Redis on Node.js.",
   "homepage": "https://tai-kun.github.io/unikvs/",
   "license": "MIT",
@@ -24,7 +24,7 @@
     }
   },
   "dependencies": {
-    "@unikvs/core": "0.0.13",
+    "@unikvs/core": "0.0.14",
     "ioredis": "^6.0.0"
   },
   "devDependencies": {

package/src/redis.ts CHANGED Viewed

@@ -50,32 +50,76 @@ export type RedisStorageOptions = Omit<RedisOptions, "keyPrefix" | "lazyConnect"
   readonly closeTimeout?: number | undefined;
 };
+/**
+ * `SCAN` 1 回あたりにヒントとして渡すキー数です。
+ *
+ * 削除の往復回数と 1 回の `DEL` に渡す引数数を抑えるために使用します。
+ */
 const SCAN_COUNT = 1000;
+/**
+ * 接続確立の既定タイムアウト (ミリ秒) です。
+ */
 const DEFAULT_CONNECT_TIMEOUT_MS = 5000;
+/**
+ * 切断処理の既定タイムアウト (ミリ秒) です。
+ */
 const DEFAULT_CLOSE_TIMEOUT_MS = 5000;
-type Connection = { readonly client: Ioredis };
+/**
+ * ストレージの動作に必要な接続を保持する型定義です。
+ */
+type Connection = {
+  /**
+   * 操作に使うクライアントです。
+   */
+  readonly client: Ioredis;
+};
 /**
  * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
  */
 export default class Redis implements IStorage {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
+   */
+  public readonly name: string;
+  /**
+   * Redis への接続を保持します。
+   *
+   * ストレージがオープンされるまで null です。
+   */
   #con: Connection | null;
+  /**
+   * 接続先の URL です。
+   *
+   * 未指定の場合はクライアントが環境変数 (`REDIS_URL`、`VALKEY_URL`) から解決します。
+   */
   readonly #url: string | undefined;
-  // `closeTimeout` は本パッケージ固有の拡張です。
-  // `this.#options` には含めず、別フィールドで保管します。
-  // `this.#options` は `new Ioredis` にそのまま spread できる透過バッグです。
+  /**
+   * `closeTimeout` は本パッケージ固有の拡張です。
+   *
+   * `this.#options` には含めず、別フィールドで保管します。
+   * `this.#options` は `new Ioredis` にそのまま spread できる透過バッグです。
+   */
   readonly #options: Omit<RedisStorageOptions, "keyPrefix" | "cluster" | "closeTimeout">;
-  // `ioredis` の `disconnectTimeout` (ソケット切断待機) とは別物です。
+  /**
+   * `close` 時の切断待ち時間 (ミリ秒) です。
+   *
+   * `ioredis` の `disconnectTimeout` (ソケット切断待機) とは別物です。
+   */
   readonly #closeTimeout: number;
+  /**
+   * すべてのキーの先頭に付与するプレフィックスです。
+   */
   readonly #keyPrefix: string;
-  public readonly name: string;
   /**
    * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#redis)
    */
@@ -107,22 +151,24 @@ export default class Redis implements IStorage {
     this.#keyPrefix = keyPrefix;
   }
+  /**
+   * ストレージがオープン済みかどうかです。
+   *
+   * @returns オープン済みなら真です。
+   */
   public get isOpen(): boolean {
     return this.#con !== null;
   }
-  // 開いている接続を返します。
-  // 未オープン時は `TypeError` を投げます。
-  #getConnection(): Connection {
-    const con = this.#con;
-    if (con === null) {
-      throw new TypeError("Redis is not open. Call open() first.");
-    }
-    return con;
-  }
+  /**
+   * ストレージをオープンします。
+   *
+   * `ioredis` クライアントを作成して接続します。
+   *
+   * @param _c オープンコンテキストです。
+   *
+   * @returns オープンが完了したら解決します。
+   */
   public async open(_c: IStorage.OpenContext): Promise<void> {
     // 並行 `open` 同士および `open` 接続待ち中の `close` の同時呼び出しは禁止 (事前条件) です。
     // 呼び出し側で直列化してください。
@@ -186,6 +232,15 @@ export default class Redis implements IStorage {
     this.#con = { client: raw };
   }
+  /**
+   * ストレージをクローズします。
+   *
+   * `quit` で丁寧に閉じ、失敗時は `disconnect` で掃除します。
+   *
+   * @param _c クローズコンテキストです。
+   *
+   * @returns クローズが完了したら解決します。
+   */
   public async close(_c: IStorage.CloseContext): Promise<void> {
     // 未 `open`・二重 `close` は `TypeError` で reject されます。
     // 必ず `await` し、結果を浮かせないでください。
@@ -216,26 +271,16 @@ export default class Redis implements IStorage {
     }
   }
-  #toKey(key: string): string {
-    return `${this.#keyPrefix}${key}`;
-  }
-  async #clearPattern(client: Ioredis, pattern: string, signal: AbortSignal): Promise<void> {
-    let cursor = "0";
-    do {
-      signal.throwIfAborted();
-      const [nextCursor, keys] = await client.scan(cursor, "MATCH", pattern, "COUNT", SCAN_COUNT);
-      if (keys.length > 0) {
-        await client.del(...keys);
-      }
-      cursor = nextCursor;
-    } while (cursor !== "0");
-  }
+  /**
+   * バイト列を書き込みます。
+   *
+   * 指定したキーで値を上書きします。
+   *
+   * @param c 書き込みコンテキストです。
+   * @param data 保存するバイト列です。
+   *
+   * @returns 書き込みが完了したら解決します。
+   */
   public async write(c: IStorage.WriteContext, data: Uint8Array<ArrayBuffer>): Promise<void> {
     const { client } = this.#getConnection();
@@ -244,6 +289,15 @@ export default class Redis implements IStorage {
     await client.set(this.#toKey(c.key), Buffer.from(data));
   }
+  /**
+   * バイト列を読み取ります。
+   *
+   * 指定したキーの値を取得します。
+   *
+   * @param c 読み取りコンテキストです。
+   *
+   * @returns 読み取ったバイト列です。
+   */
   public async read(c: IStorage.ReadContext): Promise<Uint8Array<ArrayBuffer>> {
     const { client } = this.#getConnection();
@@ -258,6 +312,13 @@ export default class Redis implements IStorage {
     return new Uint8Array(data);
   }
+  /**
+   * キーの存在を確認します。
+   *
+   * @param c 存在確認コンテキストです。
+   *
+   * @returns 存在すれば真です。
+   */
   public async exists(c: IStorage.ExistsContext): Promise<boolean> {
     const { client } = this.#getConnection();
@@ -266,6 +327,15 @@ export default class Redis implements IStorage {
     return (await client.exists(this.#toKey(c.key))) > 0;
   }
+  /**
+   * キーを削除します。
+   *
+   * 存在しないキーも成功扱いにします。
+   *
+   * @param c 削除コンテキストです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
   public async delete(c: IStorage.DeleteContext): Promise<void> {
     const { client } = this.#getConnection();
@@ -274,6 +344,15 @@ export default class Redis implements IStorage {
     await client.del(this.#toKey(c.key));
   }
+  /**
+   * 接頭辞に一致するキーをすべて削除します。
+   *
+   * `SCAN` で列挙しながら削除します。
+   *
+   * @param c クリアコンテキストです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
   public async clear(c: IStorage.ClearContext): Promise<void> {
     const { client } = this.#getConnection();
@@ -284,6 +363,15 @@ export default class Redis implements IStorage {
     await this.#clearPattern(client, pattern, c.signal);
   }
+  /**
+   * 書き込み用ストリームを取得します。
+   *
+   * 一時キーに追記し、`close` 時に最終キーへ置き換えます。
+   *
+   * @param c 書き込みストリーム取得コンテキストです。
+   *
+   * @returns 書き込み用ストリームです。
+   */
   public getWritable(c: IStorage.GetWritableContext): WritableStream<Uint8Array<ArrayBuffer>> {
     const { client } = this.#getConnection();
@@ -358,6 +446,15 @@ export default class Redis implements IStorage {
     });
   }
+  /**
+   * 読み取り用ストリームを取得します。
+   *
+   * 取得した値を単一チャンクとして送出します。
+   *
+   * @param c 読み取りストリーム取得コンテキストです。
+   *
+   * @returns 読み取り用ストリームです。
+   */
   public getReadable(c: IStorage.GetReadableContext): ReadableStream<Uint8Array<ArrayBuffer>> {
     const { client } = this.#getConnection();
@@ -389,4 +486,59 @@ export default class Redis implements IStorage {
       },
     });
   }
+  /**
+   * 開いている接続を返します。
+   *
+   * 未オープン時は例外を投げます。
+   *
+   * @returns オープン済みの接続です。
+   */
+  #getConnection(): Connection {
+    const con = this.#con;
+    if (con === null) {
+      throw new TypeError("Redis is not open. Call open() first.");
+    }
+    return con;
+  }
+  /**
+   * unikvs のキーにプレフィックスを付与し、Redis のキーへ変換します。
+   *
+   * @param key 変換する論理キーです。
+   *
+   * @returns Redis 上の実キーです。
+   */
+  #toKey(key: string): string {
+    return `${this.#keyPrefix}${key}`;
+  }
+  /**
+   * 接頭辞に一致するキーを走査して削除します。
+   *
+   * `SCAN` で頁送りしながら `DEL` します。
+   *
+   * @param client 操作に使うクライアントです。
+   * @param pattern 削除対象の一致パターンです。
+   * @param signal 中断を知らせるシグナルです。
+   *
+   * @returns 削除が完了したら解決します。
+   */
+  async #clearPattern(client: Ioredis, pattern: string, signal: AbortSignal): Promise<void> {
+    let cursor = "0";
+    do {
+      signal.throwIfAborted();
+      const [nextCursor, keys] = await client.scan(cursor, "MATCH", pattern, "COUNT", SCAN_COUNT);
+      if (keys.length > 0) {
+        await client.del(...keys);
+      }
+      cursor = nextCursor;
+    } while (cursor !== "0");
+  }
 }