@keyv/redis 3.0.0-rc.1 → 3.0.1
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.
- package/LICENSE +22 -0
- package/README.md +16 -15
- package/dist/index.cjs +163 -0
- package/dist/index.d.cts +33 -0
- package/dist/index.d.ts +14 -4
- package/dist/index.js +124 -131
- package/package.json +18 -8
- package/dist/index.js.map +0 -1
- package/dist/types.d.ts +0 -9
- package/dist/types.js +0 -3
- package/dist/types.js.map +0 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2017-2021 Luke Childs
|
|
4
|
+
Copyright (c) 2021-2022 Jared Wray
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
7
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
8
|
+
in the Software without restriction, including without limitation the rights
|
|
9
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
10
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
11
|
+
furnished to do so, subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be included in all
|
|
14
|
+
copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
17
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
18
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
19
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
20
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
21
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
22
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# @keyv/redis [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)
|
|
1
|
+
# @keyv/redis [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
|
|
2
2
|
|
|
3
3
|
> Redis storage adapter for Keyv
|
|
4
4
|
|
|
@@ -20,9 +20,10 @@ npm install --save keyv @keyv/redis
|
|
|
20
20
|
## Usage
|
|
21
21
|
|
|
22
22
|
```js
|
|
23
|
-
|
|
23
|
+
import Keyv from 'keyv';
|
|
24
|
+
import KeyvRedis from '@keyv/redis';
|
|
24
25
|
|
|
25
|
-
const keyv = new Keyv('redis://user:pass@localhost:6379');
|
|
26
|
+
const keyv = new Keyv(new KeyvRedis('redis://user:pass@localhost:6379'));
|
|
26
27
|
keyv.on('error', handleConnectionError);
|
|
27
28
|
```
|
|
28
29
|
|
|
@@ -31,14 +32,14 @@ Any valid [`Redis`](https://github.com/luin/ioredis#connect-to-redis) options wi
|
|
|
31
32
|
e.g:
|
|
32
33
|
|
|
33
34
|
```js
|
|
34
|
-
const keyv = new Keyv('redis://user:pass@localhost:6379', { disable_resubscribing: true });
|
|
35
|
+
const keyv = new Keyv(new KeyvRedis('redis://user:pass@localhost:6379', { disable_resubscribing: true }));
|
|
35
36
|
```
|
|
36
37
|
|
|
37
38
|
Or you can manually create a storage adapter instance and pass it to Keyv:
|
|
38
39
|
|
|
39
40
|
```js
|
|
40
|
-
|
|
41
|
-
|
|
41
|
+
import Keyv from 'keyv';
|
|
42
|
+
import KeyvRedis from '@keyv/redis';
|
|
42
43
|
|
|
43
44
|
const keyvRedis = new KeyvRedis('redis://user:pass@localhost:6379');
|
|
44
45
|
const keyv = new Keyv({ store: keyvRedis });
|
|
@@ -47,9 +48,9 @@ const keyv = new Keyv({ store: keyvRedis });
|
|
|
47
48
|
Or reuse a previous Redis instance:
|
|
48
49
|
|
|
49
50
|
```js
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
51
|
+
import Keyv from 'keyv';
|
|
52
|
+
import Redis from 'ioredis';
|
|
53
|
+
import KeyvRedis from '@keyv/redis';
|
|
53
54
|
|
|
54
55
|
const redis = new Redis('redis://user:pass@localhost:6379');
|
|
55
56
|
const keyvRedis = new KeyvRedis(redis);
|
|
@@ -59,9 +60,9 @@ const keyv = new Keyv({ store: keyvRedis });
|
|
|
59
60
|
Or reuse a previous Redis cluster:
|
|
60
61
|
|
|
61
62
|
```js
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
63
|
+
import Keyv from 'keyv';
|
|
64
|
+
import Redis from 'ioredis';
|
|
65
|
+
import KeyvRedis from '@keyv/redis';
|
|
65
66
|
|
|
66
67
|
const redis = new Redis.Cluster('redis://user:pass@localhost:6379');
|
|
67
68
|
const keyvRedis = new KeyvRedis(redis);
|
|
@@ -90,11 +91,11 @@ However, please note that setting `useRedisSets` to `false` could lead to perfor
|
|
|
90
91
|
Here's how you can use the `useRedisSets` option:
|
|
91
92
|
|
|
92
93
|
```js
|
|
93
|
-
|
|
94
|
+
import Keyv from 'keyv';
|
|
94
95
|
|
|
95
|
-
const keyv = new Keyv('redis://user:pass@localhost:6379', { useRedisSets: false });
|
|
96
|
+
const keyv = new Keyv(new KeyvRedis('redis://user:pass@localhost:6379', { useRedisSets: false }));
|
|
96
97
|
```
|
|
97
98
|
|
|
98
99
|
## License
|
|
99
100
|
|
|
100
|
-
MIT © Jared Wray
|
|
101
|
+
[MIT © Jared Wray](LISCENCE)
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1,163 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __create = Object.create;
|
|
3
|
+
var __defProp = Object.defineProperty;
|
|
4
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
+
var __getProtoOf = Object.getPrototypeOf;
|
|
7
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
|
+
var __export = (target, all) => {
|
|
9
|
+
for (var name in all)
|
|
10
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
11
|
+
};
|
|
12
|
+
var __copyProps = (to, from, except, desc) => {
|
|
13
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
14
|
+
for (let key of __getOwnPropNames(from))
|
|
15
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
16
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
17
|
+
}
|
|
18
|
+
return to;
|
|
19
|
+
};
|
|
20
|
+
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
+
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
+
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
+
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
+
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
+
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
+
mod
|
|
27
|
+
));
|
|
28
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
|
+
|
|
30
|
+
// src/index.ts
|
|
31
|
+
var src_exports = {};
|
|
32
|
+
__export(src_exports, {
|
|
33
|
+
default: () => src_default
|
|
34
|
+
});
|
|
35
|
+
module.exports = __toCommonJS(src_exports);
|
|
36
|
+
var import_events = __toESM(require("events"), 1);
|
|
37
|
+
var import_ioredis = __toESM(require("ioredis"), 1);
|
|
38
|
+
var KeyvRedis = class extends import_events.default {
|
|
39
|
+
ttlSupport = true;
|
|
40
|
+
namespace;
|
|
41
|
+
opts;
|
|
42
|
+
redis;
|
|
43
|
+
constructor(uri, options) {
|
|
44
|
+
super();
|
|
45
|
+
this.opts = {};
|
|
46
|
+
this.opts.useRedisSets = true;
|
|
47
|
+
this.opts.dialect = "redis";
|
|
48
|
+
if (typeof uri !== "string" && uri.options && ("family" in uri.options || uri.isCluster)) {
|
|
49
|
+
this.redis = uri;
|
|
50
|
+
} else {
|
|
51
|
+
options = { ...typeof uri === "string" ? { uri } : uri, ...options };
|
|
52
|
+
this.redis = new import_ioredis.default(options.uri, options);
|
|
53
|
+
}
|
|
54
|
+
if (options !== void 0 && options.useRedisSets === false) {
|
|
55
|
+
this.opts.useRedisSets = false;
|
|
56
|
+
}
|
|
57
|
+
this.redis.on("error", (error) => this.emit("error", error));
|
|
58
|
+
}
|
|
59
|
+
_getNamespace() {
|
|
60
|
+
return `namespace:${this.namespace}`;
|
|
61
|
+
}
|
|
62
|
+
_getKeyName = (key) => {
|
|
63
|
+
if (!this.opts.useRedisSets) {
|
|
64
|
+
return `sets:${this._getNamespace()}:${key}`;
|
|
65
|
+
}
|
|
66
|
+
return key;
|
|
67
|
+
};
|
|
68
|
+
async get(key) {
|
|
69
|
+
key = this._getKeyName(key);
|
|
70
|
+
const value = await this.redis.get(key);
|
|
71
|
+
if (value === null) {
|
|
72
|
+
return void 0;
|
|
73
|
+
}
|
|
74
|
+
return value;
|
|
75
|
+
}
|
|
76
|
+
async getMany(keys) {
|
|
77
|
+
keys = keys.map(this._getKeyName);
|
|
78
|
+
return this.redis.mget(keys);
|
|
79
|
+
}
|
|
80
|
+
async set(key, value, ttl) {
|
|
81
|
+
if (value === void 0) {
|
|
82
|
+
return void 0;
|
|
83
|
+
}
|
|
84
|
+
key = this._getKeyName(key);
|
|
85
|
+
const set = async (redis) => {
|
|
86
|
+
if (typeof ttl === "number") {
|
|
87
|
+
await redis.set(key, value, "PX", ttl);
|
|
88
|
+
} else {
|
|
89
|
+
await redis.set(key, value);
|
|
90
|
+
}
|
|
91
|
+
};
|
|
92
|
+
if (this.opts.useRedisSets) {
|
|
93
|
+
const trx = await this.redis.multi();
|
|
94
|
+
await set(trx);
|
|
95
|
+
await trx.sadd(this._getNamespace(), key);
|
|
96
|
+
await trx.exec();
|
|
97
|
+
} else {
|
|
98
|
+
await set(this.redis);
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
async delete(key) {
|
|
102
|
+
key = this._getKeyName(key);
|
|
103
|
+
let items = 0;
|
|
104
|
+
const unlink = async (redis) => redis.unlink(key);
|
|
105
|
+
if (this.opts.useRedisSets) {
|
|
106
|
+
const trx = this.redis.multi();
|
|
107
|
+
await unlink(trx);
|
|
108
|
+
await trx.srem(this._getNamespace(), key);
|
|
109
|
+
const r = await trx.exec();
|
|
110
|
+
items = r[0][1];
|
|
111
|
+
} else {
|
|
112
|
+
items = await unlink(this.redis);
|
|
113
|
+
}
|
|
114
|
+
return items > 0;
|
|
115
|
+
}
|
|
116
|
+
async deleteMany(keys) {
|
|
117
|
+
const deletePromises = keys.map(async (key) => this.delete(key));
|
|
118
|
+
const results = await Promise.allSettled(deletePromises);
|
|
119
|
+
return results.every((result) => result.value);
|
|
120
|
+
}
|
|
121
|
+
async clear() {
|
|
122
|
+
if (this.opts.useRedisSets) {
|
|
123
|
+
const keys = await this.redis.smembers(this._getNamespace());
|
|
124
|
+
if (keys.length > 0) {
|
|
125
|
+
await Promise.all([
|
|
126
|
+
this.redis.unlink([...keys]),
|
|
127
|
+
this.redis.srem(this._getNamespace(), [...keys])
|
|
128
|
+
]);
|
|
129
|
+
}
|
|
130
|
+
} else {
|
|
131
|
+
const pattern = `sets:${this._getNamespace()}:*`;
|
|
132
|
+
const keys = await this.redis.keys(pattern);
|
|
133
|
+
if (keys.length > 0) {
|
|
134
|
+
await this.redis.unlink(keys);
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
async *iterator(namespace) {
|
|
139
|
+
const scan = this.redis.scan.bind(this.redis);
|
|
140
|
+
const get = this.redis.mget.bind(this.redis);
|
|
141
|
+
let cursor = "0";
|
|
142
|
+
do {
|
|
143
|
+
const [curs, keys] = await scan(cursor, "MATCH", `${namespace}:*`);
|
|
144
|
+
cursor = curs;
|
|
145
|
+
if (keys.length > 0) {
|
|
146
|
+
const values = await get(keys);
|
|
147
|
+
for (const [i] of keys.entries()) {
|
|
148
|
+
const key = keys[i];
|
|
149
|
+
const value = values[i];
|
|
150
|
+
yield [key, value];
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
} while (cursor !== "0");
|
|
154
|
+
}
|
|
155
|
+
async has(key) {
|
|
156
|
+
const value = await this.redis.exists(key);
|
|
157
|
+
return value !== 0;
|
|
158
|
+
}
|
|
159
|
+
async disconnect() {
|
|
160
|
+
return this.redis.disconnect();
|
|
161
|
+
}
|
|
162
|
+
};
|
|
163
|
+
var src_default = KeyvRedis;
|
package/dist/index.d.cts
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import EventEmitter from 'events';
|
|
2
|
+
import { KeyvStoreAdapter, StoredData } from 'keyv';
|
|
3
|
+
import { Redis, Cluster } from 'ioredis';
|
|
4
|
+
|
|
5
|
+
type KeyvRedisOptions = {
|
|
6
|
+
[K in keyof Redis]?: Redis[K];
|
|
7
|
+
} & {
|
|
8
|
+
uri?: string;
|
|
9
|
+
dialect?: string;
|
|
10
|
+
useRedisSets?: boolean;
|
|
11
|
+
};
|
|
12
|
+
type KeyvUriOptions = string | KeyvRedisOptions | Redis | Cluster;
|
|
13
|
+
|
|
14
|
+
declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
|
|
15
|
+
ttlSupport: boolean;
|
|
16
|
+
namespace?: string;
|
|
17
|
+
opts: Record<string, unknown>;
|
|
18
|
+
redis: any;
|
|
19
|
+
constructor(uri: KeyvRedisOptions | KeyvUriOptions, options?: KeyvRedisOptions);
|
|
20
|
+
_getNamespace(): string;
|
|
21
|
+
_getKeyName: (key: string) => string;
|
|
22
|
+
get<Value>(key: string): Promise<StoredData<Value> | undefined>;
|
|
23
|
+
getMany<Value>(keys: string[]): Promise<Array<StoredData<Value | undefined>>>;
|
|
24
|
+
set(key: string, value: any, ttl?: number): Promise<undefined>;
|
|
25
|
+
delete(key: string): Promise<boolean>;
|
|
26
|
+
deleteMany(keys: string[]): Promise<boolean>;
|
|
27
|
+
clear(): Promise<void>;
|
|
28
|
+
iterator(namespace?: string): AsyncGenerator<any[], void, unknown>;
|
|
29
|
+
has(key: string): Promise<boolean>;
|
|
30
|
+
disconnect(): Promise<any>;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
export { KeyvRedis as default };
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,16 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
1
|
import EventEmitter from 'events';
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
2
|
+
import { KeyvStoreAdapter, StoredData } from 'keyv';
|
|
3
|
+
import { Redis, Cluster } from 'ioredis';
|
|
4
|
+
|
|
5
|
+
type KeyvRedisOptions = {
|
|
6
|
+
[K in keyof Redis]?: Redis[K];
|
|
7
|
+
} & {
|
|
8
|
+
uri?: string;
|
|
9
|
+
dialect?: string;
|
|
10
|
+
useRedisSets?: boolean;
|
|
11
|
+
};
|
|
12
|
+
type KeyvUriOptions = string | KeyvRedisOptions | Redis | Cluster;
|
|
13
|
+
|
|
5
14
|
declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
|
|
6
15
|
ttlSupport: boolean;
|
|
7
16
|
namespace?: string;
|
|
@@ -20,4 +29,5 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
|
|
|
20
29
|
has(key: string): Promise<boolean>;
|
|
21
30
|
disconnect(): Promise<any>;
|
|
22
31
|
}
|
|
23
|
-
|
|
32
|
+
|
|
33
|
+
export { KeyvRedis as default };
|
package/dist/index.js
CHANGED
|
@@ -1,139 +1,132 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
this.opts.dialect = 'redis';
|
|
20
|
-
if (typeof uri !== 'string' && uri.options && ('family' in uri.options || uri.isCluster)) {
|
|
21
|
-
this.redis = uri;
|
|
22
|
-
}
|
|
23
|
-
else {
|
|
24
|
-
options = { ...(typeof uri === 'string' ? { uri } : uri), ...options };
|
|
25
|
-
// @ts-expect-error - uri is a string or RedisOptions
|
|
26
|
-
this.redis = new ioredis_1.default(options.uri, options);
|
|
27
|
-
}
|
|
28
|
-
if (options !== undefined && options.useRedisSets === false) {
|
|
29
|
-
this.opts.useRedisSets = false;
|
|
30
|
-
}
|
|
31
|
-
this.redis.on('error', (error) => this.emit('error', error));
|
|
32
|
-
}
|
|
33
|
-
_getNamespace() {
|
|
34
|
-
return `namespace:${this.namespace}`;
|
|
1
|
+
// src/index.ts
|
|
2
|
+
import EventEmitter from "events";
|
|
3
|
+
import Redis from "ioredis";
|
|
4
|
+
var KeyvRedis = class extends EventEmitter {
|
|
5
|
+
ttlSupport = true;
|
|
6
|
+
namespace;
|
|
7
|
+
opts;
|
|
8
|
+
redis;
|
|
9
|
+
constructor(uri, options) {
|
|
10
|
+
super();
|
|
11
|
+
this.opts = {};
|
|
12
|
+
this.opts.useRedisSets = true;
|
|
13
|
+
this.opts.dialect = "redis";
|
|
14
|
+
if (typeof uri !== "string" && uri.options && ("family" in uri.options || uri.isCluster)) {
|
|
15
|
+
this.redis = uri;
|
|
16
|
+
} else {
|
|
17
|
+
options = { ...typeof uri === "string" ? { uri } : uri, ...options };
|
|
18
|
+
this.redis = new Redis(options.uri, options);
|
|
35
19
|
}
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
const value = await this.redis.get(key);
|
|
39
|
-
if (value === null) {
|
|
40
|
-
return undefined;
|
|
41
|
-
}
|
|
42
|
-
return value;
|
|
43
|
-
}
|
|
44
|
-
async getMany(keys) {
|
|
45
|
-
keys = keys.map(this._getKeyName);
|
|
46
|
-
return this.redis.mget(keys);
|
|
47
|
-
}
|
|
48
|
-
async set(key, value, ttl) {
|
|
49
|
-
if (value === undefined) {
|
|
50
|
-
return undefined;
|
|
51
|
-
}
|
|
52
|
-
key = this._getKeyName(key);
|
|
53
|
-
const set = async (redis) => {
|
|
54
|
-
if (typeof ttl === 'number') {
|
|
55
|
-
await redis.set(key, value, 'PX', ttl);
|
|
56
|
-
}
|
|
57
|
-
else {
|
|
58
|
-
await redis.set(key, value);
|
|
59
|
-
}
|
|
60
|
-
};
|
|
61
|
-
if (this.opts.useRedisSets) {
|
|
62
|
-
const trx = await this.redis.multi();
|
|
63
|
-
await set(trx);
|
|
64
|
-
await trx.sadd(this._getNamespace(), key);
|
|
65
|
-
await trx.exec();
|
|
66
|
-
}
|
|
67
|
-
else {
|
|
68
|
-
await set(this.redis);
|
|
69
|
-
}
|
|
20
|
+
if (options !== void 0 && options.useRedisSets === false) {
|
|
21
|
+
this.opts.useRedisSets = false;
|
|
70
22
|
}
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
const r = await trx.exec();
|
|
80
|
-
items = r[0][1];
|
|
81
|
-
}
|
|
82
|
-
else {
|
|
83
|
-
items = await unlink(this.redis);
|
|
84
|
-
}
|
|
85
|
-
return items > 0;
|
|
23
|
+
this.redis.on("error", (error) => this.emit("error", error));
|
|
24
|
+
}
|
|
25
|
+
_getNamespace() {
|
|
26
|
+
return `namespace:${this.namespace}`;
|
|
27
|
+
}
|
|
28
|
+
_getKeyName = (key) => {
|
|
29
|
+
if (!this.opts.useRedisSets) {
|
|
30
|
+
return `sets:${this._getNamespace()}:${key}`;
|
|
86
31
|
}
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
32
|
+
return key;
|
|
33
|
+
};
|
|
34
|
+
async get(key) {
|
|
35
|
+
key = this._getKeyName(key);
|
|
36
|
+
const value = await this.redis.get(key);
|
|
37
|
+
if (value === null) {
|
|
38
|
+
return void 0;
|
|
92
39
|
}
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
}
|
|
103
|
-
else {
|
|
104
|
-
const pattern = `sets:${this._getNamespace()}:*`;
|
|
105
|
-
const keys = await this.redis.keys(pattern);
|
|
106
|
-
if (keys.length > 0) {
|
|
107
|
-
await this.redis.unlink(keys);
|
|
108
|
-
}
|
|
109
|
-
}
|
|
40
|
+
return value;
|
|
41
|
+
}
|
|
42
|
+
async getMany(keys) {
|
|
43
|
+
keys = keys.map(this._getKeyName);
|
|
44
|
+
return this.redis.mget(keys);
|
|
45
|
+
}
|
|
46
|
+
async set(key, value, ttl) {
|
|
47
|
+
if (value === void 0) {
|
|
48
|
+
return void 0;
|
|
110
49
|
}
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
}
|
|
127
|
-
}
|
|
128
|
-
} while (cursor !== '0');
|
|
50
|
+
key = this._getKeyName(key);
|
|
51
|
+
const set = async (redis) => {
|
|
52
|
+
if (typeof ttl === "number") {
|
|
53
|
+
await redis.set(key, value, "PX", ttl);
|
|
54
|
+
} else {
|
|
55
|
+
await redis.set(key, value);
|
|
56
|
+
}
|
|
57
|
+
};
|
|
58
|
+
if (this.opts.useRedisSets) {
|
|
59
|
+
const trx = await this.redis.multi();
|
|
60
|
+
await set(trx);
|
|
61
|
+
await trx.sadd(this._getNamespace(), key);
|
|
62
|
+
await trx.exec();
|
|
63
|
+
} else {
|
|
64
|
+
await set(this.redis);
|
|
129
65
|
}
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
66
|
+
}
|
|
67
|
+
async delete(key) {
|
|
68
|
+
key = this._getKeyName(key);
|
|
69
|
+
let items = 0;
|
|
70
|
+
const unlink = async (redis) => redis.unlink(key);
|
|
71
|
+
if (this.opts.useRedisSets) {
|
|
72
|
+
const trx = this.redis.multi();
|
|
73
|
+
await unlink(trx);
|
|
74
|
+
await trx.srem(this._getNamespace(), key);
|
|
75
|
+
const r = await trx.exec();
|
|
76
|
+
items = r[0][1];
|
|
77
|
+
} else {
|
|
78
|
+
items = await unlink(this.redis);
|
|
133
79
|
}
|
|
134
|
-
|
|
135
|
-
|
|
80
|
+
return items > 0;
|
|
81
|
+
}
|
|
82
|
+
async deleteMany(keys) {
|
|
83
|
+
const deletePromises = keys.map(async (key) => this.delete(key));
|
|
84
|
+
const results = await Promise.allSettled(deletePromises);
|
|
85
|
+
return results.every((result) => result.value);
|
|
86
|
+
}
|
|
87
|
+
async clear() {
|
|
88
|
+
if (this.opts.useRedisSets) {
|
|
89
|
+
const keys = await this.redis.smembers(this._getNamespace());
|
|
90
|
+
if (keys.length > 0) {
|
|
91
|
+
await Promise.all([
|
|
92
|
+
this.redis.unlink([...keys]),
|
|
93
|
+
this.redis.srem(this._getNamespace(), [...keys])
|
|
94
|
+
]);
|
|
95
|
+
}
|
|
96
|
+
} else {
|
|
97
|
+
const pattern = `sets:${this._getNamespace()}:*`;
|
|
98
|
+
const keys = await this.redis.keys(pattern);
|
|
99
|
+
if (keys.length > 0) {
|
|
100
|
+
await this.redis.unlink(keys);
|
|
101
|
+
}
|
|
136
102
|
}
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
|
|
103
|
+
}
|
|
104
|
+
async *iterator(namespace) {
|
|
105
|
+
const scan = this.redis.scan.bind(this.redis);
|
|
106
|
+
const get = this.redis.mget.bind(this.redis);
|
|
107
|
+
let cursor = "0";
|
|
108
|
+
do {
|
|
109
|
+
const [curs, keys] = await scan(cursor, "MATCH", `${namespace}:*`);
|
|
110
|
+
cursor = curs;
|
|
111
|
+
if (keys.length > 0) {
|
|
112
|
+
const values = await get(keys);
|
|
113
|
+
for (const [i] of keys.entries()) {
|
|
114
|
+
const key = keys[i];
|
|
115
|
+
const value = values[i];
|
|
116
|
+
yield [key, value];
|
|
117
|
+
}
|
|
118
|
+
}
|
|
119
|
+
} while (cursor !== "0");
|
|
120
|
+
}
|
|
121
|
+
async has(key) {
|
|
122
|
+
const value = await this.redis.exists(key);
|
|
123
|
+
return value !== 0;
|
|
124
|
+
}
|
|
125
|
+
async disconnect() {
|
|
126
|
+
return this.redis.disconnect();
|
|
127
|
+
}
|
|
128
|
+
};
|
|
129
|
+
var src_default = KeyvRedis;
|
|
130
|
+
export {
|
|
131
|
+
src_default as default
|
|
132
|
+
};
|
package/package.json
CHANGED
|
@@ -1,11 +1,19 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@keyv/redis",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.1",
|
|
4
4
|
"description": "Redis storage adapter for Keyv",
|
|
5
|
-
"
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.cjs",
|
|
7
|
+
"module": "dist/index.js",
|
|
6
8
|
"types": "dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"require": "./dist/index.cjs",
|
|
12
|
+
"import": "./dist/index.js"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
7
15
|
"scripts": {
|
|
8
|
-
"build": "
|
|
16
|
+
"build": "rm -rf dist && tsup src/index.ts --format cjs,esm --dts --clean",
|
|
9
17
|
"prepare": "yarn build",
|
|
10
18
|
"test": "xo --fix && vitest run --coverage",
|
|
11
19
|
"test:ci": "xo && vitest --run --sequence.setupFiles=list",
|
|
@@ -13,6 +21,7 @@
|
|
|
13
21
|
},
|
|
14
22
|
"xo": {
|
|
15
23
|
"rules": {
|
|
24
|
+
"import/no-named-as-default": "off",
|
|
16
25
|
"unicorn/prefer-module": "off",
|
|
17
26
|
"unicorn/prefer-event-target": "off",
|
|
18
27
|
"unicorn/prefer-node-protocol": "off",
|
|
@@ -53,18 +62,19 @@
|
|
|
53
62
|
},
|
|
54
63
|
"devDependencies": {
|
|
55
64
|
"@keyv/test-suite": "*",
|
|
56
|
-
"keyv": "^5.0.0
|
|
65
|
+
"keyv": "^5.0.0",
|
|
57
66
|
"timekeeper": "^2.3.1",
|
|
58
|
-
"tsd": "^0.31.
|
|
59
|
-
"xo": "^0.
|
|
67
|
+
"tsd": "^0.31.1",
|
|
68
|
+
"xo": "^0.59.3"
|
|
60
69
|
},
|
|
61
70
|
"tsd": {
|
|
62
71
|
"directory": "test"
|
|
63
72
|
},
|
|
64
73
|
"engines": {
|
|
65
|
-
"node": ">=
|
|
74
|
+
"node": ">= 18"
|
|
66
75
|
},
|
|
67
76
|
"files": [
|
|
68
|
-
"dist"
|
|
77
|
+
"dist",
|
|
78
|
+
"LICENSE"
|
|
69
79
|
]
|
|
70
80
|
}
|
package/dist/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,oDAAkC;AAClC,sDAA4B;AAO5B,MAAM,SAAU,SAAQ,gBAAY;IAKnC,YAAY,GAAsC,EAAE,OAA0B;QAC7E,KAAK,EAAE,CAAC;QALT,eAAU,GAAG,IAAI,CAAC;QA6BlB,gBAAW,GAAG,CAAC,GAAW,EAAU,EAAE;YACrC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;gBAC7B,OAAO,QAAQ,IAAI,CAAC,aAAa,EAAE,IAAI,GAAG,EAAE,CAAC;YAC9C,CAAC;YAED,OAAO,GAAG,CAAC;QACZ,CAAC,CAAC;QA7BD,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5B,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,QAAQ,IAAI,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;YAC1F,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;QAClB,CAAC;aAAM,CAAC;YACP,OAAO,GAAG,EAAC,GAAG,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAC,GAAG,EAAC,CAAC,CAAC,CAAC,GAAuB,CAAC,EAAE,GAAG,OAAO,EAAC,CAAC;YACvF,qDAAqD;YACrD,IAAI,CAAC,KAAK,GAAG,IAAI,iBAAK,CAAC,OAAO,CAAC,GAAI,EAAE,OAAO,CAAC,CAAC;QAC/C,CAAC;QAED,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,YAAY,KAAK,KAAK,EAAE,CAAC;YAC7D,IAAI,CAAC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;QAChC,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,aAAa;QACZ,OAAO,aAAa,IAAI,CAAC,SAAU,EAAE,CAAC;IACvC,CAAC;IAUD,KAAK,CAAC,GAAG,CAAQ,GAAW;QAC3B,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACxC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACpB,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAQ,IAAc;QAClC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAClC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,GAAY;QAC9C,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAE5B,MAAM,GAAG,GAAG,KAAK,EAAE,KAAU,EAAE,EAAE;YAChC,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC7B,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;YACxC,CAAC;iBAAM,CAAC;gBACP,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAC7B,CAAC;QACF,CAAC,CAAC;QAEF,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACrC,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC;YACf,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,GAAG,CAAC,CAAC;YAC1C,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAClB,CAAC;aAAM,CAAC;YACP,MAAM,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACvB,CAAC;IACF,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACvB,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;QAC5B,IAAI,KAAK,GAAG,CAAC,CAAC;QACd,MAAM,MAAM,GAAG,KAAK,EAAE,KAAU,EAAE,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEvD,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YAC/B,MAAM,MAAM,CAAC,GAAG,CAAC,CAAC;YAClB,MAAM,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,GAAG,CAAC,CAAC;YAC1C,MAAM,CAAC,GAAG,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;YAC3B,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACjB,CAAC;aAAM,CAAC;YACP,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClC,CAAC;QAED,OAAO,KAAK,GAAG,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAc;QAC9B,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,KAAK,EAAC,GAAG,EAAC,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,cAAc,CAAC,CAAC;QACzD,0EAA0E;QAC1E,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC;IAED,KAAK,CAAC,KAAK;QACV,IAAI,IAAI,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAa,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;YACvE,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrB,MAAM,OAAO,CAAC,GAAG,CAAC;oBACjB,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;oBAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC;iBAChD,CAAC,CAAC;YACJ,CAAC;QACF,CAAC;aAAM,CAAC;YACP,MAAM,OAAO,GAAG,QAAQ,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC;YACjD,MAAM,IAAI,GAAa,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACtD,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrB,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;YAC/B,CAAC;QACF,CAAC;IACF,CAAC;IAED,KAAK,CAAC,CAAE,QAAQ,CAAC,SAAkB;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,IAAI,MAAM,GAAG,GAAG,CAAC;QACjB,GAAG,CAAC;YACH,4CAA4C;YAC5C,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,GAAG,SAAU,IAAI,CAAC,CAAC;YACpE,MAAM,GAAG,IAAI,CAAC;YACd,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACrB,4CAA4C;gBAC5C,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC/B,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;oBAClC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;oBACpB,MAAM,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;oBACxB,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;gBACpB,CAAC;YACF,CAAC;QACF,CAAC,QAAQ,MAAM,KAAK,GAAG,EAAE;IAC1B,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACpB,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACnD,OAAO,KAAK,KAAK,CAAC,CAAC;IACpB,CAAC;IAED,KAAK,CAAC,UAAU;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC;CACD;AAED,iBAAS,SAAS,CAAC"}
|
package/dist/types.d.ts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
import { type Redis, type Cluster } from 'ioredis';
|
|
2
|
-
export type KeyvRedisOptions = {
|
|
3
|
-
[K in keyof Redis]?: Redis[K];
|
|
4
|
-
} & {
|
|
5
|
-
uri?: string;
|
|
6
|
-
dialect?: string;
|
|
7
|
-
useRedisSets?: boolean;
|
|
8
|
-
};
|
|
9
|
-
export type KeyvUriOptions = string | KeyvRedisOptions | Redis | Cluster;
|
package/dist/types.js
DELETED
package/dist/types.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
|