Keyv

https://keyv.org/docs
Admin
Keyv provides a consistent interface for key-value storage across multiple backends via storage...
Tokens:196,242
Snippets:1,770
Trust Score:6.2
Update:17 hours ago
Show doc for...
Tokens:
Raw
### Quick Start with createKeyv

Source: https://keyv.org/docs/storage-adapters/memcache/

Creates a Keyv instance with a Memcache store using the createKeyv helper, then demonstrates setting, getting, and deleting a value. The example also shows attaching an error handler.

```javascript
import { createKeyv } from '@keyv/memcache';

const keyv = createKeyv('localhost:11211');
keyv.on('error', handleConnectionError);

// set a value
await keyv.set('foo', 'bar', 6000);

// get a value
const value = await keyv.get('foo');

// delete a value
await keyv.delete('foo');
```

--------------------------------

### Quick Start with createKeyv

Source: https://keyv.org/docs/storage-adapters/etcd/

Shows how to create a Keyv instance using createKeyv and perform basic operations: set, get, set with TTL, and delete.

```javascript
import { createKeyv } from '@keyv/etcd';

const keyv = createKeyv('etcd://localhost:2379');

// set a value
await keyv.set('foo', 'bar');

// get a value
const value = await keyv.get('foo');

// set with TTL (milliseconds)
await keyv.set('foo', 'bar', 6000);

// delete a value
await keyv.delete('foo');
```

--------------------------------

### Quick Start with createKeyv (REST mode)

Source: https://keyv.org/docs/storage-adapters/cloudflare-kv/

Shows how to create a Keyv instance using createKeyv in REST mode, set and get values, set with TTL, and delete. Requires environment variables for account ID, namespace ID, and API token.

```javascript
import { createKeyv } from '@keyv/cloudflare-kv';

// REST mode (from any Node.js process)
const keyv = createKeyv({
  mode: 'rest',
  accountId: process.env.CF_ACCOUNT_ID,
  namespaceId: process.env.CF_KV_NAMESPACE_ID,
  apiToken: process.env.CF_API_TOKEN,
});

// set a value
await keyv.set('foo', 'bar');

// get a value
const value = await keyv.get('foo');

// set with TTL (milliseconds)
await keyv.set('foo', 'bar', 60000);

// delete a value
await keyv.delete('foo');
```

--------------------------------

### Quick Start with createKeyv

Source: https://keyv.org/docs/storage-adapters/dynamo/

Shows how to create a Keyv instance using createKeyv from @keyv/dynamo, set and get values, set with TTL, and delete.

```javascript
import { createKeyv } from '@keyv/dynamo';

const keyv = createKeyv({ endpoint: 'http://localhost:8000' });

// set a value
await keyv.set('foo', 'bar');

// get a value
const value = await keyv.get('foo');

// set with TTL (milliseconds)
await keyv.set('foo', 'bar', 6000);

// delete a value
await keyv.delete('foo');

```

--------------------------------

### Keyv basic operations example

Source: https://keyv.org/docs/

Demonstrates set, get, has, and delete operations on a Keyv instance. The get returns 'bar', has returns true, and delete returns true.

```javascript
import Keyv from "keyv";

const keyv = new Keyv();

await keyv.set("foo", "bar");
await keyv.get("foo"); // 'bar'
await keyv.has("foo"); // true
await keyv.delete("foo"); // true
```

--------------------------------

### Installation

Source: https://keyv.org/docs/storage-adapters/valkey/

Install the Valkey storage adapter for Keyv using npm.

```APIDOC
## Install

```bash
npm install --save @keyv/valkey
```
```

--------------------------------

### Install Keyv migration skill with npx skills

Source: https://keyv.org/docs/migration/ai-agent-skill/

Install the Keyv migration skill using the skills CLI. The first command installs from the official Keyv site, the second from GitHub. Both install the skill for agents like Claude Code, Cursor, Codex, and GitHub Copilot.

```bash
npx skills add https://keyv.org
# or from GitHub
npx skills add jaredwray/keyv --skill keyv-migrate
```

--------------------------------

### Installation

Source: https://keyv.org/docs/storage-adapters/postgres/

Install the Keyv PostgreSQL adapter and its peer dependencies.

