@unikvs/redis.node 0.0.0 → 0.0.14

package/src/errors.ts

@@ -0,0 +1,161 @@
+import { type ErrorOptions, ErrorBase, setErrorMessage, InvalidUsageErrorBase } from "@unikvs/core";
+
+export type { KeyNotFoundErrorArgs, KeyNotFoundErrorMeta } from "@unikvs/core";
+export { KeyNotFoundError } from "@unikvs/core";
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)
+ */
+export class ClusterNotSupportedError extends InvalidUsageErrorBase<undefined> {
+  static {
+    this.prototype.name = "RedisClusterNotSupportedError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-cluster-not-supported)
+   */
+  public constructor(options?: ErrorOptions) {
+    super(
+      "Redis storage v1 supports standalone mode only: the `cluster` option is not supported.",
+      options,
+    );
+  }
+}
+
+setErrorMessage(
+  ClusterNotSupportedError,
+  "Redis ストレージ v1 は standalone モードのみに対応します。`cluster` オプションはサポートされていません。",
+  "ja",
+);
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+ */
+export type InvalidCloseTimeoutErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#invalid-close-timeout-actual)
+   */
+  readonly actual: unknown;
+};
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+ */
+export type InvalidCloseTimeoutErrorArgs = ErrorOptions & InvalidCloseTimeoutErrorMeta;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+ */
+export class InvalidCloseTimeoutError extends ErrorBase<InvalidCloseTimeoutErrorMeta> {
+  static {
+    this.prototype.name = "RedisInvalidCloseTimeoutError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-invalid-close-timeout)
+   */
+  public constructor(args: InvalidCloseTimeoutErrorArgs) {
+    const { actual, ...options } = args;
+    const meta: InvalidCloseTimeoutErrorMeta = { actual };
+    super(
+      meta,
+      ({ actual: messageActual }) =>
+        `\`closeTimeout\` must be a finite positive number (ms), but got ${String(messageActual)}.`,
+      options,
+    );
+  }
+}
+
+setErrorMessage(
+  InvalidCloseTimeoutError,
+  ({ actual }) =>
+    `\`closeTimeout\` は有限の正数 (ミリ秒) でなければなりません。受け取った値: ${String(actual)}`,
+  "ja",
+);
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+ */
+export type ConnectTimeoutErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#connect-timeout-timeoutms)
+   */
+  readonly timeoutMs: number;
+};
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+ */
+export type ConnectTimeoutErrorArgs = ErrorOptions & ConnectTimeoutErrorMeta;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+ */
+export class ConnectTimeoutError extends ErrorBase<ConnectTimeoutErrorMeta> {
+  static {
+    this.prototype.name = "RedisConnectTimeoutError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-connect-timeout)
+   */
+  public constructor(args: ConnectTimeoutErrorArgs) {
+    const { timeoutMs, ...options } = args;
+    const meta: ConnectTimeoutErrorMeta = { timeoutMs };
+    super(
+      meta,
+      ({ timeoutMs: messageTimeoutMs }) =>
+        `Timed out connecting to Redis after ${messageTimeoutMs}ms`,
+      options,
+    );
+  }
+}
+
+setErrorMessage(
+  ConnectTimeoutError,
+  ({ timeoutMs }) => `Redis への接続が ${timeoutMs}ms でタイムアウトしました`,
+  "ja",
+);
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+ */
+export type CloseTimeoutErrorMeta = {
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#close-timeout-timeoutms)
+   */
+  readonly timeoutMs: number;
+};
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+ */
+export type CloseTimeoutErrorArgs = ErrorOptions & CloseTimeoutErrorMeta;
+
+/**
+ * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+ */
+export class CloseTimeoutError extends ErrorBase<CloseTimeoutErrorMeta> {
+  static {
+    this.prototype.name = "RedisCloseTimeoutError";
+  }
+
+  /**
+   * [API Reference](https://tai-kun.github.io/unikvs/packages/redis-node#error-close-timeout)
+   */
+  public constructor(args: CloseTimeoutErrorArgs) {
+    const { timeoutMs, ...options } = args;
+    const meta: CloseTimeoutErrorMeta = { timeoutMs };
+    super(
+      meta,
+      ({ timeoutMs: messageTimeoutMs }) => `Timed out closing Redis after ${messageTimeoutMs}ms`,
+      options,
+    );
+  }
+}
+
+setErrorMessage(
+  CloseTimeoutError,
+  ({ timeoutMs }) => `Redis からの切断処理が ${timeoutMs}ms でタイムアウトしました`,
+  "ja",
+);

package/src/index.ts

@@ -0,0 +1,19 @@
+export type {
+  KeyNotFoundErrorArgs,
+  KeyNotFoundErrorMeta,
+  CloseTimeoutErrorArgs,
+  CloseTimeoutErrorMeta,
+  ConnectTimeoutErrorArgs,
+  ConnectTimeoutErrorMeta,
+  InvalidCloseTimeoutErrorArgs,
+  InvalidCloseTimeoutErrorMeta,
+} from "./errors.js";
+export {
+  KeyNotFoundError,
+  CloseTimeoutError,
+  ConnectTimeoutError,
+  ClusterNotSupportedError,
+  InvalidCloseTimeoutError,
+} from "./errors.js";
+export type * from "./redis.js";
+export { default as Redis } from "./redis.js";