diff --git a/README.md b/README.md index 4afc7e58f..dbd9a82cc 100644 --- a/README.md +++ b/README.md @@ -79,9 +79,9 @@ If there is already an adapter that you would like to add, please post an issue ### Compression Adapters -* [brotli](https://github.com/jaredwray/keyv/tree/main/packages/compress-brotli): Brotli compression adapter -* [Gzip](https://github.com/jaredwray/keyv/tree/main/packages/compress-gzip): Gzip compression adapter -* [lz4](https://github.com/jaredwray/keyv/tree/main/packages/compress-lz4): lz4-napi compression adapter +* [brotli](https://github.com/jaredwray/keyv/tree/main/packages/compress-brotli): brotli compression adapter +* [gzip](https://github.com/jaredwray/keyv/tree/main/packages/compress-gzip): gzip compression adapter +* [lz4](https://github.com/jaredwray/keyv/tree/main/packages/compress-lz4): lz4 compression adapter ### Third-party Storage Adapters diff --git a/packages/compress-lz4/README.md b/packages/compress-lz4/README.md index 2ed061ce2..b1dc97a23 100644 --- a/packages/compress-lz4/README.md +++ b/packages/compress-lz4/README.md @@ -1,15 +1,15 @@ # @keyv/compress-lz4 [keyv](https://github.com/jaredwra/keyv) -> lz4-napi compression for Keyv +> lz4 compression for Keyv [![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/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv) [![npm](https://img.shields.io/npm/v/@keyv/compress-lz4.svg)](https://www.npmjs.com/package/@keyv/compress-lz4) [![npm](https://img.shields.io/npm/dm/@keyv/compress-lz4)](https://npmjs.com/package/@keyv/compress-lz4) -lz4-napi compression for [Keyv](https://github.com/jaredwray/keyv). +lz4 compression for [Keyv](https://github.com/jaredwray/keyv). -lz4-napi is a data compression algorithm that is designed to be fast and efficient. +`lz4` is a data compression algorithm that is designed to be fast and efficient and is provided by the package [lz4-napi](https://npmjs.com/package/lz4-napi). ## Install @@ -33,7 +33,7 @@ const keyv = new Keyv({store: new Map(), compression: new KeyvLz4()}); #### options -All options for `@keyv/compress-lz4` are based on the package [lz4-napi](https://github.com/antoniomuso/lz4-napi) +All options for `@keyv/compress-lz4` are based on the package [lz4-napi](https://npmjs.com/package/lz4-napi). ## License diff --git a/packages/compress-lz4/package.json b/packages/compress-lz4/package.json index 8bd7259e1..3b3b1a118 100644 --- a/packages/compress-lz4/package.json +++ b/packages/compress-lz4/package.json @@ -1,7 +1,7 @@ { "name": "@keyv/compress-lz4", - "version": "0.1.0", - "description": "lz4-napi compression for keyv", + "version": "1.0.0", + "description": "lz4 compression for Keyv", "type": "module", "main": "dist/index.cjs", "module": "dist/index.js", diff --git a/packages/keyv/README.md b/packages/keyv/README.md index 592278770..9398f097f 100644 --- a/packages/keyv/README.md +++ b/packages/keyv/README.md @@ -289,7 +289,7 @@ The following are third-party storage adapters compatible with Keyv: # Compression -Keyv supports `gzip`, `brotli` and lz4-napi compression. To enable compression, pass the `compress` option to the constructor. +Keyv supports `gzip`, `brotli` and `lz4` compression. To enable compression, pass the `compress` option to the constructor. ```js import Keyv from 'keyv'; diff --git a/packages/keyv/test/test.ts b/packages/keyv/test/test.ts index 80c8cf637..e6d10ab79 100644 --- a/packages/keyv/test/test.ts +++ b/packages/keyv/test/test.ts @@ -398,7 +398,7 @@ test.it('compress/decompress with gzip', async t => { t.expect(await keyv.get('foo')).toBe('bar'); }); -test.it('compress/decompress with lz4-napi', async t => { +test.it('compress/decompress with lz4', async t => { const keyv = new Keyv({store: new Map(), compression: new KeyvLz4()}); await keyv.set('foo', 'bar'); t.expect(await keyv.get('foo')).toBe('bar'); diff --git a/packages/website/site/docs/index.md b/packages/website/site/docs/index.md index c2ee2d38f..a25e01edc 100644 --- a/packages/website/site/docs/index.md +++ b/packages/website/site/docs/index.md @@ -165,7 +165,7 @@ await users.clear(); ## 6. Advanced - Enable Compression -Keyv supports both `gzip`, `brotli` and lz4-napi methods of compression. Before you can enable compression, you will need to install the compression package: +Keyv supports both `gzip`, `brotli` and `lz4` methods of compression. Before you can enable compression, you will need to install the compression package: ```sh npm install --save keyv @keyv/compress-gzip @@ -192,7 +192,7 @@ const keyvBrotli = new KeyvBrotli(); const keyv = new Keyv({ compression: keyvBrotli }); ``` -### Example - Enable lz4-napi compression +### Example - Enable lz4 compression ```js import Keyv from 'keyv';