https://github.com/vasilyvp/kv-structures
JavaScript data structures for various storage engines
https://github.com/vasilyvp/kv-structures
data-structures javascript redis
Last synced: 5 months ago
JSON representation
JavaScript data structures for various storage engines
- Host: GitHub
- URL: https://github.com/vasilyvp/kv-structures
- Owner: VasilyVP
- Created: 2024-12-12T04:00:39.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-19T16:58:35.000Z (8 months ago)
- Last Synced: 2025-04-30T05:04:18.227Z (5 months ago)
- Topics: data-structures, javascript, redis
- Language: TypeScript
- Homepage:
- Size: 168 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @kv-structures
## Overview
`@kv-structures` is a repository of packages to provide native JavaScript data structures (`Map`, `Set`, etc.) for use with various storage engines. The goal of this repository is to offer an abstraction layer that allows developers to interact with different storage backends in the same way they would with built-in JavaScript structures, like `Map` or `Set`.
This package aims to create a seamless experience where you can store and retrieve data using familiar JavaScript APIs while leveraging the strengths of various storage systems, including Redis, DynamoDB, and more.
## Key Features
- **Unified API**: Interact with data structures like `Map`, `Set`, and others across different storage engines.
- **Flexible Storage Backends**: Start with Redis and expand to other engines like Cloudflare KV, and more.
- **Seamless Integration**: Easily integrate Redis-backed data structures (such as `RedisMap` and `RedisSet`) into your application.
- **Future-proof**: The library will grow to support more storage backends, providing the same intuitive API for each.
## Installation
To install the whole package, add to the `.npmrc`
```bash
@vasilyvp:registry=https://npm.pkg.github.com/
```
and run:
```bash
npm install @vasilyvp/kv-structures
```
## Usage
```typescript
import { redisInit, redisQuit, RedisMap } from '@vasilyvp/kv-structures';
await redisInit(); // Call this method once at the start of the app
const map = new RedisMap('myMap', 60000); // Name and optional TTL (in ms)
await map.set('myKey', 'myValue');
const value = await map.get('myKey'); // 'myValue'
await redisQuit();
```
Refer to the specific engine's documentation for more details.
## Available specific engines
### [`@kv-structures/redis`](https://github.com/vasilyvp/kv-structures/tree/main/packages/redis)
This package is a Redis-specific package that implements Redis-backed data structures for use in JavaScript applications. You can think of [`@kv-structures/redis`](https://github.com/vasilyvp/kv-structures/tree/main/packages/redis) as one of the engines available through `@kv-structures`.
## License
This project is licensed under the [ISC License](https://opensource.org/licenses/ISC).