```APIDOC
## Install

```bash
npm install @keyv/postgres pg
```
```

--------------------------------

### Install keyv and @keyv/postgres

Source: https://keyv.org/docs/storage-adapters/postgres/

Install the Keyv package and the PostgreSQL storage adapter using npm.

```shell
npm install --save keyv @keyv/postgres
```

--------------------------------

### Install keyv and @keyv/redis with npm

Source: https://keyv.org/docs/storage-adapters/redis/

Install the required packages using npm. Run this command in your project directory.

```bash
npm install --save keyv @keyv/redis
```

--------------------------------

### Installation

Source: https://keyv.org/docs/storage-adapters/mysql/

Install the @keyv/mysql package via npm.

```APIDOC
## Install

```bash
npm install @keyv/mysql
```
```

--------------------------------

### Install @keyv/valkey with npm

Source: https://keyv.org/docs/storage-adapters/valkey/

Install the keyv package and the @keyv/valkey storage adapter using npm.

```shell
npm install --save keyv @keyv/valkey
```

--------------------------------

### Installation

Source: https://keyv.org/docs/storage-adapters/mongo/

Install the MongoDB storage adapter for Keyv using npm.

```APIDOC
## Install

```bash
npm install @keyv/mongo
```
```

--------------------------------

### Install Keyv core package

Source: https://keyv.org/docs/

Installs the core Keyv package. By default, everything lives in memory.

```bash
npm install keyv
```

--------------------------------

### Install @keyv/dynamo with npm

Source: https://keyv.org/docs/storage-adapters/dynamo/

Install the keyv package and the DynamoDB adapter using npm.

```shell
npm install --save keyv @keyv/dynamo

```

--------------------------------

### Install @keyv/mongo

Source: https://keyv.org/docs/storage-adapters/mongo/

Install the Keyv package and the MongoDB storage adapter using npm.

```shell
npm install --save keyv @keyv/mongo
```

--------------------------------

### Installation

Source: https://keyv.org/docs/storage-adapters/mongo/

Install the keyv and @keyv/mongo packages via npm.

```APIDOC
## Install

```shell
npm install --save keyv @keyv/mongo
```
```

--------------------------------

### Install @keyv/compress-brotli

Source: https://keyv.org/docs/compression/compress-brotli/

Install the package and its peer dependency keyv.

```shell
npm install --save keyv @keyv/compress-brotli
```

--------------------------------

### Install @keyv/sqlite with npm

Source: https://keyv.org/docs/storage-adapters/sqlite/

Install the keyv package and the @keyv/sqlite storage adapter using npm.

```shell
npm install --save keyv @keyv/sqlite
```

--------------------------------

### Install @keyv/cloudflare-kv

Source: https://keyv.org/docs/storage-adapters/cloudflare-kv/

Install the keyv package and the @keyv/cloudflare-kv adapter using npm.

```shell
npm install --save keyv @keyv/cloudflare-kv
```

--------------------------------

### Install dependencies with npm

Source: https://keyv.org/docs/test-suite/

Install vitest, keyv, and @keyv/test-suite as development dependencies.

```shell
npm install --save-dev vitest keyv @keyv/test-suite
```

--------------------------------

### Install @keyv/memcache with npm

Source: https://keyv.org/docs/storage-adapters/memcache/

Install the @keyv/memcache package using npm.

```shell
npm install --save @keyv/memcache
```

--------------------------------

### Install @keyv/etcd

Source: https://keyv.org/docs/storage-adapters/etcd/

Install the Keyv etcd adapter package using npm.

```shell
npm install --save keyv @keyv/etcd
```

--------------------------------

### Install @keyv/mysql with npm

Source: https://keyv.org/docs/storage-adapters/mysql/

Install the Keyv MySQL adapter package via npm.

```shell
npm install --save keyv @keyv/mysql
```

--------------------------------

### Install @keyv/compress-gzip

Source: https://keyv.org/docs/compression/compress-gzip/

Install the keyv package and the @keyv/compress-gzip adapter using npm.

```shell
npm install --save keyv @keyv/compress-gzip
```

--------------------------------

### Install Redis storage adapter

Source: https://keyv.org/docs/

Installs the @keyv/redis package to use Redis as a storage adapter for persistence across restarts.

