@keyv/redis 4.5.0 → 5.0.0

package/dist/index.d.cts

@@ -1,6 +1,6 @@
-import EventEmitter from 'node:events';
-import { RedisClientOptions, RedisClusterOptions, RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts } from '@redis/client';
+import { RedisClientOptions, RedisClusterOptions, RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType } from '@redis/client';
 export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, createClient, createCluster } from '@redis/client';
+import { Hookified } from 'hookified';
 import { KeyvStoreAdapter, KeyvEntry, Keyv } from 'keyv';
 export { Keyv } from 'keyv';
 
@@ -28,10 +28,24 @@ type KeyvRedisOptions = {
      */
     noNamespaceAffectsAll?: boolean;
     /**
-     * Timeout for connecting to Redis in milliseconds. This is used to prevent hanging indefinitely when connecting to Redis.
-     * Defaults to `200`.
+     * This is used to throw an error if the client is not connected when trying to connect. By default, this is
+     * set to true so that it throws an error when trying to connect to the Redis server fails.
      */
-    connectTimeout?: number;
+    throwOnConnectError?: boolean;
+    /**
+     * This is used to throw an error if at any point there is a failure. Use this if you want to
+     * ensure that all operations are successful and you want to handle errors. By default, this is
+     * set to false so that it does not throw an error on every operation and instead emits an error event
+     * and returns no-op responses.
+     * @default false
+     */
+    throwOnErrors?: boolean;
+    /**
+     * Timeout in milliseconds for the connection. Default is undefined, which uses the default timeout of the Redis client.
+     * If set, it will throw an error if the connection does not succeed within the specified time.
+     * @default undefined
+     */
+    connectionTimeout?: number;
 };
 type KeyvRedisPropertyOptions = KeyvRedisOptions & {
     /**
@@ -59,21 +73,24 @@ type KeyvRedisEntry<T> = {
 };
 declare enum RedisErrorMessages {
     /**
-     * Error message when the Redis client is not connected.
+     * Error message when the Redis client is not connected and throwOnConnectError is set to true.
      */
-    RedisClientNotConnected = "Redis client is not connected or has failed to connect"
+    RedisClientNotConnectedThrown = "Redis client is not connected or has failed to connect. This is thrown because throwOnConnectError is set to true."
 }
 declare const defaultReconnectStrategy: (attempts: number) => number | Error;
