Skip to content
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

DOC-5043 sample of Cursor AI-generated doc comments #2918

Closed
wants to merge 1 commit into from
Closed

DOC-5043 sample of Cursor AI-generated doc comments #2918

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
95 changes: 92 additions & 3 deletions packages/client/lib/RESP/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,22 @@ import { RedisScriptConfig, SHA1 } from '../lua-script';
import { RESP_TYPES } from './decoder';
import { VerbatimString } from './verbatim-string';

/**
* Type definition for RESP (Redis Serialization Protocol) types.
*/
export type RESP_TYPES = typeof RESP_TYPES;

/**
* Union type of all possible RESP types.
*/
export type RespTypes = RESP_TYPES[keyof RESP_TYPES];

// using interface(s) to allow circular references
// type X = BlobStringReply | ArrayReply<X>;

/**
* Base interface for all RESP types.
*/
export interface RespType<
RESP_TYPE extends RespTypes,
DEFAULT,
Expand All @@ -24,18 +33,27 @@ export interface RespType<
TYPE_MAPPING: MappedType<TYPE_MAPPING>;
}

/**
* Represents a NULL response in Redis.
*/
export interface NullReply extends RespType<
RESP_TYPES['NULL'],
null
> {}

/**
* Represents a boolean response in Redis.
*/
export interface BooleanReply<
T extends boolean = boolean
> extends RespType<
RESP_TYPES['BOOLEAN'],
T
> {}

/**
* Represents a numeric response in Redis.
*/
export interface NumberReply<
T extends number = number
> extends RespType<
Expand All @@ -45,6 +63,9 @@ export interface NumberReply<
number | string
> {}

/**
* Represents a big number response in Redis.
*/
export interface BigNumberReply<
T extends bigint = bigint
> extends RespType<
Expand All @@ -54,6 +75,9 @@ export interface BigNumberReply<
bigint | number | string
> {}

/**
* Represents a double-precision floating point response in Redis.
*/
export interface DoubleReply<
T extends number = number
> extends RespType<
Expand All @@ -63,6 +87,9 @@ export interface DoubleReply<
number | string
> {}

/**
* Represents a simple string response in Redis.
*/
export interface SimpleStringReply<
T extends string = string
> extends RespType<
Expand All @@ -72,6 +99,9 @@ export interface SimpleStringReply<
string | Buffer
> {}

/**
* Represents a bulk string response in Redis.
*/
export interface BlobStringReply<
T extends string = string
> extends RespType<
Expand All @@ -83,6 +113,9 @@ export interface BlobStringReply<
toString(): string
}

/**
* Represents a verbatim string response in Redis.
*/
export interface VerbatimStringReply<
T extends string = string
> extends RespType<
Expand All @@ -92,39 +125,57 @@ export interface VerbatimStringReply<
string | Buffer | VerbatimString
> {}

/**
* Represents a simple error response in Redis.
*/
export interface SimpleErrorReply extends RespType<
RESP_TYPES['SIMPLE_ERROR'],
SimpleError,
Buffer
> {}

/**
* Represents a bulk error response in Redis.
*/
export interface BlobErrorReply extends RespType<
RESP_TYPES['BLOB_ERROR'],
BlobError,
Buffer
> {}

/**
* Represents an array response in Redis.
*/
export interface ArrayReply<T> extends RespType<
RESP_TYPES['ARRAY'],
Array<T>,
never,
Array<any>
> {}

/**
* Represents a tuple response in Redis.
*/
export interface TuplesReply<T extends [...Array<unknown>]> extends RespType<
RESP_TYPES['ARRAY'],
T,
never,
Array<any>
> {}

/**
* Represents a set response in Redis.
*/
export interface SetReply<T> extends RespType<
RESP_TYPES['SET'],
Array<T>,
Set<T>,
Array<any> | Set<any>
> {}

/**
* Represents a map response in Redis.
*/
export interface MapReply<K, V> extends RespType<
RESP_TYPES['MAP'],
{ [key: string]: V },
Expand Down Expand Up @@ -222,8 +273,14 @@ export type ReplyWithTypeMapping<

export type TransformReply = (this: void, reply: any, preserve?: any, typeMapping?: TypeMapping) => any; // TODO;

/**
* Type definition for Redis command arguments.
*/
export type RedisArgument = string | Buffer;

/**
* Type definition for Redis command arguments with optional preserve flag.
*/
export type CommandArguments = Array<RedisArgument> & { preserve?: unknown };

// export const REQUEST_POLICIES = {
Expand Down Expand Up @@ -273,6 +330,9 @@ export type CommandArguments = Array<RedisArgument> & { preserve?: unknown };
// response?: ResponsePolicies | null;
// };

