@keyv/compress-gzip 1.0.1 → 1.1.2

package/README.md

@@ -1,4 +1,4 @@
-# @keyv/tiered [<img width="100" align="right" src="https://rawgit.com/lukechilds/keyv/master/media/logo.svg" alt="keyv">](https://github.com/lukechilds/keyv)
+# @keyv/compress-gzip [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwray/keyv)
 
 > Gzip compression for Keyv
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/compress-gzip",
-  "version": "1.0.1",
+  "version": "1.1.2",
   "description": "gzip compression for keyv",
   "main": "src/index.js",
   "scripts": {
@@ -14,6 +14,16 @@
       "unicorn/prefer-node-protocol": 0
     }
   },
+  "ava": {
+    "require": [
+      "requirable",
+      "ts-node/register"
+    ],
+    "extensions": [
+      "js",
+      "ts"
+    ]
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jaredwray/keyv.git"
@@ -37,20 +47,21 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
+    "@types/pako": "^2.0.0",
     "json-buffer": "^3.0.1",
     "pako": "^2.0.4"
   },
   "devDependencies": {
+    "@keyv/test-suite": "*",
     "@types/keyv": "^3.1.4",
-    "ava": "^4.2.0",
+    "ava": "^5.0.1",
     "keyv": "*",
     "nyc": "^15.1.0",
     "requirable": "^1.0.5",
-    "this": "^1.1.0",
-    "ts-node": "^10.8.2",
-    "tsd": "^0.20.0",
-    "typescript": "^4.6.4",
-    "xo": "^0.48.0"
+    "ts-node": "^10.9.1",
+    "tsd": "^0.24.1",
+    "typescript": "^4.8.4",
+    "xo": "^0.52.4"
   },
   "tsd": {
     "directory": "test"

package/src/index.d.ts

@@ -1,19 +1,13 @@
-import {EventEmitter} from 'node:events';
-import {Store, StoredData} from 'keyv';
+import type pako from 'pako';
 
-declare class KeyvGzip extends EventEmitter {
-	ttlSupport: any;
+declare class KeyvGzip {
 	opts: any;
-	constructor(options?: string | KeyvGzip.Options);
-	compress(value: Value);
-	decompress(value: Value);
-}
-
-declare namespace KeyvGzip {
-	interface Options {
-		compress: (...args: any[]) => void;
-		decompress: (...args: any[]) => void;
-	}
+	constructor(options?: pako.DeflateFunctionOptions | pako.InflateFunctionOptions);
+	compress(value: pako.Data | string, options?: pako.DeflateFunctionOptions): Promise<Uint8Array>;
+	decompress(value: pako.Data, options?: pako.InflateFunctionOptions & {to: 'string'}): Promise<string>;
+	decompress(value: pako.Data, options?: pako.InflateFunctionOptions): Promise<Uint8Array>;
+	serialize(value: any): Promise<any>;
+	deserialize(value: any): Promise<any>;
 }
 
 export = KeyvGzip;

package/src/index.js

@@ -7,23 +7,23 @@ class KeyvGzip {
 			to: 'string',
 			...options,
 		};
+	}
 
-		this.opts.compress = pako.deflate;
-		this.opts.decompress = pako.inflate;
-		this.opts.serialize = async ({value, expires}) => JSONB.stringify({value: await this.opts.compress(value, this.opts), expires});
-		this.opts.deserialize = async data => {
-			const {value, expires} = JSONB.parse(data);
-			const value_ = await this.opts.decompress(value, this.opts);
-			return {value: value_, expires};
-		};
+	async compress(value, options) {
+		return pako.deflate(value, options ? options : this.opts);
+	}
+
+	async decompress(value, options) {
+		return pako.inflate(value, options ? options : this.opts);
 	}
 
-	compress(value, options) {
-		return this.opts.compress(value, {...this.opts, ...options});
+	async serialize({value, expires}) {
+		return JSONB.stringify({value: await this.compress(value, this.opts), expires});
 	}
 
-	decompress(value, options) {
-		return this.opts.decompress(value, {...this.opts, ...options});
+	async deserialize(data) {
+		const {value, expires} = JSONB.parse(data);
+		return {value: await this.decompress(value, this.opts), expires};
 	}
 }