```bash
npm install @keyv/redis
```

--------------------------------

### get method example

Source: https://keyv.org/docs/storage-adapters/mongo/

Shows retrieving a value by key using the get method. Returns undefined for missing keys. In GridFS mode, get also updates the lastAccessed timestamp.

```javascript
const store = new KeyvMongo('mongodb://localhost:27017');
const keyv = new Keyv({ store });

await keyv.set('foo', 'bar');
const value = await keyv.get('foo');
console.log(value); // 'bar'

const missing = await keyv.get('nonexistent');
console.log(missing); // undefined
```

--------------------------------

### getStoreMap method example

Source: https://keyv.org/docs/storage-adapters/bigmap/

Gets the internal Map instance at a specific index.

```typescript
const firstMap = bigMap.getStoreMap(0);
```

--------------------------------

### Usage

Source: https://keyv.org/docs/storage-adapters/valkey/

Basic usage example showing how to create a Keyv instance with the Valkey adapter.

```APIDOC
## Usage

```javascript
import Keyv from 'keyv';
import KeyvValkey from '@keyv/valkey';

const keyv = new Keyv(new KeyvValkey('redis://user:pass@localhost:6379'));
keyv.on('error', err => console.error('Keyv connection error:', err));
```
```

--------------------------------

### getStore method example

Source: https://keyv.org/docs/storage-adapters/bigmap/

Gets the internal Map instance for a specific key.

```typescript
const store = bigMap.getStore('user123');
```

--------------------------------

### Install and use @keyv/redis adapter

Source: https://keyv.org/docs/storage-adapters/overview/

Shows how to install the Redis adapter and pass it as the store to Keyv. The adapter is imported and instantiated with a Redis connection string, then passed as the first argument to the Keyv constructor. A namespace option is set to 'cache'.

```javascript
import Keyv from "keyv";
import KeyvRedis from "@keyv/redis";

const keyv = new Keyv(new KeyvRedis("redis://localhost:6379"), {
	namespace: "cache",
});
```

--------------------------------

### get method example

Source: https://keyv.org/docs/storage-adapters/bigmap/

Retrieves the value associated with a key, or undefined if not found.

```typescript
const value = bigMap.get('user123');
```

--------------------------------

### createKeyv with Options

Source: https://keyv.org/docs/storage-adapters/dynamo/

Shows how to pass options to createKeyv, including tableName and namespace.

```javascript
import { createKeyv } from '@keyv/dynamo';

const keyv = createKeyv({
  endpoint: 'http://localhost:8000',
  tableName: 'cacheTable',
  namespace: 'my-app',
});

```

--------------------------------

### Start PostgreSQL test services with pnpm test:services:start

Source: https://keyv.org/docs/storage-adapters/postgres/

Run this command from the root of the Keyv monorepo to start a PostgreSQL server via Docker Compose, run the tests, and stop the server. Requires Docker to be installed and running.

```shell
pnpm test:services:start
```

--------------------------------

### Using MyCustomStore with Keyv

Source: https://keyv.org/docs/storage-adapters/third-party/

Shows how to instantiate Keyv with the custom store and a namespace, then set a value.

```typescript
import Keyv from "keyv";
import MyCustomStore from "./my-custom-store.js";

const keyv = new Keyv({ store: new MyCustomStore(), namespace: "my-app" });
await keyv.set("foo", "bar");

```

--------------------------------

### Get intervalExpiration property

Source: https://keyv.org/docs/storage-adapters/mysql/

Shows how to get or set the interval in seconds for automatic expiration cleanup. Setting a value greater than 0 starts an unref'd timer; 0 or undefined disables it.

```javascript
const store = new KeyvMysql({ uri: 'mysql://user:pass@localhost:3306/dbname', intervalExpiration: 60 });
console.log(store.intervalExpiration); // 60
```

--------------------------------

### Basic Keyv usage with in-memory store

Source: https://keyv.org/docs/

Shows how to import Keyv, create an instance, and use set/get with a TTL of 60 seconds. Values can be JSON-serializable types, Buffer, or BigInt.

```javascript
import Keyv from "keyv";

const keyv = new Keyv();
await keyv.set("user:1", { name: "Ada" }, 60_000);
await keyv.get("user:1"); // { name: 'Ada' }
```

