You've already forked node-redis
mirror of
https://github.com/redis/node-redis.git
synced 2025-08-04 15:02:09 +03:00
b2d35c5286
RESP3 Support - Some commands responses in RESP3 aren't stable yet and therefore return an "untyped" ReplyUnion. Sentinel TypeMapping Correctly types Multi commands Note: some API changes to be further documented in v4-to-v5.md
39 lines
902 B
Markdown
39 lines
902 B
Markdown
# RESP3 Support
|
|
|
|
TODO
|
|
|
|
```javascript
|
|
const client = createClient({
|
|
RESP: 3
|
|
});
|
|
```
|
|
|
|
```javascript
|
|
// by default
|
|
await client.hGetAll('key'); // Record<string, string>
|
|
|
|
await client.withTypeMapping({
|
|
[TYPES.MAP]: Map
|
|
}).hGetAll('key'); // Map<string, string>
|
|
|
|
await client.withTypeMapping({
|
|
[TYPES.MAP]: Map,
|
|
[TYPES.BLOB_STRING]: Buffer
|
|
}).hGetAll('key'); // Map<string, Buffer>
|
|
```
|
|
|
|
# Sentinel Support
|
|
|
|
[TODO](./sentinel.md)
|
|
|
|
# `multi.exec<'typed'>` / `multi.execTyped`
|
|
|
|
We have introduced the ability to perform a "typed" `MULTI`/`EXEC` transaction. Rather than returning `Array<ReplyUnion>`, a transaction invoked with `.exec<'typed'>` will return types appropriate to the commands in the transaction where possible:
|
|
|
|
```javascript
|
|
const multi = client.multi().ping();
|
|
await multi.exec(); // Array<ReplyUnion>
|
|
await multi.exec<'typed'>(); // [string]
|
|
await multi.execTyped(); // [string]
|
|
```
|