redis/node-redis
1
0
Fork 0
mirror of https://github.com/redis/node-redis.git synced 2025-12-12 21:21:15 +03:00
Code Activity

fix(ts): use all commands in cluster type (#3065)

Browse Source 
RedisClusterType was using some type restrictions to
hide some commands based on its properties. In reality,
all commands should be exposed to user ( as in v4 ).

fixes #3064
This commit is contained in:
Nikolay Karadzhov
2025-08-26 16:35:45 +03:00
committed by GitHub
parent 7b56e9a3dc
commit 672246dbd2
2 changed files with 8 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/client/lib/client/index.ts
View File

@@ -146,14 +146,14 @@ export interface RedisClientOptions<
clientInfoTag?: string; clientInfoTag?: string;
} }
type WithCommands< export type WithCommands<
RESP extends RespVersions, RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping TYPE_MAPPING extends TypeMapping
> = { > = {
[P in keyof typeof COMMANDS]: CommandSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING>; [P in keyof typeof COMMANDS]: CommandSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING>;
}; };
type WithModules< export type WithModules<
M extends RedisModules, M extends RedisModules,
RESP extends RespVersions, RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping TYPE_MAPPING extends TypeMapping
@@ -163,7 +163,7 @@ type WithModules<
}; };
}; };
type WithFunctions< export type WithFunctions<
F extends RedisFunctions, F extends RedisFunctions,
RESP extends RespVersions, RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping TYPE_MAPPING extends TypeMapping
@@ -173,7 +173,7 @@ type WithFunctions<
}; };
}; };
type WithScripts< export type WithScripts<
S extends RedisScripts, S extends RedisScripts,
RESP extends RespVersions, RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping TYPE_MAPPING extends TypeMapping

48
packages/client/lib/cluster/index.ts
View File

@@ -1,6 +1,6 @@
import { RedisClientOptions, RedisClientType } from '../client'; import { RedisClientOptions, RedisClientType } from '../client';
import { CommandOptions } from '../client/commands-queue'; import { CommandOptions } from '../client/commands-queue';
import { Command, CommandArguments, CommanderConfig, CommandSignature, /*CommandPolicies, CommandWithPoliciesSignature,*/ TypeMapping, RedisArgument, RedisFunction, RedisFunctions, RedisModules, RedisScript, RedisScripts, ReplyUnion, RespVersions } from '../RESP/types'; import { Command, CommandArguments, CommanderConfig, TypeMapping, RedisArgument, RedisFunction, RedisFunctions, RedisModules, RedisScript, RedisScripts, ReplyUnion, RespVersions } from '../RESP/types';
import COMMANDS from '../commands'; import COMMANDS from '../commands';
import { EventEmitter } from 'node:events'; import { EventEmitter } from 'node:events';
import { attachConfig, functionArgumentsPrefix, getTransformReply, scriptArgumentsPrefix } from '../commander'; import { attachConfig, functionArgumentsPrefix, getTransformReply, scriptArgumentsPrefix } from '../commander';
@@ -13,6 +13,8 @@ import { ClientSideCacheConfig, PooledClientSideCacheProvider } from '../client/
import { BasicCommandParser } from '../client/parser'; import { BasicCommandParser } from '../client/parser';
import { ASKING_CMD } from '../commands/ASKING'; import { ASKING_CMD } from '../commands/ASKING';
import SingleEntryCache from '../single-entry-cache' import SingleEntryCache from '../single-entry-cache'
import { WithCommands, WithFunctions, WithModules, WithScripts } from '../client';
interface ClusterCommander< interface ClusterCommander<
M extends RedisModules, M extends RedisModules,
F extends RedisFunctions, F extends RedisFunctions,
@@ -103,50 +105,6 @@ export interface RedisClusterOptions<
clientSideCache?: PooledClientSideCacheProvider | ClientSideCacheConfig; clientSideCache?: PooledClientSideCacheProvider | ClientSideCacheConfig;
} }
// remove once request & response policies are ready
type ClusterCommand<
NAME extends PropertyKey,
COMMAND extends Command
> = COMMAND['NOT_KEYED_COMMAND'] extends true ? (
COMMAND['IS_FORWARD_COMMAND'] extends true ? NAME : never
) : NAME;
// CommandWithPoliciesSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING, POLICIES>
type WithCommands<
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = {
[P in keyof typeof COMMANDS as ClusterCommand<P, (typeof COMMANDS)[P]>]: CommandSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING>;
};
type WithModules<
M extends RedisModules,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = {
[P in keyof M]: {
[C in keyof M[P] as ClusterCommand<C, M[P][C]>]: CommandSignature<M[P][C], RESP, TYPE_MAPPING>;
};
};
type WithFunctions<
F extends RedisFunctions,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = {
[L in keyof F]: {
[C in keyof F[L] as ClusterCommand<C, F[L][C]>]: CommandSignature<F[L][C], RESP, TYPE_MAPPING>;
};
};
type WithScripts<
S extends RedisScripts,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = {
[P in keyof S as ClusterCommand<P, S[P]>]: CommandSignature<S[P], RESP, TYPE_MAPPING>;
};
export type RedisClusterType< export type RedisClusterType<
M extends RedisModules = {}, M extends RedisModules = {},
F extends RedisFunctions = {}, F extends RedisFunctions = {},