--------------------------------

### keyvMysql.disconnect() example

Source: https://keyv.org/docs/storage-adapters/mysql/

Stops the adapter from accepting new queries, waits for started queries, and closes the connection pool. Repeated calls are safe.

```javascript
await keyvMysql.disconnect();
```

--------------------------------

### Usage

Source: https://keyv.org/docs/storage-adapters/mysql/

Basic usage example for creating a Keyv instance with the MySQL adapter.

```APIDOC
## Usage

```javascript
const Keyv = require('keyv');
const KeyvMySQL = require('@keyv/mysql');

const keyv = new Keyv(new KeyvMySQL('mysql://user:pass@localhost:3306/dbname'));
```
```

--------------------------------

### Enabling nonBlocking option for Cacheable

Source: https://keyv.org/docs/storage-adapters/redis/

Sets the nonBlocking option to true for higher performance, making the secondary cache non-blocking. This is a separate example from the basic setup.

```javascript
const cache = new Cacheable( { secondary, nonBlocking: true } );
```

--------------------------------

### createKeyv([connect], [options])

Source: https://keyv.org/docs/storage-adapters/redis/

Creates a Keyv instance with this adapter. Applies namespace on both Keyv and the store.

```APIDOC
## createKeyv([connect], [options])

### Description
Keyv instance with this adapter. Applies `namespace` on both Keyv and the store. `connect` accepts the same `KeyvRedisConnect` types as the constructor (including cluster/sentinel). Defaults to `"redis://localhost:6379"` when `connect` is omitted.

### Method
createKeyv

### Parameters
- **connect** (string | KeyvRedisConnect | RedisClientConnectionType) - Optional - Connection URI, options, or existing connection.
- **options** (object) - Optional - Adapter options.

### Returns
Keyv instance
```

--------------------------------

### Using Keyv with Memcached

Source: https://keyv.org/docs/storage-adapters/memcache/

Shows how to set up Keyv with a local Memcached instance. Requires installing Memcached and starting an instance. The server address and port are set to localhost:11211.

```javascript
import Keyv from 'keyv';
import KeyvMemcache from '@keyv/memcache';

//set the server to the correct address and port
const memcache = new KeyvMemcache("localhost:11211");
const keyv = new Keyv({ store: memcache});
```

--------------------------------

### .formatKey(key)

Source: https://keyv.org/docs/storage-adapters/etcd/

Formats a key by prepending the namespace if one is set. A key that already starts with the namespace prefix gets it again, so `myapp:foo` and `foo` stay separate keys.

```APIDOC
## .formatKey(key)

### Description
Formats a key by prepending the namespace if one is set. A key that already starts with the namespace prefix gets it again, so `myapp:foo` and `foo` stay separate keys.

### Method
formatKey(key)

### Parameters
- **key** (string) - Required - The key to format.

### Returns
The formatted key with namespace prefix if set.

### Example
```js
const store = new KeyvEtcd('etcd://localhost:2379');
store.formatKey('foo'); // 'foo'

store.namespace = 'myapp';
store.formatKey('foo'); // 'myapp:foo'
store.formatKey('myapp:foo'); // 'myapp:myapp:foo'
```
```

--------------------------------

### Using QuickLRU as a Map-like store

Source: https://keyv.org/docs/storage-adapters/overview/

Map-like stores do not need an extra adapter package. Pass a QuickLRU instance as the store option to Keyv.

```javascript
import QuickLRU from "quick-lru";

const keyv = new Keyv({ store: new QuickLRU({ maxSize: 1000 }) });
```

--------------------------------

### .formatKey(key)

Source: https://keyv.org/docs/storage-adapters/dynamo/

Formats a key by prepending the namespace if one is set. A key that already starts with the namespace prefix gets it again, so `myapp:foo` and `foo` stay separate keys.

```APIDOC
## .formatKey(key)

### Description
Formats a key by prepending the namespace if one is set. A key that already starts with the namespace prefix gets it again, so `myapp:foo` and `foo` stay separate keys.

### Method
.formatKey(key)

### Parameters
- **key** (string) - Required - The key to format.

### Request Example
```js
const store = new KeyvDynamo({ endpoint: 'http://localhost:8000' });
store.formatKey('foo'); // 'foo'

