@keyv/redis 5.1.3 → 5.1.4

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 (5) hide show
  1. package/dist/index.cjs +55 -45
  2. package/dist/index.d.cts +13 -10
  3. package/dist/index.d.ts +13 -10
  4. package/dist/index.js +59 -49
  5. package/package.json +10 -10
package/dist/index.cjs CHANGED
@@ -44,9 +44,8 @@ module.exports = __toCommonJS(index_exports);
44
44
  var import_client = require("@redis/client");
45
45
  var import_cluster_key_slot = __toESM(require("cluster-key-slot"), 1);
46
46
  var import_hookified = require("hookified");
47
- var import_keyv = require("keyv");
48
- var import_client2 = require("@redis/client");
49
- var import_keyv2 = require("keyv");
47
+
48
+ // src/types.ts
50
49
  var RedisErrorMessages = /* @__PURE__ */ ((RedisErrorMessages2) => {
51
50
  RedisErrorMessages2["RedisClientNotConnectedThrown"] = "Redis client is not connected or has failed to connect. This is thrown because throwOnConnectError is set to true.";
52
51
  return RedisErrorMessages2;
@@ -56,6 +55,57 @@ var defaultReconnectStrategy = (attempts) => {
56
55
  const jitter = (Math.random() - 0.5) * 100;
57
56
  return backoff + jitter;
58
57
  };
58
+
59
+ // src/index.ts
60
+ var import_client2 = require("@redis/client");
61
+ var import_keyv2 = require("keyv");
62
+
63
+ // src/create.ts
64
+ var import_keyv = require("keyv");
65
+ function createKeyv(connect, options) {
66
+ connect ??= "redis://localhost:6379";
67
+ const adapter = new KeyvRedis(connect, options);
68
+ if (options?.namespace) {
69
+ adapter.namespace = options.namespace;
70
+ const keyv2 = new import_keyv.Keyv(adapter, {
71
+ namespace: options?.namespace,
72
+ useKeyPrefix: false
73
+ });
74
+ if (options?.throwOnConnectError) {
75
+ keyv2.throwOnErrors = true;
76
+ }
77
+ if (options?.throwOnErrors) {
78
+ keyv2.throwOnErrors = true;
79
+ }
80
+ return keyv2;
81
+ }
82
+ const keyv = new import_keyv.Keyv(adapter, { useKeyPrefix: false });
83
+ if (options?.throwOnConnectError) {
84
+ keyv.throwOnErrors = true;
85
+ }
86
+ if (options?.throwOnErrors) {
87
+ keyv.throwOnErrors = true;
88
+ }
89
+ keyv.namespace = void 0;
90
+ return keyv;
91
+ }
92
+ function createKeyvNonBlocking(connect, options) {
93
+ const keyv = createKeyv(connect, options);
94
+ const keyvStore = keyv.store;
95
+ keyvStore.throwOnConnectError = false;
96
+ keyvStore.throwOnErrors = false;
97
+ const redisClient = keyvStore.client;
98
+ if (redisClient.options) {
99
+ redisClient.options.disableOfflineQueue = true;
100
+ if (redisClient.options.socket) {
101
+ redisClient.options.socket.reconnectStrategy = false;
102
+ }
103
+ }
104
+ keyv.throwOnErrors = false;
105
+ return keyv;
106
+ }
107
+
108
+ // src/index.ts
59
109
  var KeyvRedis = class extends import_hookified.Hookified {
60
110
  _client = (0, import_client.createClient)();
61
111
  _namespace;
@@ -838,48 +888,6 @@ var KeyvRedis = class extends import_hookified.Hookified {
838
888
  );
839
889
  }
840
890
  };
841
- function createKeyv(connect, options) {
842
- connect ??= "redis://localhost:6379";
843
- const adapter = new KeyvRedis(connect, options);
844
- if (options?.namespace) {
845
- adapter.namespace = options.namespace;
846
- const keyv2 = new import_keyv.Keyv(adapter, {
847
- namespace: options?.namespace,
848
- useKeyPrefix: false
849
- });
850
- if (options?.throwOnConnectError) {
851
- keyv2.throwOnErrors = true;
852
- }
853
- if (options?.throwOnErrors) {
854
- keyv2.throwOnErrors = true;
855
- }
856
- return keyv2;
857
- }
858
- const keyv = new import_keyv.Keyv(adapter, { useKeyPrefix: false });
859
- if (options?.throwOnConnectError) {
860
- keyv.throwOnErrors = true;
861
- }
862
- if (options?.throwOnErrors) {
863
- keyv.throwOnErrors = true;
864
- }
865
- keyv.namespace = void 0;
866
- return keyv;
867
- }
868
- function createKeyvNonBlocking(connect, options) {
869
- const keyv = createKeyv(connect, options);
870
- const keyvStore = keyv.store;
871
- keyvStore.throwOnConnectError = false;
872
- keyvStore.throwOnErrors = false;
873
- const redisClient = keyvStore.client;
874
- if (redisClient.options) {
875
- redisClient.options.disableOfflineQueue = true;
876
- if (redisClient.options.socket) {
877
- redisClient.options.socket.reconnectStrategy = false;
878
- }
879
- }
880
- keyv.throwOnErrors = false;
881
- return keyv;
882
- }
883
891
  // Annotate the CommonJS export names for ESM import in node:
884
892
  0 && (module.exports = {
885
893
  Keyv,
@@ -891,3 +899,5 @@ function createKeyvNonBlocking(connect, options) {
891
899
  createSentinel,
892
900
  defaultReconnectStrategy
893
901
  });
902
+ /* v8 ignore next -- @preserve */
903
+ /* v8 ignore next 3 -- @preserve */
package/dist/index.d.cts CHANGED
@@ -1,12 +1,13 @@
1
- import { RedisClientOptions, RedisClusterOptions, RedisSentinelOptions, RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType, RedisSentinelType } from '@redis/client';
1
+ import { RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType, RedisSentinelType, RedisClientOptions, RedisClusterOptions, RedisSentinelOptions } from '@redis/client';
2
2
  export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, RedisSentinelType, createClient, createCluster, createSentinel } from '@redis/client';
3
3
  import { Hookified } from 'hookified';
4
- import { KeyvStoreAdapter, KeyvEntry, Keyv } from 'keyv';
4
+ import { Keyv, KeyvStoreAdapter, KeyvEntry } from 'keyv';
5
5
  export { Keyv } from 'keyv';
6
6
 
7
7
  type KeyvRedisOptions = {
8
8
  /**
9
9
  * Namespace for the current instance.
10
+ * Defaults to `keyv`
10
11
  */
11
12
  namespace?: string;
12
13
  /**
@@ -82,6 +83,16 @@ type RedisConnectionClientType = RedisClientType | RedisClientType<RedisModules,
82
83
  type RedisConnectionClusterType = RedisClusterType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
83
84
  type RedisConnectionSentinelType = RedisSentinelType | RedisSentinelType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisSentinelType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
84
85
  type RedisClientConnectionType = RedisConnectionClientType | RedisConnectionClusterType | RedisConnectionSentinelType;
86
+
87
+ /**
88
+ * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
89
+ * @param 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. If nothing is passed in, it will default to 'redis://localhost:6379'.
90
+ * @param {KeyvRedisOptions} options - Options for the adapter such as namespace, keyPrefixSeparator, and clearBatchSize.
91
+ * @returns {Keyv} - Keyv instance with the Redis adapter
92
+ */
93
+ declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
94
+ declare function createKeyvNonBlocking(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
95
+
85
96
  declare class KeyvRedis<T> extends Hookified implements KeyvStoreAdapter {
86
97
  private _client;
87
98
  private _namespace;
@@ -331,13 +342,5 @@ declare class KeyvRedis<T> extends Hookified implements KeyvStoreAdapter {
331
342
  private initClient;
332
343
  private createTimeoutPromise;
333
344
  }
334
- /**
335
- * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
336
- * @param 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. If nothing is passed in, it will default to 'redis://localhost:6379'.
337
- * @param {KeyvRedisOptions} options - Options for the adapter such as namespace, keyPrefixSeparator, and clearBatchSize.
338
- * @returns {Keyv} - Keyv instance with the Redis adapter
339
- */
340
- declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
341
- declare function createKeyvNonBlocking(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
342
345
 
343
346
  export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, type RedisConnectionClientType, type RedisConnectionClusterType, type RedisConnectionSentinelType, RedisErrorMessages, createKeyv, createKeyvNonBlocking, KeyvRedis as default, defaultReconnectStrategy };
package/dist/index.d.ts CHANGED
@@ -1,12 +1,13 @@
1
- import { RedisClientOptions, RedisClusterOptions, RedisSentinelOptions, RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType, RedisSentinelType } from '@redis/client';
1
+ import { RedisClientType, RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping, RedisClusterType, RedisSentinelType, RedisClientOptions, RedisClusterOptions, RedisSentinelOptions } from '@redis/client';
2
2
  export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, RedisSentinelType, createClient, createCluster, createSentinel } from '@redis/client';
3
3
  import { Hookified } from 'hookified';
4
- import { KeyvStoreAdapter, KeyvEntry, Keyv } from 'keyv';
4
+ import { Keyv, KeyvStoreAdapter, KeyvEntry } from 'keyv';
5
5
  export { Keyv } from 'keyv';
6
6
 
7
7
  type KeyvRedisOptions = {
8
8
  /**
9
9
  * Namespace for the current instance.
10
+ * Defaults to `keyv`
10
11
  */
11
12
  namespace?: string;
12
13
  /**
@@ -82,6 +83,16 @@ type RedisConnectionClientType = RedisClientType | RedisClientType<RedisModules,
82
83
  type RedisConnectionClusterType = RedisClusterType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisClusterType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
83
84
  type RedisConnectionSentinelType = RedisSentinelType | RedisSentinelType<RedisModules, RedisFunctions, RedisScripts, RespVersions> | RedisSentinelType<RedisModules, RedisFunctions, RedisScripts, RespVersions, TypeMapping>;
84
85
  type RedisClientConnectionType = RedisConnectionClientType | RedisConnectionClusterType | RedisConnectionSentinelType;
86
+
87
+ /**
88
+ * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
89
+ * @param 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. If nothing is passed in, it will default to 'redis://localhost:6379'.
90
+ * @param {KeyvRedisOptions} options - Options for the adapter such as namespace, keyPrefixSeparator, and clearBatchSize.
91
+ * @returns {Keyv} - Keyv instance with the Redis adapter
92
+ */
93
+ declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
94
+ declare function createKeyvNonBlocking(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
95
+
85
96
  declare class KeyvRedis<T> extends Hookified implements KeyvStoreAdapter {
86
97
  private _client;
87
98
  private _namespace;
@@ -331,13 +342,5 @@ declare class KeyvRedis<T> extends Hookified implements KeyvStoreAdapter {
331
342
  private initClient;
332
343
  private createTimeoutPromise;
333
344
  }
334
- /**
335
- * Will create a Keyv instance with the Redis adapter. This will also set the namespace and useKeyPrefix to false.
336
- * @param 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. If nothing is passed in, it will default to 'redis://localhost:6379'.
337
- * @param {KeyvRedisOptions} options - Options for the adapter such as namespace, keyPrefixSeparator, and clearBatchSize.
338
- * @returns {Keyv} - Keyv instance with the Redis adapter
339
- */
340
- declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
341
- declare function createKeyvNonBlocking(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
342
345
 
343
346
  export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, type RedisConnectionClientType, type RedisConnectionClusterType, type RedisConnectionSentinelType, RedisErrorMessages, createKeyv, createKeyvNonBlocking, KeyvRedis as default, defaultReconnectStrategy };
package/dist/index.js CHANGED
@@ -6,13 +6,8 @@ import {
6
6
  } from "@redis/client";
7
7
  import calculateSlot from "cluster-key-slot";
8
8
  import { Hookified } from "hookified";
9
- import { Keyv } from "keyv";
10
- import {
11
- createClient as createClient2,
12
- createCluster as createCluster2,
13
- createSentinel as createSentinel2
14
- } from "@redis/client";
15
- import { Keyv as Keyv2 } from "keyv";
9
+
10
+ // src/types.ts
16
11
  var RedisErrorMessages = /* @__PURE__ */ ((RedisErrorMessages2) => {
17
12
  RedisErrorMessages2["RedisClientNotConnectedThrown"] = "Redis client is not connected or has failed to connect. This is thrown because throwOnConnectError is set to true.";
18
13
  return RedisErrorMessages2;
@@ -22,6 +17,61 @@ var defaultReconnectStrategy = (attempts) => {
22
17
  const jitter = (Math.random() - 0.5) * 100;
23
18
  return backoff + jitter;
24
19
  };
20
+
21
+ // src/index.ts
22
+ import {
23
+ createClient as createClient2,
24
+ createCluster as createCluster2,
25
+ createSentinel as createSentinel2
26
+ } from "@redis/client";
27
+ import { Keyv as Keyv2 } from "keyv";
28
+
29
+ // src/create.ts
30
+ import { Keyv } from "keyv";
31
+ function createKeyv(connect, options) {
32
+ connect ??= "redis://localhost:6379";
33
+ const adapter = new KeyvRedis(connect, options);
34
+ if (options?.namespace) {
35
+ adapter.namespace = options.namespace;
36
+ const keyv2 = new Keyv(adapter, {
37
+ namespace: options?.namespace,
38
+ useKeyPrefix: false
39
+ });
40
+ if (options?.throwOnConnectError) {
41
+ keyv2.throwOnErrors = true;
42
+ }
43
+ if (options?.throwOnErrors) {
44
+ keyv2.throwOnErrors = true;
45
+ }
46
+ return keyv2;
47
+ }
48
+ const keyv = new Keyv(adapter, { useKeyPrefix: false });
49
+ if (options?.throwOnConnectError) {
50
+ keyv.throwOnErrors = true;
51
+ }
52
+ if (options?.throwOnErrors) {
53
+ keyv.throwOnErrors = true;
54
+ }
55
+ keyv.namespace = void 0;
56
+ return keyv;
57
+ }
58
+ function createKeyvNonBlocking(connect, options) {
59
+ const keyv = createKeyv(connect, options);
60
+ const keyvStore = keyv.store;
61
+ keyvStore.throwOnConnectError = false;
62
+ keyvStore.throwOnErrors = false;
63
+ const redisClient = keyvStore.client;
64
+ if (redisClient.options) {
65
+ redisClient.options.disableOfflineQueue = true;
66
+ if (redisClient.options.socket) {
67
+ redisClient.options.socket.reconnectStrategy = false;
68
+ }
69
+ }
70
+ keyv.throwOnErrors = false;
71
+ return keyv;
72
+ }
73
+
74
+ // src/index.ts
25
75
  var KeyvRedis = class extends Hookified {
26
76
  _client = createClient();
27
77
  _namespace;
@@ -804,48 +854,6 @@ var KeyvRedis = class extends Hookified {
804
854
  );
805
855
  }
806
856
  };
807
- function createKeyv(connect, options) {
808
- connect ??= "redis://localhost:6379";
809
- const adapter = new KeyvRedis(connect, options);
810
- if (options?.namespace) {
811
- adapter.namespace = options.namespace;
812
- const keyv2 = new Keyv(adapter, {
813
- namespace: options?.namespace,
814
- useKeyPrefix: false
815
- });
816
- if (options?.throwOnConnectError) {
817
- keyv2.throwOnErrors = true;
818
- }
819
- if (options?.throwOnErrors) {
820
- keyv2.throwOnErrors = true;
821
- }
822
- return keyv2;
823
- }
824
- const keyv = new Keyv(adapter, { useKeyPrefix: false });
825
- if (options?.throwOnConnectError) {
826
- keyv.throwOnErrors = true;
827
- }
828
- if (options?.throwOnErrors) {
829
- keyv.throwOnErrors = true;
830
- }
831
- keyv.namespace = void 0;
832
- return keyv;
833
- }
834
- function createKeyvNonBlocking(connect, options) {
835
- const keyv = createKeyv(connect, options);
836
- const keyvStore = keyv.store;
837
- keyvStore.throwOnConnectError = false;
838
- keyvStore.throwOnErrors = false;
839
- const redisClient = keyvStore.client;
840
- if (redisClient.options) {
841
- redisClient.options.disableOfflineQueue = true;
842
- if (redisClient.options.socket) {
843
- redisClient.options.socket.reconnectStrategy = false;
844
- }
845
- }
846
- keyv.throwOnErrors = false;
847
- return keyv;
848
- }
849
857
  export {
850
858
  Keyv2 as Keyv,
851
859
  RedisErrorMessages,
@@ -857,3 +865,5 @@ export {
857
865
  KeyvRedis as default,
858
866
  defaultReconnectStrategy
859
867
  };
868
+ /* v8 ignore next -- @preserve */
869
+ /* v8 ignore next 3 -- @preserve */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@keyv/redis",
3
- "version": "5.1.3",
3
+ "version": "5.1.4",
4
4
  "description": "Redis storage adapter for Keyv",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",
@@ -34,22 +34,22 @@
34
34
  },
35
35
  "homepage": "https://github.com/jaredwray/keyv",
36
36
  "dependencies": {
37
- "@redis/client": "^5.8.3",
37
+ "@redis/client": "^5.9.0",
38
38
  "cluster-key-slot": "^1.1.2",
39
- "hookified": "^1.12.1"
39
+ "hookified": "^1.12.2"
40
40
  },
41
41
  "peerDependencies": {
42
- "keyv": "^5.5.3"
42
+ "keyv": "^5.5.4"
43
43
  },
44
44
  "devDependencies": {
45
- "@biomejs/biome": "^2.2.5",
46
- "@faker-js/faker": "^10.0.0",
47
- "@vitest/coverage-v8": "^3.2.4",
48
- "rimraf": "^6.0.1",
45
+ "@biomejs/biome": "^2.3.4",
46
+ "@faker-js/faker": "^10.1.0",
47
+ "@vitest/coverage-v8": "^4.0.8",
48
+ "rimraf": "^6.1.0",
49
49
  "timekeeper": "^2.3.1",
50
50
  "tsd": "^0.33.0",
51
- "vitest": "^3.2.4",
52
- "@keyv/test-suite": "^2.1.1"
51
+ "vitest": "^4.0.8",
52
+ "@keyv/test-suite": "^2.1.2"
53
53
  },
54
54
  "tsd": {
55
55
  "directory": "test"