-type RedisClientConnectionType = RedisClientType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts>;
-declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
+type RedisConnectionClientType = RedisClientType | RedisClientType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisClientType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
+type RedisConnectionClusterType = RedisClusterType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
+type RedisClientConnectionType = RedisConnectionClientType | RedisConnectionClusterType;
+declare class KeyvRedis<T> extends Hookified implements KeyvStoreAdapter {
     private _client;
     private _namespace;
     private _keyPrefixSeparator;
     private _clearBatchSize;
     private _useUnlink;
     private _noNamespaceAffectsAll;
-    private _connectTimeout;
-    private _reconnectClient;
+    private _throwOnConnectError;
+    private _throwOnErrors;
+    private _connectionTimeout;
     /**
      * KeyvRedis constructor.
      * @param {string | RedisClientOptions | RedisClientType} [connect] How to connect to the Redis server. If string pass in the url, if object pass in the options, if RedisClient pass in the client.
@@ -144,19 +161,49 @@ declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
      */
     set noNamespaceAffectsAll(value: boolean);
     /**
-     * Get the timeout for connecting to Redis in milliseconds. This is used to prevent hanging indefinitely when connecting to Redis.
-     * @default 200
+     * Get if throwOnConnectError is set to true.
+     * This is used to throw an error if the client is not connected when trying to connect. By default, this is
+     * set to true so that it throws an error when trying to connect to the Redis server fails.
+     * @default true
+     */
+    get throwOnConnectError(): boolean;
+    /**
+     * Set if throwOnConnectError is set to true.
+     * This is used to throw an error if the client is not connected when trying to connect. By default, this is
+     * set to true so that it throws an error when trying to connect to the Redis server fails.
      */
-    get connectTimeout(): number;
+    set throwOnConnectError(value: boolean);
     /**
-     * Set the timeout for connecting to Redis in milliseconds. This is used to prevent hanging indefinitely when connecting to Redis.
-     * @default 200
+     * Get if throwOnErrors is set to true.
+     * This is used to throw an error if at any point there is a failure. Use this if you want to
+     * ensure that all operations are successful and you want to handle errors. By default, this is
+     * set to false so that it does not throw an error on every operation and instead emits an error event
+     * and returns no-op responses.
+     * @default false
+     */
+    get throwOnErrors(): boolean;
+    /**
+     * Set if throwOnErrors is set to true.
+     * This is used to throw an error if at any point there is a failure. Use this if you want to
+     * ensure that all operations are successful and you want to handle errors. By default, this is
+     * set to false so that it does not throw an error on every operation and instead emits an error event
+     * and returns no-op responses.
+     */
+    set throwOnErrors(value: boolean);
+    /**
+     * Get the connection timeout in milliseconds such as 5000 (5 seconds). Default is undefined. If undefined, it will use the default.
+     * @default undefined
+     */
+    get connectionTimeout(): number | undefined;
+    /**
+     * Set the connection timeout in milliseconds such as 5000 (5 seconds). Default is undefined. If undefined, it will use the default.
+     * @default undefined
      */
-    set connectTimeout(value: number);
+    set connectionTimeout(value: number | undefined);
     /**
      * Get the Redis URL used to connect to the server. This is used to get a connected client.
      */
-    getClient(): Promise<RedisClientConnectionType | undefined>;
+    getClient(): Promise<RedisClientConnectionType>;
     /**
      * Set a key value pair in the store. TTL is in milliseconds.
      * @param {string} key - the key to set
@@ -275,6 +322,7 @@ declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
     private isClientCluster;
     private setOptions;
     private initClient;
+    private createTimeoutPromise;
 }
 /**
  * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
@@ -283,5 +331,6 @@ declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
  * @returns {Keyv} - Keyv instance with the Redis adapter
  */
 declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
+declare function createKeyvNonBlocking(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
 
-export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, RedisErrorMessages, createKeyv, KeyvRedis as default, defaultReconnectStrategy };
+export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, type RedisConnectionClientType, type RedisConnectionClusterType, RedisErrorMessages, createKeyv, createKeyvNonBlocking, KeyvRedis as default, defaultReconnectStrategy };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import EventEmitter from 'node:events';
-import { RedisClientOptions, RedisClusterOptions, RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts } from '@redis/client';
+import { RedisClientOptions, RedisClusterOptions, RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType } from '@redis/client';
 export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, createClient, createCluster } from '@redis/client';
+import { Hookified } from 'hookified';
 import { KeyvStoreAdapter, KeyvEntry, Keyv } from 'keyv';
 export { Keyv } from 'keyv';
 
@@ -28,10 +28,24 @@ type KeyvRedisOptions = {
      */
     noNamespaceAffectsAll?: boolean;
     /**
-     * Timeout for connecting to Redis in milliseconds. This is used to prevent hanging indefinitely when connecting to Redis.
-     * Defaults to `200`.
+     * This is used to throw an error if the client is not connected when trying to connect. By default, this is
+     * set to true so that it throws an error when trying to connect to the Redis server fails.
      */
-    connectTimeout?: number;
+    throwOnConnectError?: boolean;
+    /**
+     * This is used to throw an error if at any point there is a failure. Use this if you want to
+     * ensure that all operations are successful and you want to handle errors. By default, this is
+     * set to false so that it does not throw an error on every operation and instead emits an error event
+     * and returns no-op responses.
+     * @default false
+     */
+    throwOnErrors?: boolean;
+    /**
+     * Timeout in milliseconds for the connection. Default is undefined, which uses the default timeout of the Redis client.
+     * If set, it will throw an error if the connection does not succeed within the specified time.
+     * @default undefined
+     */
+    connectionTimeout?: number;
 };
 type KeyvRedisPropertyOptions = KeyvRedisOptions & {
     /**
@@ -59,21 +73,24 @@ type KeyvRedisEntry<T> = {
 };
 declare enum RedisErrorMessages {
     /**
-     * Error message when the Redis client is not connected.
+     * Error message when the Redis client is not connected and throwOnConnectError is set to true.
      */
-    RedisClientNotConnected = "Redis client is not connected or has failed to connect"
+    RedisClientNotConnectedThrown = "Redis client is not connected or has failed to connect. This is thrown because throwOnConnectError is set to true."
 }
 declare const defaultReconnectStrategy: (attempts: number) => number | Error;
