@keyv/redis 2.5.8 → 2.6.0

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+import { type ClearOutput, type DeleteManyOutput, type DeleteOutput, type DisconnectOutput, type GetManyOutput, type GetOutput, type HasOutput, type IteratorOutput, type KeyvRedisOptions, type KeyvUriOptions, type SetOutput } from './types';
+declare class KeyvRedis<Value = any> extends EventEmitter {
+    ttlSupport: boolean;
+    namespace?: string;
+    opts: Record<string, unknown>;
+    redis: any;
+    constructor(uri: KeyvRedisOptions | KeyvUriOptions, options?: KeyvRedisOptions);
+    _getNamespace(): string;
+    get(key: string): GetOutput<Value>;
+    getMany(keys: string[]): GetManyOutput<Value>;
+    set(key: string, value: Value, ttl?: number): SetOutput;
+    delete(key: string): DeleteOutput;
+    deleteMany(key: string): DeleteManyOutput;
+    clear(): ClearOutput;
+    iterator(namespace?: string): IteratorOutput;
+    has(key: string): HasOutput;
+    disconnect(): DisconnectOutput;
+}
+export = KeyvRedis;

package/dist/index.js

@@ -0,0 +1,89 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const events_1 = __importDefault(require("events"));
+const ioredis_1 = __importDefault(require("ioredis"));
+class KeyvRedis extends events_1.default {
+    constructor(uri, options) {
+        super();
+        this.ttlSupport = true;
+        this.opts = {};
+        this.opts.dialect = 'redis';
+        if (uri instanceof ioredis_1.default) {
+            this.redis = uri;
+        }
+        else {
+            options = { ...(typeof uri === 'string' ? { uri } : uri), ...options };
+            // @ts-expect-error - uri is a string or RedisOptions
+            this.redis = new ioredis_1.default(options.uri, options);
+        }
+        this.redis.on('error', (error) => this.emit('error', error));
+    }
+    _getNamespace() {
+        return `namespace:${this.namespace}`;
+    }
+    async get(key) {
+        const value = await this.redis.get(key);
+        if (value === null) {
+            return undefined;
+        }
+        return value;
+    }
+    async getMany(keys) {
+        const rows = await this.redis.mget(keys);
+        return rows;
+    }
+    async set(key, value, ttl) {
+        if (value === undefined) {
+            return undefined;
+        }
+        if (typeof ttl === 'number') {
+            await this.redis.set(key, value, 'PX', ttl);
+        }
+        else {
+            await this.redis.set(key, value);
+        }
+        await this.redis.sadd(this._getNamespace(), key);
+    }
+    async delete(key) {
+        const items = await this.redis.del(key);
+        await this.redis.srem(this._getNamespace(), key);
+        return items > 0;
+    }
+    async deleteMany(key) {
+        return this.delete(key);
+    }
+    async clear() {
+        const keys = await this.redis.smembers(this._getNamespace());
+        await this.redis.del([...keys, this._getNamespace()]);
+    }
+    async *iterator(namespace) {
+        const scan = this.redis.scan.bind(this.redis);
+        const get = this.redis.mget.bind(this.redis);
+        let cursor = '0';
+        do {
+            // eslint-disable-next-line no-await-in-loop
+            const [curs, keys] = await scan(cursor, 'MATCH', `${namespace}:*`);
+            cursor = curs;
+            if (keys.length > 0) {
+                // eslint-disable-next-line no-await-in-loop
+                const values = await get(keys);
+                for (const [i] of keys.entries()) {
+                    const key = keys[i];
+                    const value = values[i];
+                    yield [key, value];
+                }
+            }
+        } while (cursor !== '0');
+    }
+    async has(key) {
+        const value = await this.redis.exists(key);
+        return value !== 0;
+    }
+    async disconnect() {
+        return this.redis.disconnect();
+    }
+}
+module.exports = KeyvRedis;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,oDAAkC;AAClC,sDAA4B;AAa5B,MAAM,SAAuB,SAAQ,gBAAY;IAKhD,YAAY,GAAsC,EAAE,OAA0B;QAC7E,KAAK,EAAE,CAAC;QALT,eAAU,GAAG,IAAI,CAAC;QAMjB,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QACf,IAAI,CAAC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAE5B,IAAI,GAAG,YAAY,iBAAK,EAAE;YACzB,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;SACjB;aAAM;YACN,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;SAC9C;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;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACpB,MAAM,KAAK,GAAU,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC/C,IAAI,KAAK,KAAK,IAAI,EAAE;YACnB,OAAO,SAAS,CAAC;SACjB;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAc;QAC3B,MAAM,IAAI,GAA6B,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnE,OAAO,IAAI,CAAC;IACb,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAY,EAAE,GAAY;QAChD,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,OAAO,SAAS,CAAC;SACjB;QAED,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC5B,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;SAC5C;aAAM;YACN,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;SACjC;QAED,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACvB,MAAM,KAAK,GAAW,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAChD,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,GAAG,CAAC,CAAC;QACjD,OAAO,KAAK,GAAG,CAAC,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,GAAW;QAC3B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,KAAK;QACV,MAAM,IAAI,GAAa,MAAM,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACvE,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC,CAAC;IACvD,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;YACF,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;gBACpB,4CAA4C;gBAC5C,MAAM,MAAM,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC/B,KAAK,MAAM,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;oBACjC,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;iBACnB;aACD;SACD,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

