1
0
mirror of https://github.com/redis/node-redis.git synced 2025-08-06 02:15:48 +03:00

V5 bringing RESP3, Sentinel and TypeMapping to node-redis

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
This commit is contained in:
Shaya Potter
2024-10-15 17:46:52 +03:00
committed by GitHub
parent 2fc79bdfb3
commit b2d35c5286
1174 changed files with 45931 additions and 36274 deletions

View File

@@ -1,57 +1,49 @@
import { RedisCommandArgument, RedisCommandArguments } from '.';
export interface XReadGroupStream {
key: RedisCommandArgument;
id: RedisCommandArgument;
}
import { Command, RedisArgument, ReplyUnion } from '../RESP/types';
import { transformStreamsMessagesReplyResp2 } from './generic-transformers';
import XREAD, { XReadStreams, pushXReadStreams } from './XREAD';
export interface XReadGroupOptions {
COUNT?: number;
BLOCK?: number;
NOACK?: true;
COUNT?: number;
BLOCK?: number;
NOACK?: boolean;
}
export const FIRST_KEY_INDEX = (
_group: RedisCommandArgument,
_consumer: RedisCommandArgument,
streams: Array<XReadGroupStream> | XReadGroupStream
): RedisCommandArgument => {
return Array.isArray(streams) ? streams[0].key : streams.key;
};
export const IS_READ_ONLY = true;
export function transformArguments(
group: RedisCommandArgument,
consumer: RedisCommandArgument,
streams: Array<XReadGroupStream> | XReadGroupStream,
export default {
FIRST_KEY_INDEX(
_group: RedisArgument,
_consumer: RedisArgument,
streams: XReadStreams
) {
return XREAD.FIRST_KEY_INDEX(streams);
},
IS_READ_ONLY: true,
transformArguments(
group: RedisArgument,
consumer: RedisArgument,
streams: XReadStreams,
options?: XReadGroupOptions
): RedisCommandArguments {
) {
const args = ['XREADGROUP', 'GROUP', group, consumer];
if (options?.COUNT) {
args.push('COUNT', options.COUNT.toString());
if (options?.COUNT !== undefined) {
args.push('COUNT', options.COUNT.toString());
}
if (typeof options?.BLOCK === 'number') {
args.push('BLOCK', options.BLOCK.toString());
if (options?.BLOCK !== undefined) {
args.push('BLOCK', options.BLOCK.toString());
}
if (options?.NOACK) {
args.push('NOACK');
args.push('NOACK');
}
args.push('STREAMS');
const streamsArray = Array.isArray(streams) ? streams : [streams],
argsLength = args.length;
for (let i = 0; i < streamsArray.length; i++) {
const stream = streamsArray[i];
args[argsLength + i] = stream.key;
args[argsLength + streamsArray.length + i] = stream.id;
}
pushXReadStreams(args, streams);
return args;
}
export { transformStreamsMessagesReply as transformReply } from './generic-transformers';
},
transformReply: {
2: transformStreamsMessagesReplyResp2,
3: undefined as unknown as () => ReplyUnion
},
unstableResp3: true,
} as const satisfies Command;