-type RedisClientConnectionType = RedisClientType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts>;
-declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
+type RedisConnectionClientType = RedisClientType | RedisClientType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisClientType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
+type RedisConnectionClusterType = RedisClusterType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
+type RedisClientConnectionType = RedisConnectionClientType | RedisConnectionClusterType;
+declare class KeyvRedis<T> extends Hookified implements KeyvStoreAdapter {
     private _client;
     private _namespace;
     private _keyPrefixSeparator;
     private _clearBatchSize;
     private _useUnlink;
     private _noNamespaceAffectsAll;
-    private _connectTimeout;
-    private _reconnectClient;
+    private _throwOnConnectError;
+    private _throwOnErrors;
+    private _connectionTimeout;
     /**
      * KeyvRedis constructor.
      * @param {string | RedisClientOptions | RedisClientType} [connect] How to connect to the Redis server. If string pass in the url, if object pass in the options, if RedisClient pass in the client.
@@ -144,19 +161,49 @@ declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
      */
     set noNamespaceAffectsAll(value: boolean);
     /**
-     * Get the timeout for connecting to Redis in milliseconds. This is used to prevent hanging indefinitely when connecting to Redis.
-     * @default 200
+     * Get if throwOnConnectError is set to true.
+     * This is used to throw an error if the client is not connected when trying to connect. By default, this is
+     * set to true so that it throws an error when trying to connect to the Redis server fails.
+     * @default true
+     */
+    get throwOnConnectError(): boolean;
+    /**
+     * Set if throwOnConnectError is set to true.
+     * This is used to throw an error if the client is not connected when trying to connect. By default, this is
+     * set to true so that it throws an error when trying to connect to the Redis server fails.
      */
-    get connectTimeout(): number;
+    set throwOnConnectError(value: boolean);
     /**
-     * Set the timeout for connecting to Redis in milliseconds. This is used to prevent hanging indefinitely when connecting to Redis.
-     * @default 200
+     * Get if throwOnErrors is set to true.
+     * This is used to throw an error if at any point there is a failure. Use this if you want to
+     * ensure that all operations are successful and you want to handle errors. By default, this is
+     * set to false so that it does not throw an error on every operation and instead emits an error event
+     * and returns no-op responses.
+     * @default false
+     */
+    get throwOnErrors(): boolean;
+    /**
+     * Set if throwOnErrors is set to true.
+     * This is used to throw an error if at any point there is a failure. Use this if you want to
+     * ensure that all operations are successful and you want to handle errors. By default, this is
+     * set to false so that it does not throw an error on every operation and instead emits an error event
+     * and returns no-op responses.
+     */
+    set throwOnErrors(value: boolean);
+    /**
+     * Get the connection timeout in milliseconds such as 5000 (5 seconds). Default is undefined. If undefined, it will use the default.
+     * @default undefined
+     */
+    get connectionTimeout(): number | undefined;
+    /**
+     * Set the connection timeout in milliseconds such as 5000 (5 seconds). Default is undefined. If undefined, it will use the default.
+     * @default undefined
      */
-    set connectTimeout(value: number);
+    set connectionTimeout(value: number | undefined);
     /**
      * Get the Redis URL used to connect to the server. This is used to get a connected client.
      */
-    getClient(): Promise<RedisClientConnectionType | undefined>;
+    getClient(): Promise<RedisClientConnectionType>;
     /**
      * Set a key value pair in the store. TTL is in milliseconds.
      * @param {string} key - the key to set
@@ -275,6 +322,7 @@ declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
     private isClientCluster;
     private setOptions;
     private initClient;
+    private createTimeoutPromise;
 }
 /**
  * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
@@ -283,5 +331,6 @@ declare class KeyvRedis<T> extends EventEmitter implements KeyvStoreAdapter {
  * @returns {Keyv} - Keyv instance with the Redis adapter
  */
 declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
+declare function createKeyvNonBlocking(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
 
-export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, RedisErrorMessages, createKeyv, KeyvRedis as default, defaultReconnectStrategy };
+export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, type RedisConnectionClientType, type RedisConnectionClusterType, RedisErrorMessages, createKeyv, createKeyvNonBlocking, KeyvRedis as default, defaultReconnectStrategy };