Skip to content

types: compact receiver hovers via public aliases #3248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nkaradzhov merged 1 commit into from
May 21, 2026
+45 −43
Merged

types: compact receiver hovers via public aliases #3248

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions packages/client/lib/client/multi-command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ type CommandSignature<
S extends RedisScripts,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = (...args: Tail<Parameters<C['parseCommand']>>) => InternalRedisClientMultiCommandType<
> = (...args: Tail<Parameters<C['parseCommand']>>) => RedisClientMultiCommandTyped<
[...REPLIES, ReplyWithTypeMapping<CommandReply<C, RESP>, TYPE_MAPPING>],
M,
F,
Expand Down Expand Up @@ -70,7 +70,7 @@ type WithScripts<
[P in keyof S]: CommandSignature<REPLIES, S[P], M, F, S, RESP, TYPE_MAPPING>;
};

type InternalRedisClientMultiCommandType<
export type RedisClientMultiCommandTyped<
// eslint-disable-next-line @typescript-eslint/no-explicit-any -- variance marker for reply tuple
REPLIES extends Array<any>,
M extends RedisModules,
Expand Down Expand Up @@ -99,7 +99,7 @@ export type RedisClientMultiCommandType<
S extends RedisScripts,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = TypedOrAny<isTyped, InternalRedisClientMultiCommandType<REPLIES, M, F, S, RESP, TYPE_MAPPING>>;
> = TypedOrAny<isTyped, RedisClientMultiCommandTyped<REPLIES, M, F, S, RESP, TYPE_MAPPING>>;

type ExecuteMulti = (commands: Array<RedisMultiQueuedCommand>, selectedDB?: number) => Promise<Array<unknown>>;

Expand Down
82 changes: 42 additions & 40 deletions packages/redis/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,107 +35,109 @@ const modules = {
ts: RedisTimeSeries
};

export type RedisDefaultModules = typeof modules;
type RedisStackModules = typeof modules;
export interface RedisDefaultModules extends RedisStackModules {}

export type RedisClientType<
M extends RedisModules = RedisDefaultModules,
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
> = GenericRedisClientType<M, F, S, RESP, TYPE_MAPPING>;
> = GenericRedisClientType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING>;

export type RedisClientPoolType<
M extends RedisModules = RedisDefaultModules,
export function createClient<
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 2,
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
> = GenericRedisClientPoolType<M, F, S, RESP, TYPE_MAPPING>;

export function createClient<
M extends RedisModules,
F extends RedisFunctions,
S extends RedisScripts,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
>(
options?: RedisClientOptions<M, F, S, RESP, TYPE_MAPPING>
): GenericRedisClientType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING> {
): RedisClientType<M, F, S, RESP, TYPE_MAPPING> {
return genericCreateClient({
...options,
modules: {
...modules,
...(options?.modules as M)
}
});
}) as RedisClientType<M, F, S, RESP, TYPE_MAPPING>;
}

export function createClientPool<
M extends RedisModules,
F extends RedisFunctions,
S extends RedisScripts,
RESP extends RespVersions,
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
>(clientOptions?: Omit<RedisClientOptions<M, F, S, RESP, TYPE_MAPPING>, "clientSideCache">,
options?: Partial<RedisPoolOptions>): GenericRedisClientPoolType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING> {
options?: Partial<RedisPoolOptions>): RedisClientPoolType<M, F, S, RESP, TYPE_MAPPING> {
return genericCreateClientPool({
...clientOptions,
modules: {
...modules,
...(clientOptions?.modules as M)
}
}, options);
}, options) as RedisClientPoolType<M, F, S, RESP, TYPE_MAPPING>;
}

export type RedisClientPoolType<
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
> = GenericRedisClientPoolType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING>;

export type RedisClusterType<
M extends RedisModules = RedisDefaultModules,
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
> = genericRedisClusterType<M, F, S, RESP, TYPE_MAPPING>;
> = genericRedisClusterType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING>;

export function createCluster<
M extends RedisModules,
F extends RedisFunctions,
S extends RedisScripts,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
>(
options: RedisClusterOptions<M, F, S, RESP, TYPE_MAPPING>
): RedisClusterType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING> {
): RedisClusterType<M, F, S, RESP, TYPE_MAPPING> {
return genericCreateCluster({
...options,
modules: {
...modules,
...(options?.modules as M)
}
});
}) as RedisClusterType<M, F, S, RESP, TYPE_MAPPING>;
}

export type RedisSentinelType<
M extends RedisModules = RedisDefaultModules,
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
> = genericRedisSentinelType<M, F, S, RESP, TYPE_MAPPING>;
> = genericRedisSentinelType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING>;

export function createSentinel<
M extends RedisModules,
F extends RedisFunctions,
S extends RedisScripts,
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
M extends RedisModules = {},
F extends RedisFunctions = {},
S extends RedisScripts = {},
RESP extends RespVersions = 3,
TYPE_MAPPING extends TypeMapping = {}
>(
options: RedisSentinelOptions<M, F, S, RESP, TYPE_MAPPING>
): RedisSentinelType<RedisDefaultModules & M, F, S, RESP, TYPE_MAPPING> {
): RedisSentinelType<M, F, S, RESP, TYPE_MAPPING> {
return genericCreateSentinel({
...options,
modules: {
...modules,
...(options?.modules as M)
}
});
}) as RedisSentinelType<M, F, S, RESP, TYPE_MAPPING>;
}

Loading