https://keyv.org/Simple key-value storage with support for multiple backendsTue, 06 Oct 2026 16:06:58 GMThttps://keyv.org/docs/https://keyv.org/docs/Install Keyv, store a value in seconds, and learn who uses it and what it can do.https://keyv.org/docs/options/https://keyv.org/docs/options/Constructor options for Keyv — store, namespace, TTL, serialization, compression, encryption, stats, and more.https://keyv.org/docs/properties/https://keyv.org/docs/properties/Instance properties on Keyv — store, namespace, TTL, serialization, compression, encryption, stats, sanitize, and more.https://keyv.org/docs/methods/https://keyv.org/docs/methods/Keyv methods — set, get, delete, has, batch APIs, raw access, iterator, disconnect, encode, and decode.https://keyv.org/docs/events-and-errors/https://keyv.org/docs/events-and-errors/Error events, when errors throw, telemetry events, and symbols.https://keyv.org/docs/hooks/https://keyv.org/docs/hooks/before/after hooks for get, set, delete, has, clear, disconnect, and raw APIs. Includes deprecated PRE_/POST_ aliases.https://keyv.org/docs/namespaces/https://keyv.org/docs/namespaces/Isolate keys that share a backend. Namespace lives on the storage adapter in v6.https://keyv.org/docs/encode-and-decode/https://keyv.org/docs/encode-and-decode/Serialization, compression, and encryption pipeline. Built-in JSON serializer, SuperJSON, MessagePack, and custom adapters.https://keyv.org/docs/sanitization/https://keyv.org/docs/sanitization/Strip SQL, Mongo, path-traversal, and control-character patterns from keys and namespaces.https://keyv.org/docs/using-map-and-lru/https://keyv.org/docs/using-map-and-lru/Use Map, quick-lru, lru.min, or BigMap as the Keyv store. How KeyvMemoryAdapter wraps them.https://keyv.org/docs/statistics/https://keyv.org/docs/statistics/Enable KeyvStats for hits, misses, sets, deletes, errors, and per-key LRU frequency maps.https://keyv.org/docs/logging-and-telemetry/https://keyv.org/docs/logging-and-telemetry/stat:* telemetry events, eventLogger (Pino/Winston), and how stats subscribe to the same events.https://keyv.org/docs/detect-capabilities/https://keyv.org/docs/detect-capabilities/detectKeyv, detectKeyvStorage, compression, serialization, encryption, and keyvStorageCapability.https://keyv.org/docs/legacy-storage-adapters/https://keyv.org/docs/legacy-storage-adapters/How KeyvBridgeAdapter wraps v5 relative-TTL adapters and async Map-like stores.https://keyv.org/docs/browser-node-and-bun/https://keyv.org/docs/browser-node-and-bun/Runtime support for Node.js, Bun, and browsers. Engines, Web Crypto, and what to install where.https://keyv.org/docs/test-suite/https://keyv.org/docs/test-suite/Test suite for Keyv API compliance build codecov npm npm Complete Vitest test suite to test a Keyv storage adapter for API compliance. Install vitest, keyv and @keyv/test-suite as development dependencies. Then update keyv and @keyv/test-su...https://keyv.org/docs/storage-adapters/overview/https://keyv.org/docs/storage-adapters/overview/Official backends, native TTL, how to use an adapter, benchmarks, and writing your own.https://keyv.org/docs/storage-adapters/redis/https://keyv.org/docs/storage-adapters/redis/Redis storage adapter for Keyv build codecov npm npm Redis storage adapter for Keyv. Built on top of @redis/client. TTL is handled directly by Redis via absolute PXAT expiry, with an automatic relative PX fallback for servers older than 6.2...https://keyv.org/docs/storage-adapters/valkey/https://keyv.org/docs/storage-adapters/valkey/Valkey storage adapter for Keyv build codecov npm npm Valkey storage adapter for Keyv. Valkey is the open source replacement to Redis which decided to do a dual license approach moving forward. Valkey is a drop-in replacement for Redis and...https://keyv.org/docs/storage-adapters/postgres/https://keyv.org/docs/storage-adapters/postgres/PostgreSQL storage adapter for Keyv build codecov npm npm PostgreSQL storage adapter for Keyv. Requires Postgres 9.5 or newer for ON CONFLICT support to allow performant upserts. Why? Install Usage Migrating to v6 Constructor Options Proper...https://keyv.org/docs/storage-adapters/mysql/https://keyv.org/docs/storage-adapters/mysql/MySQL/MariaDB storage adapter for Keyv build codecov npm npm MySQL/MariaDB storage adapter for Keyv. Install Usage Migrating to v6 Constructor Options Properties uri table keyLength namespaceLength iterationLimit intervalExpiration namespac...https://keyv.org/docs/storage-adapters/mongo/https://keyv.org/docs/storage-adapters/mongo/MongoDB storage adapter for Keyv build codecov npm npm MongoDB storage adapter for Keyv. Uses TTL indexes to automatically remove expired documents. However MongoDB doesn't guarantee data will be deleted immediately upon expiration, so expi...https://keyv.org/docs/storage-adapters/sqlite/https://keyv.org/docs/storage-adapters/sqlite/SQLite storage adapter for Keyv with multi-driver support for nodejs, bun, and custom drivers. build codecov npm npm SQLite storage adapter for Keyv. Install Usage Using createKeyv Multi-Driver Support Creating a Custom Driver Using sqlite3...https://keyv.org/docs/storage-adapters/memcache/https://keyv.org/docs/storage-adapters/memcache/Memcache storage adapter for Keyv using the memcache client build codecov GitHub license npm Built on the memcache package with a fully Promise-based API and TypeScript types TTL support (millisecond input, converted to seconds for memcache...https://keyv.org/docs/storage-adapters/etcd/https://keyv.org/docs/storage-adapters/etcd/Etcd storage adapter for Keyv, powered by our own from-scratch etcd v3 client — no third-party etcd library required build codecov GitHub license npm npm Talks to etcd directly over its HTTP/JSON gateway via a small in-house client — no etc...https://keyv.org/docs/storage-adapters/dynamo/https://keyv.org/docs/storage-adapters/dynamo/DynamoDB storage adapter for Keyv build codecov GitHub license npm npm Built on @aws-sdk/client-dynamodb and @aws-sdk/lib-dynamodb with full TypeScript support TTL support via DynamoDB TTL on the expiresAt attribute. Keys set without a TTL...https://keyv.org/docs/storage-adapters/cloudflare-kv/https://keyv.org/docs/storage-adapters/cloudflare-kv/Cloudflare Workers KV storage adapter for Keyv build codecov GitHub license npm npm Use Cloudflare Workers KV as a Keyv storage backend in one of two modes : bind (default) — a native KV binding , the object exposed as env.MY KV inside a Cl...https://keyv.org/docs/storage-adapters/bigmap/https://keyv.org/docs/storage-adapters/bigmap/Bigmap for Keyv build codecov npm npm Based on the Map interface and uses the same API. Lightweight and easy to use. Scales to past the 17 million key limit of a regular Map. Ability to use your own hash function. Built in Typescript and Ge...https://keyv.org/docs/storage-adapters/third-party/https://keyv.org/docs/storage-adapters/third-party/Community storage adapters and how to implement KeyvStorageAdapter.https://keyv.org/docs/serialization/overview/https://keyv.org/docs/serialization/overview/Built-in JSON serializer plus SuperJSON and MessagePack packages.https://keyv.org/docs/serialization/superjson/https://keyv.org/docs/serialization/superjson/SuperJSON-based serializer for Keyv with support for Date, Map, Set, BigInt, RegExp, and more build codecov GitHub license npm @keyv/serialize-superjson is a serialization adapter for Keyv powered by SuperJSON. It preserves JavaScript types...https://keyv.org/docs/serialization/msgpackr/https://keyv.org/docs/serialization/msgpackr/High-performance MessagePack serializer for Keyv using msgpackr build codecov GitHub license npm @keyv/serialize-msgpackr is a serialization adapter for Keyv powered by msgpackr. It uses the MessagePack binary format for high-performance se...https://keyv.org/docs/compression/overview/https://keyv.org/docs/compression/overview/Gzip, Brotli, and LZ4 compression adapters for Keyv.https://keyv.org/docs/compression/compress-gzip/https://keyv.org/docs/compression/compress-gzip/Gzip compression for Keyv build codecov npm npm Gzip compression for Keyv. Options are pako v3 options, such as level, windowBits or dictionary. The same object is passed to pako's deflate in compress and to its inflate in decompress. KeyvG...https://keyv.org/docs/compression/compress-brotli/https://keyv.org/docs/compression/compress-brotli/Brotli compression for Keyv build codecov npm npm Brotli compression for Keyv. Brotli is a data compression algorithm that is designed to be fast and efficient. @keyv/compress-brotli uses Node's built-in node:zlib Brotli functions. Both opt...https://keyv.org/docs/compression/compress-lz4/https://keyv.org/docs/compression/compress-lz4/lz4 compression for Keyv build codecov npm npm lz4 compression for Keyv. lz4 is a data compression algorithm that is designed to be fast and efficient and is provided by the package lz4-napi. An optional string that lz4-napi uses as the dic...https://keyv.org/docs/encryption/overview/https://keyv.org/docs/encryption/overview/Encrypt values at rest with Node.js crypto or the Web Crypto API.https://keyv.org/docs/encryption/encrypt-node/https://keyv.org/docs/encryption/encrypt-node/Node.js crypto encryption for Keyv build codecov npm npm Encrypt and decrypt values stored in Keyv using the Node.js crypto module. Supports the authenticated ciphers AES-GCM (default), AES-CCM, and ChaCha20-Poly1305, so a value changed in...https://keyv.org/docs/encryption/encrypt-web/https://keyv.org/docs/encryption/encrypt-web/Web Crypto API encryption for Keyv build codecov npm npm Encrypt and decrypt values stored in Keyv using the Web Crypto API (crypto.subtle). Works in browsers, Deno, Cloudflare Workers, and Node.js 18+. No Node.js-specific dependencies. Enc...https://keyv.org/docs/migration/ai-agent-skill/https://keyv.org/docs/migration/ai-agent-skill/Upgrade from Keyv v4 or v5 to v6 with a coding agent. Point it at https://keyv.org/skills/migrate, or install the keyv-migrate Agent Skill.https://keyv.org/docs/migration/v4-to-v5/https://keyv.org/docs/migration/v4-to-v5/Keyv v5 is a major release with breaking changes. The biggest one is that Keyv no longer loads storage adapters from a connection string. This page covers what changed from v4 to v5. Still on v4? Go straight to v6. Apply this page, then the...https://keyv.org/docs/migration/v5-to-v6/https://keyv.org/docs/migration/v5-to-v6/We are pleased to announce Keyv v6 with major enhancements and some breaking changes. This guide will help you understand how to migrate from v5 to v6. For most users, the transition will be straightforward. Important: With the release of v...https://keyv.org/docs/migration/versioning/https://keyv.org/docs/migration/versioning/Keyv supports more than one major version at a time, so the npm dist-tags are managed deliberately. This page explains which tag points where and which install command to use. Since v6 , all Keyv packages — the core keyv package and every o...