https://github.com/jaredwray/keyv
Simple key-value storage with support for multiple backends
https://github.com/jaredwray/keyv
cache etcd key-value keyv memcache mongo mysql postgres redis sqlite storage
Last synced: 24 days ago
JSON representation
Simple key-value storage with support for multiple backends
- Host: GitHub
- URL: https://github.com/jaredwray/keyv
- Owner: jaredwray
- License: mit
- Created: 2017-07-07T13:24:15.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2026-05-08T18:21:21.000Z (about 2 months ago)
- Last Synced: 2026-06-04T10:23:30.570Z (28 days ago)
- Topics: cache, etcd, key-value, keyv, memcache, mongo, mysql, postgres, redis, sqlite, storage
- Language: TypeScript
- Homepage: https://keyv.org
- Size: 5.45 MB
- Stars: 3,140
- Watchers: 19
- Forks: 198
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
- awesome-javascript - @keyv/mono-repo - value storage with support for multiple backends (Packages)
- awesome-nodejs-cn - Keyv - **star:2741** 简单的键值存储，支持多个后端 ![star > 2000][Awesome] (包 / 数据库)
- awesome-nodejs - Keyv - Simple key-value storage with support for multiple backends. (Packages / Database)
- awesome - jaredwray/keyv - Simple key-value storage with support for multiple backends (TypeScript)
- fucking-awesome-nodejs - Keyv - Simple key-value storage with support for multiple backends. (Packages / Database)
- awesome-nodejs - Keyv - Simple key-value storage with support for multiple backends. (Packages / Database)
README
> Simple key-value storage with support for multiple backends
[](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
[](https://github.com/jaredwray/keyv/actions/workflows/bun-test.yaml)
[](https://github.com/jaredwray/keyv/actions/workflows/browser-compat.yaml)
[](https://codecov.io/gh/jaredwray/keyv)
[](https://www.npmjs.com/package/keyv)
[](https://www.npmjs.com/package/keyv)
# Getting Started
Keyv provides a consistent interface for key-value storage across multiple backends via storage adapters. It supports TTL-based expiry, making it suitable as a cache or a persistent key-value store.
Install Keyv:
```
npm install keyv
```
By default everything is stored in memory. You can optionally install a storage adapter for persistent backends:
```
npm install @keyv/redis
```
Use it:
```js
import Keyv from 'keyv';
const keyv = new Keyv();
await keyv.set('foo', 'bar');
await keyv.get('foo'); // 'bar'
```
For the full API documentation, see the [Keyv README](https://github.com/jaredwray/keyv/blob/main/core/keyv/README.md).
# Project Structure
This monorepo is organized into categorized directories:
```
core/ Core packages
keyv/ Main Keyv library
test-suite/ Shared test suite for API compliance
bigmap/ Scalable in-memory Map
serialization/ Serialization packages
superjson/ SuperJSON serializer (@keyv/serialize-superjson)
msgpackr/ MessagePack serializer (@keyv/serialize-msgpackr)
compression/ Compression adapters
compress-brotli/
compress-gzip/
compress-lz4/
storage/ Storage adapters
redis/ postgres/ mysql/ mongo/ sqlite/
memcache/ etcd/ valkey/ dynamo/
website/ Documentation website (keyv.org)
```
# Packages
* [keyv](https://github.com/jaredwray/keyv/tree/main/core/keyv) - Simple key-value storage with support for multiple backends
* [test-suite](https://github.com/jaredwray/keyv/tree/main/core/test-suite) - Test suite for Keyv API compliance
* [bigmap](https://github.com/jaredwray/keyv/tree/main/core/bigmap) - Scalable in-memory Map
## Storage Adapters
* [dynamo](https://github.com/jaredwray/keyv/tree/main/storage/dynamo) - DynamoDB storage adapter
* [etcd](https://github.com/jaredwray/keyv/tree/main/storage/etcd) - Etcd storage adapter
* [memcache](https://github.com/jaredwray/keyv/tree/main/storage/memcache) - Memcache storage adapter
* [mongo](https://github.com/jaredwray/keyv/tree/main/storage/mongo) - MongoDB storage adapter
* [mysql](https://github.com/jaredwray/keyv/tree/main/storage/mysql) - MySQL/MariaDB storage adapter
* [postgres](https://github.com/jaredwray/keyv/tree/main/storage/postgres) - PostgreSQL storage adapter
* [redis](https://github.com/jaredwray/keyv/tree/main/storage/redis) - Redis storage adapter
* [sqlite](https://github.com/jaredwray/keyv/tree/main/storage/sqlite) - SQLite storage adapter
* [valkey](https://github.com/jaredwray/keyv/tree/main/storage/valkey) - Valkey (Open Source Redis) storage adapter
## Compression Adapters
* [compress-brotli](https://github.com/jaredwray/keyv/tree/main/compression/compress-brotli) - Brotli compression adapter
* [compress-gzip](https://github.com/jaredwray/keyv/tree/main/compression/compress-gzip) - Gzip compression adapter
* [compress-lz4](https://github.com/jaredwray/keyv/tree/main/compression/compress-lz4) - LZ4 compression adapter
## Serialization
The default serializer (`KeyvJsonSerializer`) is built into the core `keyv` package. Alternative serializers are available as separate packages:
* [serialize-superjson](https://github.com/jaredwray/keyv/tree/main/serialization/superjson) - SuperJSON serializer with Date, Map, Set, BigInt support (@keyv/serialize-superjson)
* [serialize-msgpackr](https://github.com/jaredwray/keyv/tree/main/serialization/msgpackr) - High-performance MessagePack serializer (@keyv/serialize-msgpackr)
## Third-party Storage Adapters
We love the community and the third-party storage adapters they have built. They enable Keyv to be used with even more backends and use cases.
View the complete list of third-party storage adapters and learn how to build your own at https://keyv.org/docs/third-party-storage-adapters/
# Contributing
We welcome contributions! Here are some ways to get involved:
* **Pull Requests** - Fork the repo, make your changes, run `pnpm test`, and open a PR. See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions.
* **Issues** - Report bugs or request features by [opening an issue](https://github.com/jaredwray/keyv/issues). For bugs, include replication steps and error messages.
* **Questions** - Create an issue with the label "question" and include relevant context.
* **Storage Adapter Requests** - Create an issue with the label "storage adapter." Requests are given 30-60 days for community interest before being triaged.
* **Security** - See our [security policy](https://github.com/jaredwray/keyv/blob/main/SECURITY.md) for reporting vulnerabilities.
* **Code of Conduct** - Please review our [Code of Conduct](CODE_OF_CONDUCT.md).
# Keyv v5 to v6
We are actively working on Keyv v6, which includes several major changes such as improved TypeScript support, enhanced hooks system, and streamlined storage adapter interfaces. You can follow along with the development and see the full migration guide at https://keyv.org/docs/keyv-v5-to-v6
No major functionality will be added to Keyv v5. Only maintenance and security fixes will be applied going forward.
# License
[MIT © Jared Wray](./LICENSE)