keyv 4.2.8 → 4.3.1

package/README.md

@@ -7,7 +7,7 @@
 > Simple key-value storage with support for multiple backends
 
 [![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
-[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/master/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
 [![npm](https://img.shields.io/npm/dm/keyv.svg)](https://www.npmjs.com/package/keyv)
 [![npm](https://img.shields.io/npm/v/keyv.svg)](https://www.npmjs.com/package/keyv)
 
@@ -112,6 +112,7 @@ SQLite | [@keyv/sqlite](https://github.com/jaredwray/keyv/tree/master/packages/s
 PostgreSQL | [@keyv/postgres](https://github.com/jaredwray/keyv/tree/master/packages/postgres) | No 
 MySQL | [@keyv/mysql](https://github.com/jaredwray/keyv/tree/master/packages/mysql) | No 
 Etcd | [@keyv/etcd](https://github.com/jaredwray/keyv/tree/master/packages/etcd) | Yes
+Memcache | [@keyv/memcache](https://github.com/jaredwray/keyv/tree/master/packages/memcache) | Yes
 
 ## Third-party Storage Adapters
 
@@ -149,7 +150,6 @@ The following are third-party storage adapters compatible with Keyv:
 - [keyv-null](https://www.npmjs.com/package/keyv-null) - Null storage adapter for Keyv
 - [keyv-firestore ](https://github.com/goto-bus-stop/keyv-firestore) – Firebase Cloud Firestore adapter for Keyv
 - [keyv-mssql](https://github.com/pmorgan3/keyv-mssql) - Microsoft Sql Server adapter for Keyv
-- [keyv-memcache](https://github.com/jaredwray/keyv/tree/master/packages/memcache) - Memcache storage adapter for Keyv
 - [keyv-azuretable](https://github.com/howlowck/keyv-azuretable) - Azure Table Storage/API adapter for Keyv
 
 ## Add Cache Support to your Module
@@ -289,6 +289,19 @@ Delete all entries in the current namespace.
 
 Returns a promise which is resolved when the entries have been cleared.
 
+#### .iterator()
+
+Iterate over all entries of the current namespace.
+
+Returns a iterable that can be iterated by for-of loops. For example:
+
+```js
+// please note that the "await" keyword should be used here
+for await (const [key, value] of this.keyv.iterator()) {
+  console.log(key, value);
+};
+```
+
 # How to Contribute
 
 In this section of the documentation we will cover:
@@ -369,4 +382,4 @@ If you need more information on the steps to create a pull request, you can find
 
 ## License
 
-MIT © Jared Wray & Luke Childs
+MIT © Jared Wray

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "4.2.8",
+	"version": "4.3.1",
 	"description": "Simple key-value storage with support for multiple backends",
 	"main": "src/index.js",
 	"scripts": {
@@ -37,15 +37,15 @@
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^4.2.0",
+		"ava": "^4.3.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.4",
-		"xo": "^0.48.0"
+		"tsd": "^0.21.0",
+		"typescript": "^4.7.4",
+		"xo": "^0.50.0"
 	},
 	"tsd": {
 		"directory": "test"

package/src/index.d.ts

@@ -27,10 +27,19 @@ declare class Keyv<Value = any, Options extends Record<string, any> = Record<str
 	constructor(uri?: string, options?: Keyv.Options<Value> & Options);
 
 	/** Returns the value. */
-	get<Raw extends boolean = false>(key: string | string[], options?: {raw?: Raw}):
+	get<Raw extends boolean = false>(key: string, options?: {raw?: Raw}):
 	Promise<(Raw extends false
 		? Value
 		: Keyv.DeserializedData<Value>) | undefined>;
+
+	/** Returns an array of values. Uses `store.getMany` if it exists, otherwise uses parallel calls to `store.get`. */
+	get<Raw extends boolean = false>(
+		key: string[],
+		options?: {raw?: Raw}
+	): Promise<
+	Array<(Raw extends false ? Value : Keyv.DeserializedData<Value>) | undefined>
+	>;
+
 	/**
      * Set a value.
      *
@@ -48,7 +57,7 @@ declare class Keyv<Value = any, Options extends Record<string, any> = Record<str
 	/** Check if key exists in current namespace. */
 	has(key: string): Promise<boolean>;
 	/** Iterator */
-	iterator(namespace: string | undefined): AsyncGenerator<any, void, any>;
+	iterator(namespace?: string): AsyncGenerator<any, void, any>;
 	/**
 	 * Closes the connection.
 	 *
@@ -64,9 +73,9 @@ declare namespace Keyv {
 		/** Namespace for the current instance. */
 		namespace?: string | undefined;
 		/** A custom serialization function. */
-		serialize?: ((data: DeserializedData<Value>) => string) | undefined;
+		serialize?: ((data: DeserializedData<Value>) => string | Promise<string>) | undefined;
 		/** A custom deserialization function. */
-		deserialize?: ((data: string) => DeserializedData<Value> | undefined) | undefined;
+		deserialize?: ((data: string) => DeserializedData<Value> | undefined | Promise<DeserializedData<Value> | undefined>) | undefined;
 		/** The connection string URI. */
 		uri?: string | undefined;
 		/** The storage adapter instance to be used by Keyv. */
@@ -88,7 +97,7 @@ declare namespace Keyv {
 		set(key: string, value: Value, ttl?: number): any;
 		delete(key: string): boolean | Promise<boolean>;
 		clear(): void | Promise<void>;
-		has(key: string): boolean | Promise<boolean>;
+		has?(key: string): boolean | Promise<boolean>;
 	}
 }
 

package/src/index.js

@@ -7,6 +7,7 @@ const compressBrotli = require('compress-brotli');
 const loadStore = options => {
 	const adapters = {
 		redis: '@keyv/redis',
+		rediss: '@keyv/redis',
 		mongodb: '@keyv/mongo',
 		mongo: '@keyv/mongo',
 		sqlite: '@keyv/sqlite',
@@ -35,7 +36,7 @@ const iterableAdapters = [
 ];
 
 class Keyv extends EventEmitter {
-	constructor(uri, options) {
+	constructor(uri, {emitErrors = true, ...options} = {}) {
 		super();
 		this.opts = {
 			namespace: 'keyv',
@@ -59,7 +60,7 @@ class Keyv extends EventEmitter {
 			};
 		}
 
-		if (typeof this.opts.store.on === 'function') {
+		if (typeof this.opts.store.on === 'function' && emitErrors) {
 			this.opts.store.on('error', error => this.emit('error', error));
 		}