keyv 4.2.0 → 4.2.5

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "4.2.0",
+	"version": "4.2.5",
 	"description": "Simple key-value storage with support for multiple backends",
 	"main": "src/index.js",
 	"scripts": {
@@ -9,9 +9,9 @@
 		"clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov && rm -rf ./test/testdb.sqlite"
 	},
 	"xo": {
-		"extends": "xo-lukechilds",
 		"rules": {
-			"unicorn/prefer-module": 0
+			"unicorn/prefer-module": 0,
+			"unicorn/prefer-node-protocol": 0
 		}
 	},
 	"repository": {
@@ -32,20 +32,19 @@
 	},
 	"homepage": "https://github.com/jaredwray/keyv",
 	"dependencies": {
-		"compress-brotli": "^1.3.6",
+		"compress-brotli": "^1.3.8",
 		"json-buffer": "3.0.1"
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^4.1.0",
-		"eslint-config-xo-lukechilds": "^1.0.1",
+		"ava": "^4.2.0",
 		"eslint-plugin-promise": "^6.0.0",
 		"nyc": "^15.1.0",
 		"pify": "5.0.0",
 		"this": "^1.1.0",
 		"timekeeper": "^2.2.0",
 		"tsd": "^0.20.0",
-		"typescript": "^4.6.3",
+		"typescript": "^4.6.4",
 		"xo": "^0.48.0"
     },
     "tsd" : {

package/src/index.d.ts

@@ -1,20 +1,88 @@
-import EventEmitter from 'node:events';
+import {EventEmitter} from 'events';
 
-declare class Keyv extends EventEmitter {
-	constructor(uri: string, options: Keyv.Options);
-	get(key: string, options: any): Promise<any>;
-	set(key: string, value: any, ttl: number): Promise<boolean>;
-	delete(key: string): Promise<boolean>;
+type WithRequiredProperties<T, K extends keyof T> = T & Required<Pick<T, K>>;
+
+declare class Keyv<Value = any, Options extends Record<string, any> = Record<string, unknown>> extends EventEmitter {
+	/**
+     * `this.opts` is an object containing at least the properties listed
+     * below. However, `Keyv.Options` allows arbitrary properties as well.
+     * These properties can be specified as the second type parameter to `Keyv`.
+     */
+	opts: WithRequiredProperties<
+	Keyv.Options<Value>,
+	'deserialize' | 'namespace' | 'serialize' | 'store' | 'uri'
+	> &
+	Options;
+
+	/**
+     * @param opts The options object is also passed through to the storage adapter. Check your storage adapter docs for any extra options.
+     */
+	constructor(options?: Keyv.Options<Value> & Options);
+	/**
+     * @param uri The connection string URI.
+     *
+     * Merged into the options object as options.uri.
+     * @param opts The options object is also passed through to the storage adapter. Check your storage adapter docs for any extra options.
+     */
+	constructor(uri?: string, options?: Keyv.Options<Value> & Options);
+
+	/** Returns the value. */
+	get<Raw extends boolean = false>(key: string | string[] = [], options?: {raw?: Raw}):
+	Promise<(Raw extends false
+		? Value
+		: Keyv.DeserializedData<Value>) | undefined>;
+	/**
+     * Set a value.
+     *
+     * By default keys are persistent. You can set an expiry TTL in milliseconds.
+     */
+	set(key: string, value: Value, ttl?: number): Promise<true>;
+	/**
+     * Deletes an entry.
+     *
+     * Returns `true` if the key existed, `false` if not.
+     */
+	delete(key: string | string[] = []): Promise<boolean>;
+	/** Delete all entries in the current namespace. */
 	clear(): Promise<void>;
+	/** Check if key exists in current namespace. */
 	has(key: string): Promise<boolean>;
+	/** Iterator */
+	iterator(namespace: string | undefined): AsyncGenerator<any, void, any>;
 }
 
 declare namespace Keyv {
-	interface Options {
+	interface Options<Value> {
+		[key: string]: any;
+
+		/** Namespace for the current instance. */
 		namespace?: string | undefined;
-		serialize?: ((data: any) => string) | undefined;
-		deserialize?: ((data: string) => any | undefined) | undefined;
+		/** A custom serialization function. */
+		serialize?: ((data: DeserializedData<Value>) => string) | undefined;
+		/** A custom deserialization function. */
+		deserialize?: ((data: string) => DeserializedData<Value> | undefined) | undefined;
+		/** The connection string URI. */
+		uri?: string | undefined;
+		/** The storage adapter instance to be used by Keyv. */
+		store?: Store<Value> | undefined;
+		/** Default TTL. Can be overridden by specififying a TTL on `.set()`. */
 		ttl?: number | undefined;
+		/** Specify an adapter to use. e.g `'redis'` or `'mongodb'`. */
+		adapter?: 'redis' | 'mongodb' | 'mongo' | 'sqlite' | 'postgresql' | 'postgres' | 'mysql' | undefined;
+		/** Enable compression option **/
+		compress?: Record<string, unknown> | undefined;
+	}
+
+	interface DeserializedData<Value> {
+		value: Value; expires: number | undefined;
+	}
+
+	interface Store<Value> {
+		get(key: string): Value | Promise<Value | undefined> | undefined;
+		set(key: string, value: Value, ttl?: number): any;
+		delete(key: string): boolean | Promise<boolean>;
+		clear(): void | Promise<void>;
+		has(key: string): boolean | Promise<boolean>;
 	}
 }
 

package/src/index.js

@@ -14,9 +14,11 @@ const loadStore = options => {
 		postgres: '@keyv/postgres',
 		mysql: '@keyv/mysql',
 		etcd: '@keyv/etcd',
+		offline: '@keyv/offline',
+		tiered: '@keyv/tiered',
 	};
 	if (options.adapter || options.uri) {
-		const adapter = options.adapter || /^[^:]*/.exec(options.uri)[0];
+		const adapter = options.adapter || /^[^:+]*/.exec(options.uri)[0];
 		return new (require(adapters[adapter]))(options);
 	}
 
@@ -29,6 +31,7 @@ const iterableAdapters = [
 	'mysql',
 	'mongo',
 	'redis',
+	'tiered',
 ];
 
 class Keyv extends EventEmitter {
@@ -38,21 +41,21 @@ class Keyv extends EventEmitter {
 			namespace: 'keyv',
 			serialize: JSONB.stringify,
 			deserialize: JSONB.parse,
-			...((typeof uri === 'string') ? { uri } : uri),
+			...((typeof uri === 'string') ? {uri} : uri),
 			...options,
 		};
 
 		if (!this.opts.store) {
-			const adapterOptions = { ...this.opts };
+			const adapterOptions = {...this.opts};
 			this.opts.store = loadStore(adapterOptions);
 		}
 
 		if (this.opts.compress) {
 			const brotli = compressBrotli(this.opts.compress.opts);
-			this.opts.serialize = async ({ value, expires }) => brotli.serialize({ value: await brotli.compress(value), expires });
+			this.opts.serialize = async ({value, expires}) => brotli.serialize({value: await brotli.compress(value), expires});
 			this.opts.deserialize = async data => {
-				const { value, expires } = brotli.deserialize(data);
-				return { value: await brotli.decompress(value), expires };
+				const {value, expires} = brotli.deserialize(data);
+				return {value: await brotli.decompress(value), expires};
 			};
 		}
 
@@ -62,24 +65,23 @@ class Keyv extends EventEmitter {
 
 		this.opts.store.namespace = this.opts.namespace;
 
-		const generateIterator = iterator =>
-			async function * () {
-				for await (const [key, raw] of typeof iterator === 'function'
-					? iterator(this.opts.store.namespace)
-					: iterator) {
-					const data = typeof raw === 'string' ? this.opts.deserialize(raw) : raw;
-					if (this.opts.store.namespace && !key.includes(this.opts.store.namespace)) {
-						continue;
-					}
-
-					if (typeof data.expires === 'number' && Date.now() > data.expires) {
-						this.delete(key);
-						continue;
-					}
+		const generateIterator = iterator => async function * () {
+			for await (const [key, raw] of typeof iterator === 'function'
+				? iterator(this.opts.store.namespace)
+				: iterator) {
+				const data = this.opts.deserialize(raw);
+				if (this.opts.store.namespace && !key.includes(this.opts.store.namespace)) {
+					continue;
+				}
 
-					yield [this._getKeyUnprefix(key), data.value];
+				if (typeof data.expires === 'number' && Date.now() > data.expires) {
+					this.delete(key);
+					continue;
 				}
-			};
+
+				yield [this._getKeyUnprefix(key), data.value];
+			}
+		};
 
 		// Attach iterators
 		if (typeof this.opts.store[Symbol.iterator] === 'function' && this.opts.store instanceof Map) {
@@ -104,16 +106,14 @@ class Keyv extends EventEmitter {
 	}
 
 	_getKeyUnprefix(key) {
-		return this.opts.store.namespace
-			? key
-				.split(':')
-				.splice(1)
-				.join(':')
-			: key;
+		return key
+			.split(':')
+			.splice(1)
+			.join(':');
 	}
 
 	get(key, options) {
-		const { store } = this.opts;
+		const {store} = this.opts;
 		const isArray = Array.isArray(key);
 		const keyPrefixed = isArray ? this._getKeyPrefixArray(key) : this._getKeyPrefix(key);
 		if (isArray && store.getMany === undefined) {
@@ -151,13 +151,13 @@ class Keyv extends EventEmitter {
 			.then(() => isArray ? store.getMany(keyPrefixed) : store.get(keyPrefixed))
 			.then(data => (typeof data === 'string') ? this.opts.deserialize(data) : data)
 			.then(data => {
-				// Console.log('get', data);
 				if (data === undefined || data === null) {
 					return undefined;
 				}
 
 				if (isArray) {
 					const result = [];
+
 					if (data.length === 0) {
 						return [];
 					}
@@ -201,7 +201,7 @@ class Keyv extends EventEmitter {
 			ttl = undefined;
 		}
 
-		const { store } = this.opts;
+		const {store} = this.opts;
 
 		return Promise.resolve()
 			.then(() => {
@@ -210,7 +210,7 @@ class Keyv extends EventEmitter {
 					this.emit('error', 'symbol cannot be serialized');
 				}
 
-				value = { value, expires };
+				value = {value, expires};
 				return this.opts.serialize(value);
 			})
 			.then(value => store.set(keyPrefixed, value, ttl))
@@ -218,7 +218,7 @@ class Keyv extends EventEmitter {
 	}
 
 	delete(key) {
-		const { store } = this.opts;
+		const {store} = this.opts;
 		if (Array.isArray(key)) {
 			const keyPrefixed = this._getKeyPrefixArray(key);
 			if (store.deleteMany === undefined) {
@@ -241,14 +241,14 @@ class Keyv extends EventEmitter {
 	}
 
 	clear() {
-		const { store } = this.opts;
+		const {store} = this.opts;
 		return Promise.resolve()
 			.then(() => store.clear());
 	}
 
 	has(key) {
 		const keyPrefixed = this._getKeyPrefix(key);
-		const { store } = this.opts;
+		const {store} = this.opts;
 		return Promise.resolve()
 			.then(async () => {
 				if (typeof store.has === 'function') {
@@ -259,6 +259,13 @@ class Keyv extends EventEmitter {
 				return value !== undefined;
 			});
 	}
+
+	disconnect() {
+		const {store} = this.opts;
+		if (typeof store.disconnect === 'function') {
+			return store.disconnect();
+		}
+	}
 }
 
 module.exports = Keyv;