store.namespace = 'myapp';
store.formatKey('foo'); // 'myapp:foo'
store.formatKey('myapp:foo'); // 'myapp:myapp:foo'
```

### Response
Returns the formatted key string.
```

--------------------------------

### Keyv v6: get always returns undefined for missing values

Source: https://keyv.org/docs/migration/v5-to-v6/

In v6, keyv.get consistently returns undefined for missing values, regardless of the adapter. This example shows the v6 behavior.

```javascript
const value = await keyv.get('nonexistent');
// value is always undefined
```

--------------------------------

### Usage with Keyv

Source: https://keyv.org/docs/storage-adapters/sqlite/

Basic usage example showing how to create a Keyv instance with the SQLite adapter.

```APIDOC
## Usage

```javascript
import Keyv from 'keyv';
import KeyvSqlite from '@keyv/sqlite';

const keyv = new Keyv(new KeyvSqlite('sqlite://path/to/database.sqlite'));
```
```

--------------------------------

### Format key with namespace using .formatKey(key)

Source: https://keyv.org/docs/storage-adapters/etcd/

Prepends the namespace if one is set. A key that already starts with the namespace prefix gets it again, so 'myapp:foo' and 'foo' stay separate keys.

```javascript
const store = new KeyvEtcd('etcd://localhost:2379');
store.formatKey('foo'); // 'foo'

store.namespace = 'myapp';
store.formatKey('foo'); // 'myapp:foo'
store.formatKey('myapp:foo'); // 'myapp:myapp:foo'
```

--------------------------------

### intervalExpiration (getter/setter)

Source: https://keyv.org/docs/storage-adapters/mysql/

Get or set the interval in seconds for automatic expiration cleanup. When set to a value greater than 0, the adapter starts an unref'd application timer that periodically deletes expired entries.

```APIDOC
## intervalExpiration (getter/setter)

### Description
Get or set the interval in seconds for automatic expiration cleanup. When set to a value greater than 0, the adapter starts an unref'd application timer that periodically deletes expired entries. Changing the value restarts the timer, while 0 or undefined disables it. Cleanup runs never overlap, and changing the interval after disconnect() does not restart the timer. Values above 2147483.647 seconds are rejected because they exceed Node.js's maximum timer delay. The timer is stopped by disconnect() and does not require MySQL EVENT or global-variable privileges.

### Properties
- **intervalExpiration** (number | undefined) - Getter/setter. Default: undefined (disabled)

### Example
```js
const store = new KeyvMysql({ uri: 'mysql://user:pass@localhost:3306/dbname', intervalExpiration: 60 });
console.log(store.intervalExpiration); // 60
```

### Notes
Earlier v6 prereleases created a schema event named keyv_delete_expired_keys. The adapter no longer creates, changes, or drops server events. If that legacy event exists, a database administrator can remove it once with DROP EVENT IF EXISTS keyv_delete_expired_keys.
```

--------------------------------

### Keyv v5: get returns null or undefined for missing values

Source: https://keyv.org/docs/migration/v5-to-v6/

Before v6, the value returned by keyv.get for a nonexistent key could be null or undefined depending on the storage adapter. This example shows the v5 behavior.

```javascript
const value = await keyv.get('nonexistent');
// value could be null or undefined depending on the adapter
```

--------------------------------

### Testing Locally with Miniflare

Source: https://keyv.org/docs/storage-adapters/cloudflare-kv/

Shows how to test the adapter against a real local Cloudflare KV using Miniflare, without needing a Cloudflare account. The example creates a Miniflare instance with a KV namespace, gets the namespace, and uses it with the adapter.

```javascript
import { Miniflare } from 'miniflare';
import KeyvCloudflareKV from '@keyv/cloudflare-kv';

const mf = new Miniflare({
  modules: true,
  script: "export default { fetch() { return new Response('ok'); } };",
  kvNamespaces: ['KV'],
});

const kvNamespace = await mf.getKVNamespace('KV');
const store = new KeyvCloudflareKV({ kvNamespace });

await store.set('foo', 'bar');
console.log(await store.get('foo')); // 'bar'

await mf.dispose();
```

