Module lib/commands/generic-transformers

Index

Enumerations

Interfaces

Type aliases

Type aliases

BitValue

BitValue: 0 | 1

CommandRawReply

CommandRawReply: [name: string, arity: number, flags: CommandFlags[], firstKeyIndex: number, lastKeyIndex: number, step: number, categories: CommandCategories[]]

CommandReply

CommandReply: { arity: number; categories: Set<CommandCategories>; firstKeyIndex: number; flags: Set<CommandFlags>; lastKeyIndex: number; name: string; step: number }

Type declaration

arity: number
categories: Set<CommandCategories>
firstKeyIndex: number
flags: Set<CommandFlags>
lastKeyIndex: number
name: string
step: number

FunctionListRawItemReply

FunctionListRawItemReply: ["library_name", string, "engine", string, "functions", ["name", string, "description", string | null, "flags", RedisFunctionFlags[]][]]

GeoSearchBy

GeoSearchBy: GeoSearchByRadius | GeoSearchByBox

GeoSearchFrom

GeoSearchFrom: GeoSearchFromMember | GeoCoordinates

GeoUnits

GeoUnits: "m" | "km" | "mi" | "ft"

ListSide

ListSide: "LEFT" | "RIGHT"

SortedSetSide

SortedSetSide: "MIN" | "MAX"

StreamMessagesReply

StreamMessagesReply: StreamMessageReply[]

StreamsMessagesReply

StreamsMessagesReply: { messages: StreamMessagesReply; name: RedisCommandArgument }[] | null

Functions

evalFirstKeyIndex

evalFirstKeyIndex(options?: EvalOptions): string | undefined

- Defined in packages/client/lib/commands/generic-transformers.ts:351
Parameters
- Optional options: EvalOptions
Returns string | undefined

pushEvalArguments

pushEvalArguments(args: string[], options?: EvalOptions): string[]

- Defined in packages/client/lib/commands/generic-transformers.ts:355
Parameters
- args: string[]
- Optional options: EvalOptions
Returns string[]

pushGeoCountArgument

pushGeoCountArgument(args: RedisCommandArguments, count: undefined | GeoCountArgument): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:211
Parameters
- args: RedisCommandArguments
- count: undefined | GeoCountArgument
Returns RedisCommandArguments

pushGeoSearchArguments

pushGeoSearchArguments(args: RedisCommandArguments, key: RedisCommandArgument, from: GeoSearchFrom, by: GeoSearchBy, options?: GeoSearchOptions): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:257
Parameters
- args: RedisCommandArguments
- key: RedisCommandArgument
- from: GeoSearchFrom
- by: GeoSearchBy
- Optional options: GeoSearchOptions
Returns RedisCommandArguments

pushOptionalVerdictArgument

pushOptionalVerdictArgument(args: RedisCommandArguments, name: RedisCommandArgument, value: undefined | RedisCommandArgument | RedisCommandArgument[]): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:410
Parameters
- args: RedisCommandArguments
- name: RedisCommandArgument
- value: undefined | RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments

pushScanArguments

pushScanArguments(args: RedisCommandArguments, cursor: number, options?: ScanOptions): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:18
Parameters
- args: RedisCommandArguments
- cursor: number
- Optional options: ScanOptions
Returns RedisCommandArguments

pushSlotRangesArguments

pushSlotRangesArguments(args: RedisCommandArguments, ranges: SlotRange | SlotRange[]): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:602
Parameters
- args: RedisCommandArguments
- ranges: SlotRange | SlotRange[]
Returns RedisCommandArguments

pushSortArguments

pushSortArguments(args: RedisCommandArguments, options?: SortOptions): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:554
Parameters
- args: RedisCommandArguments
- Optional options: SortOptions
Returns RedisCommandArguments

pushVerdictArgument

pushVerdictArgument(args: RedisCommandArguments, value: RedisCommandArgument | RedisCommandArgument[]): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:397
Parameters
- args: RedisCommandArguments
- value: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments

pushVerdictArguments

pushVerdictArguments(args: RedisCommandArguments, value: RedisCommandArgument | RedisCommandArgument[]): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:372
Parameters
- args: RedisCommandArguments
- value: RedisCommandArgument | RedisCommandArgument[]
Returns RedisCommandArguments

pushVerdictNumberArguments

pushVerdictNumberArguments(args: RedisCommandArguments, value: number | number[]): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:382
Parameters
- args: RedisCommandArguments
- value: number | number[]
Returns RedisCommandArguments

transformBooleanArrayReply

transformBooleanArrayReply(reply: number[]): boolean[]

- Defined in packages/client/lib/commands/generic-transformers.ts:7
Parameters
- reply: number[]
Returns boolean[]

transformBooleanReply

transformBooleanReply(reply: number): boolean

- Defined in packages/client/lib/commands/generic-transformers.ts:3
Parameters
- reply: number
Returns boolean

transformCommandReply

transformCommandReply(this: void, __namedParameters: CommandRawReply): CommandReply

