Class default

Hierarchy

default

Constructors

constructor

new default(maxLength: undefined | null | number, onShardedChannelMoved: OnShardedChannelMoved): default
Parameters
- maxLength: undefined | null | number
- onShardedChannelMoved: OnShardedChannelMoved
Returns default
- Defined in packages/client/lib/client/commands-queue.ts:99

Properties

`Private` #chainInExecution

#chainInExecution: undefined | symbol

`Private` #decoder

#decoder: default = ...

`Private` `Readonly` #maxLength

#maxLength: undefined | null | number

`Private` `Readonly` #onShardedChannelMoved

#onShardedChannelMoved: OnShardedChannelMoved

`Private` `Readonly` #pubSub

#pubSub: PubSub = ...

`Private` `Readonly` #waitingForReply

#waitingForReply: Yallist<CommandWaitingForReply> = ...

`Private` `Readonly` #waitingToBeSent

#waitingToBeSent: Yallist<CommandWaitingToBeSent> = ...

Accessors

isPubSubActive

get isPubSubActive(): boolean
Returns boolean
- Defined in packages/client/lib/client/commands-queue.ts:49

Methods

`Private` #pushPubSubCommand

#pushPubSubCommand(command: PubSubCommand): undefined | Promise<void>
Parameters
- command: PubSubCommand
Returns undefined | Promise<void>
- Defined in packages/client/lib/client/commands-queue.ts:197

addCommand

addCommand<T>(args: RedisCommandArguments, options?: QueueCommandOptions): Promise<T>
Type Parameters
- T = RedisCommandRawReply
Parameters
- args: RedisCommandArguments
- Optional options: QueueCommandOptions
Returns Promise<T>
- Defined in packages/client/lib/client/commands-queue.ts:107

extendPubSubChannelListeners

extendPubSubChannelListeners(type: PubSubType, channel: string, listeners: ChannelListeners): undefined | Promise<void>
Parameters
- type: PubSubType
- channel: string
- listeners: ChannelListeners
Returns undefined | Promise<void>
- Defined in packages/client/lib/client/commands-queue.ts:177

extendPubSubListeners

extendPubSubListeners(type: PubSubType, listeners: PubSubTypeListeners): undefined | Promise<void>
Parameters
- type: PubSubType
- listeners: PubSubTypeListeners
Returns undefined | Promise<void>
- Defined in packages/client/lib/client/commands-queue.ts:187

flushAll

flushAll(err: Error): void
Parameters
- err: Error
Returns void
- Defined in packages/client/lib/client/commands-queue.ts:257

flushWaitingForReply

flushWaitingForReply(err: Error): void
Parameters
- err: Error
Returns void
- Defined in packages/client/lib/client/commands-queue.ts:243

getCommandToSend

getCommandToSend(): undefined | RedisCommandArguments
Returns undefined | RedisCommandArguments
- Defined in packages/client/lib/client/commands-queue.ts:217

getPubSubListeners

getPubSubListeners(type: PubSubType): PubSubTypeListeners
Parameters
- type: PubSubType
Returns PubSubTypeListeners
- Defined in packages/client/lib/client/commands-queue.ts:193

onReplyChunk

onReplyChunk(chunk: Buffer): void
Parameters
- chunk: Buffer
Returns void
- Defined in packages/client/lib/client/commands-queue.ts:239

resubscribe

resubscribe(): undefined | Promise<any>
Returns undefined | Promise<any>
- Defined in packages/client/lib/client/commands-queue.ts:168

subscribe<T>(type: PubSubType, channels: string | string[], listener: PubSubListener<T>, returnBuffers?: T): undefined | Promise<void>
Type Parameters
- T extends boolean
Parameters
- type: PubSubType
- channels: string | string[]
- listener: PubSubListener<T>
- Optional returnBuffers: T
Returns undefined | Promise<void>
- Defined in packages/client/lib/client/commands-queue.ts:146

unsubscribe

unsubscribe<T>(type: PubSubType, channels?: string | string[], listener?: PubSubListener<T>, returnBuffers?: T): undefined | Promise<void>
Type Parameters
- T extends boolean
Parameters
- type: PubSubType
- Optional channels: string | string[]
- Optional listener: PubSubListener<T>
- Optional returnBuffers: T
Returns undefined | Promise<void>
- Defined in packages/client/lib/client/commands-queue.ts:157

`Static` `Private` #flushQueue

#flushQueue<T>(queue: Yallist<T>, err: Error): void
Type Parameters
- T extends CommandWaitingForReply
Parameters
- queue: Yallist<T>
- err: Error
Returns void
- Defined in packages/client/lib/client/commands-queue.ts:36

Class default

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

maxLength: undefined | null | number

onShardedChannelMoved: OnShardedChannelMoved

Returns default

Properties

Private #chainInExecution

Private #decoder

Private Readonly #maxLength

Private Readonly #onShardedChannelMoved

Private Readonly #pubSub

Private Readonly #waitingForReply

Private Readonly #waitingToBeSent

Accessors

isPubSubActive

Returns boolean

Methods

Private #pushPubSubCommand

Parameters

command: PubSubCommand

Returns undefined | Promise<void>

addCommand

Type Parameters

T = RedisCommandRawReply

Parameters

args: RedisCommandArguments

Optional options: QueueCommandOptions

Returns Promise<T>

extendPubSubChannelListeners

Parameters

type: PubSubType

channel: string

listeners: ChannelListeners

Returns undefined | Promise<void>

extendPubSubListeners

Parameters

type: PubSubType

listeners: PubSubTypeListeners

Returns undefined | Promise<void>

flushAll

Parameters

err: Error

Returns void

flushWaitingForReply

Parameters

err: Error

Returns void

getCommandToSend

Returns undefined | RedisCommandArguments

getPubSubListeners

Parameters

type: PubSubType

Returns PubSubTypeListeners

onReplyChunk

Parameters

chunk: Buffer

Returns void

resubscribe

Returns undefined | Promise<any>

subscribe

Type Parameters

T extends boolean

Parameters

type: PubSubType

channels: string | string[]

listener: PubSubListener<T>

Optional returnBuffers: T

Returns undefined | Promise<void>

unsubscribe

Type Parameters

T extends boolean

Parameters

`Private` #chainInExecution

`Private` #decoder

`Private` `Readonly` #maxLength

`Private` `Readonly` #onShardedChannelMoved

`Private` `Readonly` #pubSub

`Private` `Readonly` #waitingForReply

`Private` `Readonly` #waitingToBeSent

`Private` #pushPubSubCommand

`Optional` options: QueueCommandOptions

`Optional` returnBuffers: T

`Optional` channels: string | string[]

`Optional` listener: PubSubListener<T>

`Optional` returnBuffers: T

`Static` `Private` #flushQueue