You've already forked node-redis
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:
@@ -1,65 +1,59 @@
|
||||
import { RedisCommandArgument, RedisCommandArguments } from '.';
|
||||
import { AuthOptions } from './AUTH';
|
||||
import { RedisArgument, RespVersions, TuplesToMapReply, BlobStringReply, NumberReply, ArrayReply, UnwrapReply, Resp2Reply, Command } from '../RESP/types';
|
||||
|
||||
interface HelloOptions {
|
||||
protover: number;
|
||||
auth?: Required<AuthOptions>;
|
||||
clientName?: string;
|
||||
export interface HelloOptions {
|
||||
protover?: RespVersions;
|
||||
AUTH?: {
|
||||
username: RedisArgument;
|
||||
password: RedisArgument;
|
||||
};
|
||||
SETNAME?: string;
|
||||
}
|
||||
|
||||
export function transformArguments(options?: HelloOptions): RedisCommandArguments {
|
||||
const args: RedisCommandArguments = ['HELLO'];
|
||||
export type HelloReply = TuplesToMapReply<[
|
||||
[BlobStringReply<'server'>, BlobStringReply],
|
||||
[BlobStringReply<'version'>, BlobStringReply],
|
||||
[BlobStringReply<'proto'>, NumberReply<RespVersions>],
|
||||
[BlobStringReply<'id'>, NumberReply],
|
||||
[BlobStringReply<'mode'>, BlobStringReply],
|
||||
[BlobStringReply<'role'>, BlobStringReply],
|
||||
[BlobStringReply<'modules'>, ArrayReply<BlobStringReply>]
|
||||
]>;
|
||||
|
||||
if (options) {
|
||||
args.push(options.protover.toString());
|
||||
export default {
|
||||
transformArguments(protover?: RespVersions, options?: HelloOptions) {
|
||||
const args: Array<RedisArgument> = ['HELLO'];
|
||||
|
||||
if (options.auth) {
|
||||
args.push('AUTH', options.auth.username, options.auth.password);
|
||||
}
|
||||
if (protover) {
|
||||
args.push(protover.toString());
|
||||
|
||||
if (options.clientName) {
|
||||
args.push('SETNAME', options.clientName);
|
||||
}
|
||||
if (options?.AUTH) {
|
||||
args.push(
|
||||
'AUTH',
|
||||
options.AUTH.username,
|
||||
options.AUTH.password
|
||||
);
|
||||
}
|
||||
|
||||
if (options?.SETNAME) {
|
||||
args.push(
|
||||
'SETNAME',
|
||||
options.SETNAME
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
return args;
|
||||
}
|
||||
|
||||
type HelloRawReply = [
|
||||
_: never,
|
||||
server: RedisCommandArgument,
|
||||
_: never,
|
||||
version: RedisCommandArgument,
|
||||
_: never,
|
||||
proto: number,
|
||||
_: never,
|
||||
id: number,
|
||||
_: never,
|
||||
mode: RedisCommandArgument,
|
||||
_: never,
|
||||
role: RedisCommandArgument,
|
||||
_: never,
|
||||
modules: Array<RedisCommandArgument>
|
||||
];
|
||||
|
||||
interface HelloTransformedReply {
|
||||
server: RedisCommandArgument;
|
||||
version: RedisCommandArgument;
|
||||
proto: number;
|
||||
id: number;
|
||||
mode: RedisCommandArgument;
|
||||
role: RedisCommandArgument;
|
||||
modules: Array<RedisCommandArgument>;
|
||||
}
|
||||
|
||||
export function transformReply(reply: HelloRawReply): HelloTransformedReply {
|
||||
return {
|
||||
server: reply[1],
|
||||
version: reply[3],
|
||||
proto: reply[5],
|
||||
id: reply[7],
|
||||
mode: reply[9],
|
||||
role: reply[11],
|
||||
modules: reply[13]
|
||||
};
|
||||
}
|
||||
},
|
||||
transformReply: {
|
||||
2: (reply: UnwrapReply<Resp2Reply<HelloReply>>) => ({
|
||||
server: reply[1],
|
||||
version: reply[3],
|
||||
proto: reply[5],
|
||||
id: reply[7],
|
||||
mode: reply[9],
|
||||
role: reply[11],
|
||||
modules: reply[13]
|
||||
}),
|
||||
3: undefined as unknown as () => HelloReply
|
||||
}
|
||||
} as const satisfies Command;
|
||||
|
Reference in New Issue
Block a user