https://github.com/iuioiua/redis
Lightning-fast, lightweight and reliable Redis client for all major JavaScript runtimes. Built upon the Streams API.
https://github.com/iuioiua/redis
bun cloudflare-workers deno nodejs redis streams-api web-browsers
Last synced: about 1 month ago
JSON representation
Lightning-fast, lightweight and reliable Redis client for all major JavaScript runtimes. Built upon the Streams API.
- Host: GitHub
- URL: https://github.com/iuioiua/redis
- Owner: iuioiua
- License: mit
- Created: 2024-12-03T06:44:27.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-03-26T06:20:05.000Z (about 2 months ago)
- Last Synced: 2025-03-26T06:31:45.715Z (about 2 months ago)
- Topics: bun, cloudflare-workers, deno, nodejs, redis, streams-api, web-browsers
- Language: TypeScript
- Homepage: https://jsr.io/@iuioiua/redis
- Size: 86.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# @iuioiua/redis
[](https://jsr.io/@iuioiua/redis)
[](https://github.com/iuioiua/redis/actions/workflows/ci.yml)
Minimal [Redis](https://redis.io/) client for all major JavaScript runtimes,
including the browser. Fast, lightweight and built upon the
[Streams API](https://developer.mozilla.org/en-US/docs/Web/API/Streams_API).
```ts ignore
import { RedisClient } from "@iuioiua/redis";
import { assertEquals } from "@std/assert/equals";
const redisConn = await Deno.connect({ port: 6379 });
const redisClient = new RedisClient(redisConn);
const reply1 = await redisClient.sendCommand(["SET", "hello", "world"]);
assertEquals(reply1, "OK");
const reply2 = await redisClient.sendCommand(["GET", "hello"]);
assertEquals(reply2, "world");
```
## Features
- Capable of handling 1000s of requests per second.
- More than 12x smaller than the next major Redis client in Deno.
- Supports RESPv2, RESP3, raw data, pipelining, pub/sub, transactions and Lua
scripts.
- Compatible with all major JavaScript runtimes including
[Bun](https://bun.sh/), [Cloudflare Workers](https://workers.cloudflare.com/),
[Deno](https://deno.com/), [Node.js](https://nodejs.org/en) and the browser!
- Cleanly written to be easily understood and debugged.
- Compatible with timeouts and retries.
- Encourages the use of actual Redis commands without intermediate abstractions,
resulting in fewer moving parts.
## Resources
- [Demo](https://iuioiua-redis-demo.deno.dev/)
- [Documentation](https://jsr.io/@iuioiua/redis/doc)
- [Contributing guidelines](./CONTRIBUTING.md)
- [Test coverage](https://iuioiua-redis-coverage.deno.dev/)
## Known issues
### Replies containing CRLF
This package currently doesn't correctly read replies that contain CRLF (`\r\n`)
within the message. For example, if a bulk string contains a CRLF, it'll only
return the message, up to that CLRF. The simple workaround for this is to use LF
(`\n`) for delimiting newlines, instead of CRLF.
> If this issue affects you, please open a
> [new issue](https://github.com/iuioiua/redis/issues/new). Otherwise, this
> issue is a "won't fix".
## Design
Like Italian cooking, the design of this package is defined by what it doesn't
do rather than what it does do, and relies upon high-quality building blocks. It
doesn't extend the functionality of a TCP connection. It doesn't implement a
method for each Redis command, of which there are hundreds. Instead, the Redis
client consumes a TCP connection, lets the user write Redis commands, and
returns the parsed result according to the RESP data type. The result is a
design with fewer moving parts, fewer bugs, less maintenance, and a smaller
footprint than other JavaScript implementations of Redis clients.
| Module | Size (KB) | Dependencies |
| ------------------ | --------- | ------------ |
| jsr:@iuioiua/redis | 17.51 | 3 |
| jsr:@db/redis | 214.31 | 34 |
| npm:ioredis | 894.69 | 10 |
| npm:redis | 951.12 | 9 |
> Note: Results were produced const `deno info ` on March 9, 2025.