- Defined in packages/client/lib/commands/generic-transformers.ts:483
Parameters
- this: void
- __namedParameters: CommandRawReply
Returns CommandReply

transformEXAT

transformEXAT(EXAT: number | Date): string

- Defined in packages/client/lib/commands/generic-transformers.ts:338
Parameters
- EXAT: number | Date
Returns string

transformFunctionListItemReply

transformFunctionListItemReply(reply: FunctionListRawItemReply): FunctionListItemReply

- Defined in packages/client/lib/commands/generic-transformers.ts:531
Parameters
- reply: FunctionListRawItemReply
Returns FunctionListItemReply

transformGeoMembersWithReply

transformGeoMembersWithReply(reply: any[][], replyWith: GeoReplyWith[]): GeoReplyWithMember[]

- Defined in packages/client/lib/commands/generic-transformers.ts:305
Parameters
- reply: any[][]
- replyWith: GeoReplyWith[]
Returns GeoReplyWithMember[]

transformLMPopArguments

transformLMPopArguments(args: RedisCommandArguments, keys: RedisCommandArgument | RedisCommandArgument[], side: ListSide, options?: LMPopOptions): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:189
Parameters
- args: RedisCommandArguments
- keys: RedisCommandArgument | RedisCommandArgument[]
- side: ListSide
- Optional options: LMPopOptions
Returns RedisCommandArguments

transformNumberInfinityArgument

transformNumberInfinityArgument(num: number): string

- Defined in packages/client/lib/commands/generic-transformers.ts:59
Parameters
- num: number
Returns string

transformNumberInfinityNullArrayReply

transformNumberInfinityNullArrayReply(reply: (null | RedisCommandArgument)[]): (number | null)[]

- Defined in packages/client/lib/commands/generic-transformers.ts:55
Parameters
- reply: (null | RedisCommandArgument)[]
Returns (number | null)[]

transformNumberInfinityNullReply

transformNumberInfinityNullReply(reply: null | RedisCommandArgument): number | null

- Defined in packages/client/lib/commands/generic-transformers.ts:49
Parameters
- reply: null | RedisCommandArgument
Returns number | null

transformNumberInfinityReply

transformNumberInfinityReply(reply: RedisCommandArgument): number

- Defined in packages/client/lib/commands/generic-transformers.ts:36
Parameters
- reply: RedisCommandArgument
Returns number

transformPXAT

transformPXAT(PXAT: number | Date): string

- Defined in packages/client/lib/commands/generic-transformers.ts:342
Parameters
- PXAT: number | Date
Returns string

transformSortedSetMemberNullReply

transformSortedSetMemberNullReply(reply: [RedisCommandArgument, RedisCommandArgument] | []): ZMember | null

- Defined in packages/client/lib/commands/generic-transformers.ts:129
Parameters
- reply: [RedisCommandArgument, RedisCommandArgument] | []
Returns ZMember | null

transformSortedSetMemberReply

transformSortedSetMemberReply(reply: [RedisCommandArgument, RedisCommandArgument]): ZMember

- Defined in packages/client/lib/commands/generic-transformers.ts:137
Parameters
- reply: [RedisCommandArgument, RedisCommandArgument]
Returns ZMember

transformSortedSetWithScoresReply

transformSortedSetWithScoresReply(reply: RedisCommandArgument[]): ZMember[]

- Defined in packages/client/lib/commands/generic-transformers.ts:147
Parameters
- reply: RedisCommandArgument[]
Returns ZMember[]

transformStreamMessagesReply

transformStreamMessagesReply(reply: any[]): StreamMessagesReply

- Defined in packages/client/lib/commands/generic-transformers.ts:97
Parameters
- reply: any[]
Returns StreamMessagesReply

transformStreamsMessagesReply

transformStreamsMessagesReply(reply: null | any[]): StreamsMessagesReply | null

- Defined in packages/client/lib/commands/generic-transformers.ts:115
Parameters
- reply: null | any[]
Returns StreamsMessagesReply | null

transformStringNumberInfinityArgument

transformStringNumberInfinityArgument(num: number | RedisCommandArgument): RedisCommandArgument

- Defined in packages/client/lib/commands/generic-transformers.ts:72
Parameters
- num: number | RedisCommandArgument
Returns RedisCommandArgument

transformTuplesReply

transformTuplesReply(reply: RedisCommandArgument[]): Record<string, RedisCommandArgument>

- Defined in packages/client/lib/commands/generic-transformers.ts:78
Parameters
- reply: RedisCommandArgument[]
Returns Record<string, RedisCommandArgument>

transformZMPopArguments

transformZMPopArguments(args: RedisCommandArguments, keys: RedisCommandArgument | RedisCommandArgument[], side: SortedSetSide, options?: ZMPopOptions): RedisCommandArguments

- Defined in packages/client/lib/commands/generic-transformers.ts:166
Parameters
- args: RedisCommandArguments
- keys: RedisCommandArgument | RedisCommandArgument[]
- side: SortedSetSide
- Optional options: ZMPopOptions
Returns RedisCommandArguments

Generated using TypeDoc