@@ -0,0 +1,19 @@
+import type { StoredData } from 'keyv';
+import { type Cluster } from 'ioredis';
+import type Redis from 'ioredis';
+export type KeyvRedisOptions = {
+    [K in keyof Redis]?: Redis[K];
+} & {
+    uri?: string;
+    dialect?: string;
+};
+export type KeyvUriOptions = string | KeyvRedisOptions | Redis | Cluster;
+export type IteratorOutput = AsyncGenerator<any, void, any>;
+export type GetOutput<Value> = Promise<Value | undefined>;
+export type GetManyOutput<Value> = Promise<Array<StoredData<Value | undefined>>>;
+export type SetOutput = Promise<any>;
+export type DeleteOutput = Promise<boolean>;
+export type DeleteManyOutput = Promise<boolean>;
+export type ClearOutput = Promise<void>;
+export type HasOutput = Promise<boolean>;
+export type DisconnectOutput = Promise<void>;

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,10 +1,11 @@
 {
 	"name": "@keyv/redis",
-	"version": "2.5.8",
+	"version": "2.6.0",
 	"description": "Redis storage adapter for Keyv",
-	"main": "src/index.js",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"scripts": {
-		"build": "echo 'No build step required.'",
+		"build": "tsc --project tsconfig.dist.json",
 		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
@@ -14,6 +15,12 @@
 		"rules": {
 			"unicorn/prefer-module": 0,
 			"unicorn/prefer-node-protocol": 0,
+			"unicorn/no-typeof-undefined": 0,
+			"import/extensions": 0,
+			"@typescript-eslint/no-unsafe-call": 0,
+			"@typescript-eslint/no-unsafe-assignment": 0,
+			"@typescript-eslint/no-unsafe-return": 0,
+			"unicorn/prefer-ternary": 0,
 			"ava/no-ignored-test-files": [
 				"error",
 				{
@@ -61,25 +68,19 @@
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^5.2.0",
-		"c8": "^7.13.0",
-		"delay": "^5.0.0",
+		"delay": "^6.0.0",
 		"keyv": "*",
 		"requirable": "^1.0.5",
 		"timekeeper": "^2.2.0",
-		"ts-node": "^10.9.1",
-		"tsd": "^0.28.1",
-		"typescript": "^5.0.4",
-		"xo": "^0.54.2"
+		"tsd": "^0.28.1"
 	},
 	"tsd": {
 		"directory": "test"
 	},
-	"types": "./src/index.d.ts",
 	"engines": {
-		"node": ">= 12"
+		"node": ">= 14"
 	},
 	"files": [
-		"src"
+		"dist"
 	]
 }

package/src/index.d.ts

@@ -1,31 +0,0 @@
-/* eslint-disable @typescript-eslint/consistent-type-definitions */
-import {EventEmitter} from 'events';
-import type{Store, StoredData} from 'keyv';
-import type{Redis, Cluster} from 'ioredis';
-
-declare class KeyvRedis<Value=any> extends EventEmitter implements Store<Value> {
-	readonly ttlSupport: false;
-	namespace?: string | undefined;
-	opts: Record<string, unknown>;
-	redis: any;
-	constructor(options?: KeyvRedis.Options | Redis | Cluster);
-	constructor(uri: string | Redis | Cluster, options?: KeyvRedis.Options);
-	get(key: string): Promise<Value>;
-	getMany?(
-		keys: string[]
-	): Array<StoredData<Value>> | Promise<Array<StoredData<Value>>> | undefined;
-	set(key: string, value: Value, ttl?: number): any;
-	delete(key: string): boolean | Promise<boolean>;
-	deleteMany(keys: string[]): boolean;
-	clear(): void | Promise<void>;
-	iterator(namespace: string | undefined): AsyncGenerator<any, void, any>;
-	has?(key: string): boolean | Promise<boolean>;
-	disconnect(): void;
-}
-declare namespace KeyvRedis {
-	interface Options {
-		uri?: string | undefined;
-		dialect?: string | undefined;
-	}
-}
-export = KeyvRedis;

package/src/index.js

@@ -1,107 +0,0 @@
-const EventEmitter = require('events');
-const Redis = require('ioredis');
-
-class KeyvRedis extends EventEmitter {
-	constructor(uri, options) {
-		super();
-		this.ttlSupport = true;
-		this.opts = {};
-		this.opts.dialect = 'redis';
-
-		if ((uri.options && uri.options.family) || (uri.options && uri.isCluster)) {
-			this.redis = uri;
-		} else {
-			options = {...(typeof uri === 'string' ? {uri} : uri), ...options};
-			this.redis = new Redis(options.uri, options);
-		}
-
-		this.redis.on('error', error => this.emit('error', error));
-	}
-
-	_getNamespace() {
-		return `namespace:${this.namespace}`;
-	}
-
-	get(key) {
-		return this.redis.get(key)
-			.then(value => {
-				if (value === null) {
-					return undefined;
-				}
-
-				return value;
-			});
-	}
-
-	getMany(keys) {
-		return this.redis.mget(keys)
-			.then(rows => rows);
-	}
-
-	set(key, value, ttl) {
-		if (value === undefined) {
-			return Promise.resolve(undefined);
-		}
-
-		return Promise.resolve()
-			.then(() => {
-				if (typeof ttl === 'number') {
-					return this.redis.set(key, value, 'PX', ttl);
-				}
-
-				return this.redis.set(key, value);
-			})
-			.then(() => this.redis.sadd(this._getNamespace(), key))
-			.then(() => undefined);
-	}
-
-	delete(key) {
-		return this.redis.del(key)
-			.then(items => this.redis.srem(this._getNamespace(), key)
-				.then(() => items > 0));
-	}
-
-	deleteMany(key) {
-		return this.delete(key);
-	}
-
-	clear() {
-		return this.redis.smembers(this._getNamespace())
-			.then(keys => this.redis.del([...keys, this._getNamespace()]))
-			.then(() => undefined);
-	}
-
-	async * iterator(namespace) {
-		const scan = this.redis.scan.bind(this.redis);
-		const get = this.redis.mget.bind(this.redis);
-		async function * iterate(curs, pattern) {
-			const [cursor, keys] = await scan(curs, 'MATCH', pattern);
-
-			if (keys.length > 0) {
-				const values = await get(keys);
-				for (const [i] of keys.entries()) {
-					const key = keys[i];
-					const value = values[i];
-					yield [key, value];
-				}
-			}
-
-			if (cursor !== '0') {
-				yield * iterate(cursor, pattern);
-			}
-		}
-
-		yield * iterate(0, `${namespace}:*`);
-	}
-
-	has(key) {
-		return this.redis.exists(key)
-			.then(value => value !== 0);
-	}
-
-	disconnect() {
-		return this.redis.disconnect();
-	}
-}
-
-module.exports = KeyvRedis;