keyv 4.3.3 → 4.5.0

package/README.md

@@ -187,6 +187,20 @@ const awesomeModule = new AwesomeModule({ cache: 'redis://localhost' });
 const awesomeModule = new AwesomeModule({ cache: some3rdPartyStore });
 ```
 
+## Compression
+
+Keyv supports `gzip` and `brotli` compression. To enable compression, pass the `compress` option to the constructor.
+
+```js
+const KeyvGzip = require('@keyv/compress-gzip');
+const Keyv = require('keyv');
+
+const keyvGzip = new KeyvGzip();;
+const keyv = new Keyv({ compression: KeyvGzip });
+```
+
+You can also pass a custom compression function to the `compression` option. Following the pattern of the official compression adapters.
+
 ## API
 
 ### new Keyv([uri], [options])
@@ -224,6 +238,13 @@ Default: `undefined`
 
 Default TTL. Can be overridden by specififying a TTL on `.set()`.
 
+#### options.compression
+
+Type: `@keyv/compress-<compression_package_name>`<br>
+Default: `undefined`
+
+Compression package to use. See [Compression](#compression) for more details.
+
 #### options.serialize
 
 Type: `Function`<br>
@@ -315,7 +336,6 @@ In this section of the documentation we will cover:
 This package requires the following dependencies to run:
 
 1) [Yarn V1](https://yarnpkg.com/getting-started/install)
-2) [Lerna](https://lerna.js.org/)
 3) [Docker](https://docs.docker.com/get-docker/)
 
 ## Setting up your workspace
@@ -337,7 +357,7 @@ Once the project is installed locally, you are ready to start up its services:
 
 ## Available Commands
 
-Once the project is running, you can execute a variety of commands. The root workspace and each subpackage contain a `package.json` file with a  `scripts` field listing all the commands that can be executed from that directory. This project also supports native `yarn`, `lerna`, and `docker` commands.
+Once the project is running, you can execute a variety of commands. The root workspace and each subpackage contain a `package.json` file with a  `scripts` field listing all the commands that can be executed from that directory. This project also supports native `yarn`, and `docker` commands.
 
 Here, we'll cover the primary commands that can be executed from the root directory. Unless otherwise noted, these commands can also be executed from a subpackage. If executed from a subpackage, they will only affect that subpackage, rather than the entire workspace.
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "keyv",
-	"version": "4.3.3",
+	"version": "4.5.0",
 	"description": "Simple key-value storage with support for multiple backends",
 	"main": "src/index.js",
 	"scripts": {
@@ -32,7 +32,6 @@
 	},
 	"homepage": "https://github.com/jaredwray/keyv",
 	"dependencies": {
-		"compress-brotli": "^1.3.8",
 		"json-buffer": "3.0.1"
 	},
 	"devDependencies": {
@@ -46,7 +45,7 @@
 		"timekeeper": "^2.2.0",
 		"tsd": "^0.22.0",
 		"typescript": "^4.7.4",
-		"xo": "^0.50.0"
+		"xo": "^0.51.0"
 	},
 	"tsd": {
 		"directory": "test"

package/src/index.d.ts

@@ -79,7 +79,7 @@ declare namespace Keyv {
 		/** The connection string URI. */
 		uri?: string | undefined;
 		/** The storage adapter instance to be used by Keyv. */
-		store?: Store<Value> | undefined;
+		store?: Store<string | undefined> | 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'`. */

package/src/index.js

@@ -2,7 +2,6 @@
 
 const EventEmitter = require('events');
 const JSONB = require('json-buffer');
-const compressBrotli = require('compress-brotli');
 
 const loadStore = options => {
 	const adapters = {
@@ -51,13 +50,11 @@ class Keyv extends EventEmitter {
 			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.deserialize = async data => {
-				const {value, expires} = brotli.deserialize(data);
-				return {value: await brotli.decompress(value), expires};
-			};
+		if (this.opts.compression) {
+			const compression = this.opts.compression;
+			const {serialize, deserialize} = compression.opts;
+			this.opts.serialize = serialize;
+			this.opts.deserialize = deserialize;
 		}
 
 		if (typeof this.opts.store.on === 'function' && emitErrors) {
@@ -144,7 +141,7 @@ class Keyv extends EventEmitter {
 						data.push(value.value);
 					}
 
-					return data.every(x => x === undefined) ? [] : data;
+					return data;
 				});
 		}
 
@@ -159,10 +156,6 @@ class Keyv extends EventEmitter {
 				if (isArray) {
 					const result = [];
 
-					if (data.length === 0) {
-						return [];
-					}
-
 					for (let row of data) {
 						if ((typeof row === 'string')) {
 							row = this.opts.deserialize(row);
@@ -181,7 +174,7 @@ class Keyv extends EventEmitter {
 						}
 					}
 
-					return result.every(x => x === undefined) ? [] : result;
+					return result;
 				}
 
 				if (typeof data.expires === 'number' && Date.now() > data.expires) {