/**
* Interface defining a Redis command.
*/
export type Command = {
CACHEABLE?: boolean;
IS_READ_ONLY?: boolean;
Expand All @@ -289,21 +349,41 @@ export type Command = {
unstableResp3?: boolean;
};

/**
* Type definition for Redis commands.
*/
export type RedisCommands = Record<string, Command>;

/**
* Type definition for Redis modules.
*/
export type RedisModules = Record<string, RedisCommands>;

/**
* Interface extending Command for Redis functions.
*/
export interface RedisFunction extends Command {
NUMBER_OF_KEYS?: number;
}

/**
* Type definition for Redis functions.
*/
export type RedisFunctions = Record<string, Record<string, RedisFunction>>;

/**
* Type definition for Redis scripts.
*/
export type RedisScript = RedisScriptConfig & SHA1;

/**
* Type definition for Redis scripts collection.
*/
export type RedisScripts = Record<string, RedisScript>;

// TODO: move to Commander?
/**
* Interface for Redis commander configuration.
*/
export interface CommanderConfig<
M extends RedisModules,
F extends RedisFunctions,
Expand All @@ -314,11 +394,11 @@ export interface CommanderConfig<
functions?: F;
scripts?: S;
/**
* TODO
* The RESP protocol version to use (2 or 3)
*/
RESP?: RESP;
/**
* TODO
* Whether to use unstable RESP3 features
*/
unstableResp3?: boolean;
}
Expand Down Expand Up @@ -350,8 +430,14 @@ export type Resp2Reply<RESP3REPLY> = (
RESP3REPLY
);

/**
* Type definition for RESP protocol versions (2 or 3).
*/
export type RespVersions = 2 | 3;

/**
* Type definition for command replies.
*/
export type CommandReply<
COMMAND extends Command,
RESP extends RespVersions
Expand All @@ -364,6 +450,9 @@ export type CommandReply<
ReplyUnion
);

/**
* Type definition for command signatures.
*/
export type CommandSignature<
COMMAND extends Command,
RESP extends RespVersions,
Expand Down
47 changes: 47 additions & 0 deletions packages/client/lib/client/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ import { RedisPoolOptions, RedisClientPool } from './pool';
import { RedisVariadicArgument, parseArgs, pushVariadicArguments } from '../commands/generic-transformers';
import { BasicCommandParser, CommandParser } from './parser';

/**
* Interface defining options for creating a Redis client.
*/
export interface RedisClientOptions<
M extends RedisModules = RedisModules,
F extends RedisFunctions = RedisFunctions,
Expand Down Expand Up @@ -82,13 +85,24 @@ export interface RedisClientOptions<
commandOptions?: CommandOptions<TYPE_MAPPING>;
}

/**
* Type mapping Redis commands to their signatures.
* @template RESP - RESP protocol version
* @template TYPE_MAPPING - Type mapping for Redis responses
*/
type WithCommands<
RESP extends RespVersions,
TYPE_MAPPING extends TypeMapping
> = {
[P in keyof typeof COMMANDS]: CommandSignature<(typeof COMMANDS)[P], RESP, TYPE_MAPPING>;
};

/**
* Type mapping Redis modules to their command signatures.
* @template M - Redis modules type
* @template RESP - RESP protocol version
* @template TYPE_MAPPING - Type mapping for Redis responses
*/
type WithModules<
M extends RedisModules,
RESP extends RespVersions,
Expand All @@ -99,6 +113,12 @@ type WithModules<
};
};

/**
* Type mapping Redis functions to their command signatures.
* @template F - Redis functions type
* @template RESP - RESP protocol version
* @template TYPE_MAPPING - Type mapping for Redis responses
*/
type WithFunctions<
F extends RedisFunctions,
RESP extends RespVersions,
Expand All @@ -109,6 +129,12 @@ type WithFunctions<
};
};

/**
* Type mapping Redis scripts to their command signatures.
* @template S - Redis scripts type
* @template RESP - RESP protocol version
* @template TYPE_MAPPING - Type mapping for Redis responses
*/
type WithScripts<
S extends RedisScripts,
RESP extends RespVersions,
Expand All @@ -117,6 +143,9 @@ type WithScripts<
[P in keyof S]: CommandSignature<S[P], RESP, TYPE_MAPPING>;
};

/**
* Type combining all Redis client extensions (commands, modules, functions, scripts).
*/
export type RedisClientExtensions<
M extends RedisModules = {},
F extends RedisFunctions = {},
Expand All @@ -130,6 +159,9 @@ export type RedisClientExtensions<
WithScripts<S, RESP, TYPE_MAPPING>
);

/**
* Type definition for a Redis client with all its extensions.
*/
export type RedisClientType<
M extends RedisModules = {},
F extends RedisFunctions = {},
Expand All @@ -141,16 +173,31 @@ export type RedisClientType<
RedisClientExtensions<M, F, S, RESP, TYPE_MAPPING>
);

/**
* Type for a proxy client that can handle any Redis modules, functions, scripts, and RESP versions.
*/
type ProxyClient = RedisClient<any, any, any, any, any>;

/**
* Type for a namespace proxy client that contains a reference to the underlying proxy client.
*/
type NamespaceProxyClient = { _self: ProxyClient };

/**
* Interface defining options for scan iterators.
*/
interface ScanIteratorOptions {
cursor?: RedisArgument;
}

/**
* Type definition for a monitor callback function.
*/
export type MonitorCallback<TYPE_MAPPING extends TypeMapping = TypeMapping> = (reply: ReplyWithTypeMapping<SimpleStringReply, TYPE_MAPPING>) => unknown;

/**
* The main Redis client class that handles connections, commands, and pub/sub functionality.
*/
export default class RedisClient<
M extends RedisModules,
F extends RedisFunctions,
Expand Down
Loading
Loading