--------------------------------

### constructor(url?, options?)

Source: https://keyv.org/docs/storage-adapters/etcd/

Creates a new KeyvEtcd instance. Accepts an etcd server URI string or an options object, with optional additional options.

```APIDOC
## constructor(url?, options?)

### Description
Creates a new `KeyvEtcd` instance.

### Parameters
- `url` (string | KeyvEtcdOptions) - Optional - An etcd server URI string (e.g., `'etcd://localhost:2379'`) or a `KeyvEtcdOptions` object. Defaults to `'127.0.0.1:2379'` if not provided.
- `options` (KeyvEtcdOptions) - Optional - Additional options. When both `url` and `options` are objects, they are merged together.

### Example
```js
import KeyvEtcd from '@keyv/etcd';

// Using a URI string
const store = new KeyvEtcd('etcd://localhost:2379');

// Using an options object
const store2 = new KeyvEtcd({ url: '127.0.0.1:2379', ttl: 5000 });

// Using a URI string with additional options
const store3 = new KeyvEtcd('etcd://localhost:2379', { ttl: 5000 });
```
```

--------------------------------

### Browser compatibility example

Source: https://keyv.org/docs/migration/v5-to-v6/

Shows how to use Keyv in a browser environment with a Map store.

```javascript
import Keyv from 'keyv';

// Works in the browser
const keyv = new Keyv({ store: new Map() });
```

--------------------------------

### Install @keyv/serialize-msgpackr

Source: https://keyv.org/docs/serialization/msgpackr/

Install the package via npm. Note that keyv is a peer dependency and must be installed alongside.

```bash
npm install @keyv/serialize-msgpackr
```

--------------------------------

### Keyv with options object

Source: https://keyv.org/docs/

Shows how to pass options as the first argument to the Keyv constructor, including a store, namespace, and default TTL.

```javascript
const keyv = new Keyv({
	store: new KeyvRedis("redis://localhost:6379"),
	namespace: "cache",
	ttl: 60_000,
});
```

--------------------------------

### Installation

Source: https://keyv.org/docs/serialization/superjson/

Install the @keyv/serialize-superjson package via npm. Note that keyv is a peer dependency and must be installed alongside.

```APIDOC
## Installation

```bash
npm install @keyv/serialize-superjson
```

> **Note:** `keyv` is a peer dependency and must be installed alongside this package.
```

--------------------------------

### Keyv Integration Example

Source: https://keyv.org/docs/storage-adapters/bigmap/

Shows how to use BigMap through the Keyv ecosystem, including namespaces and iteration.

```APIDOC
## Integration with Keyv Ecosystem

### Description
BigMap works seamlessly with the Keyv ecosystem.

### Example
```typescript
import { createKeyv } from '@keyv/bigmap';

const cache = createKeyv({ storeSize: 16 });

// Use with namespaces
const users = cache.namespace('users');
const products = cache.namespace('products');

await users.set('123', { name: 'Alice' });
await products.set('456', { name: 'Laptop' });

// Iterate over keys
for await (const [key, value] of cache.iterator()) {
  console.log(key, value);
}
```
```

--------------------------------

### Install @keyv/serialize-superjson

Source: https://keyv.org/docs/serialization/superjson/

Install the package via npm. Note that keyv is a peer dependency and must be installed alongside.

```bash
npm install @keyv/serialize-superjson
```

--------------------------------

### get

Source: https://keyv.org/docs/storage-adapters/bigmap/

Gets the value associated with a key.

```APIDOC
## get

### Description
Gets the value associated with a key.

### Method
get

### Parameters
- `key` (K) - Required - The key to retrieve

### Returns
`V | undefined` - The value, or undefined if not found

### Example
```typescript
const value = bigMap.get('user123');
```
```

--------------------------------

### new Keyv(store?, options?)

Source: https://keyv.org/docs/options/

Creates a new Keyv instance with an optional storage adapter and options. The first argument can be a storage adapter or an options object.

```APIDOC
## new Keyv(store?, options?)

### Description
Creates a new Keyv instance. The first argument can be a storage adapter or an options object. Extra fields are not forwarded to the adapter.

### Constructor
`new Keyv(store?, options?)` or `new Keyv(options)`

### Parameters
#### store (optional)
- **store** (KeyvStorageAdapter | Map | Map-like) - The storage backend. Defaults to an in-memory Map wrapped by KeyvMemoryAdapter.

#### options (optional)
- **namespace** (string) - Namespace for this instance. Default: `undefined`.
- **ttl** (number) - Default time-to-live in milliseconds for `set()`. Default: `undefined` (no expiry).
- **serialization** (KeyvSerializationAdapter | false) - Object with `stringify` and `parse`. Default: `KeyvJsonSerializer`.
- **compression** (KeyvCompressionAdapter) - Adapter with `compress` and `decompress`. Default: `undefined`.
- **encryption** (KeyvEncryptionAdapter) - Adapter with `encrypt` and `decrypt`. Default: `undefined`.
- **sanitize** (KeyvSanitizeOptions) - Strip dangerous patterns from keys and namespaces. Default: disabled.
- **stats** (boolean) - Enable telemetry events. Default: `false`.
- **checkExpired** (boolean) - Check absolute `expires` on reads. Default: `true`.

### Example
```js
import Keyv from "keyv";
import KeyvRedis from "@keyv/redis";

const keyv = new Keyv(new KeyvRedis("redis://localhost:6379"), {
	namespace: "cache",
	ttl: 60_000,
});
```

### Constructor Overloads
```ts
new Keyv();
new Keyv(options);
new Keyv(store);
new Keyv(store, options);
```

`store` is detected by looking for a `.get` method. Anything else is treated as `options`.
```

--------------------------------

### createKeyv with Custom Options

Source: https://keyv.org/docs/storage-adapters/bigmap/

Shows how to create a Keyv instance with custom store size and custom hash function for better performance with millions of keys.

```APIDOC
## createKeyv with Custom Options

### Description
Create a Keyv instance with custom store size and custom hash function.

### Method
createKeyv

### Parameters
- `options` (object) - Optional - BigMap configuration options.
  - `storeSize` (number) - Optional - Number of internal Map instances. Default: `2`.
  - `storeHashFunction` (StoreHashFunction) - Optional - Custom hash function for key distribution.

### Example
```typescript
import { createKeyv } from '@keyv/bigmap';

// Create with custom store size for better performance with millions of keys
const keyv = createKeyv({ storeSize: 16 });

// With custom hash function
const keyv = createKeyv({
  storeSize: 8,
  storeHashFunction: (key, storeSize) => {
    // Custom distribution logic
    return key.length % storeSize;
  }
});
```
```

--------------------------------

### Installation

Source: https://keyv.org/docs/storage-adapters/sqlite/

Install the @keyv/sqlite package via npm.

```APIDOC
## Install

```bash
npm install @keyv/sqlite
```
```

--------------------------------

### Create Keyv instance with Redis adapter and options

Source: https://keyv.org/docs/options/

Shows how to instantiate Keyv with a Redis storage adapter and set namespace and ttl options. The adapter is passed as the first argument, and options as the second.

```javascript
import Keyv from "keyv";
import KeyvRedis from "@keyv/redis";

const keyv = new Keyv(new KeyvRedis("redis://localhost:6379"), {
	namespace: "cache",
	ttl: 60_000,
});
```

--------------------------------

### constructor([connect], [options])

Source: https://keyv.org/docs/storage-adapters/redis/

Creates a new KeyvRedis adapter instance. The connect parameter can be a URI string, client/cluster/sentinel options, or an existing connection.

```APIDOC
## constructor([connect], [options])

### Description
Creates a new KeyvRedis adapter instance. The `connect` parameter can be a URI string, client/cluster/sentinel options (`KeyvRedisConnect`), or an existing connection.

### Method
constructor

### Parameters
- **connect** (string | KeyvRedisConnect | RedisClientConnectionType) - Optional - Connection URI, options, or existing connection.
- **options** (object) - Optional - Adapter options (see Keyv Redis Options).

### Returns
KeyvRedis instance
```

--------------------------------

### Install @keyv/encrypt-web

Source: https://keyv.org/docs/encryption/encrypt-web/

Install the package and its peer dependency keyv.

```shell
npm install --save keyv @keyv/encrypt-web
```
Tokens:
Raw