Class default

Hierarchy

default

Constructors

constructor

new default(maxLength: undefined | null | number): default

Parameters
- maxLength: undefined | null | number
Returns default

Properties

`Private` #chainInExecution

#chainInExecution: undefined | symbol

`Private` #decoder

#decoder: default = ...

`Private` `Readonly` #maxLength

#maxLength: undefined | null | number

`Private` `Readonly` #pubSubState

#pubSubState: { isActive: boolean; listeners: { channels: Map<any, any>; patterns: Map<any, any> }; subscribed: number; subscribing: number; unsubscribing: number } = ...

Type declaration

isActive: boolean
listeners: { channels: Map<any, any>; patterns: Map<any, any> }
- channels: Map<any, any>
- patterns: Map<any, any>
subscribed: number
subscribing: number
unsubscribing: number

`Private` `Readonly` #waitingForReply

#waitingForReply: Yallist<CommandWaitingForReply> = ...

`Private` `Readonly` #waitingToBeSent

#waitingToBeSent: Yallist<CommandWaitingToBeSent> = ...

`Static` `Private` `Readonly` #PUB_SUB_MESSAGES

#PUB_SUB_MESSAGES: { message: Buffer; pMessage: Buffer; pSubscribe: Buffer; pUnsubscribe: Buffer; subscribe: Buffer; unsubscribe: Buffer } = ...

Type declaration

message: Buffer
pMessage: Buffer
pSubscribe: Buffer
pUnsubscribe: Buffer
subscribe: Buffer
unsubscribe: Buffer

Methods

`Private` #handlePubSubReply

#handlePubSubReply(reply: any): boolean

Parameters
- reply: any
Returns boolean

`Private` #pushPubSubCommand

#pushPubSubCommand(command: PubSubSubscribeCommands | PubSubUnsubscribeCommands, channels: number | RedisCommandArgument[]): Promise<void>

Parameters
- command: PubSubSubscribeCommands | PubSubUnsubscribeCommands
- channels: number | RedisCommandArgument[]
Returns Promise<void>

`Private` #updatePubSubActiveState

#updatePubSubActiveState(): void

Returns void

addCommand

addCommand<T>(args: RedisCommandArguments, options?: QueueCommandOptions): Promise<T>

Type Parameters
- T = RedisCommandRawReply
Parameters
- args: RedisCommandArguments
- Optional options: QueueCommandOptions
Returns Promise<T>

flushAll

flushAll(err: Error): void

Parameters
- err: Error
Returns void

flushWaitingForReply

flushWaitingForReply(err: Error): void

Parameters
- err: Error
Returns void

getCommandToSend

getCommandToSend(): undefined | RedisCommandArguments

Returns undefined | RedisCommandArguments

onReplyChunk

onReplyChunk(chunk: Buffer): void

Parameters
- chunk: Buffer
Returns void

resubscribe

resubscribe(): undefined | Promise<any>

Returns undefined | Promise<any>

subscribe<T>(command: PubSubSubscribeCommands, channels: RedisCommandArgument | RedisCommandArgument[], listener: PubSubListener<T, T extends true ? Buffer : string>, returnBuffers?: T): Promise<void>

Type Parameters
- T extends boolean
Parameters
- command: PubSubSubscribeCommands
- channels: RedisCommandArgument | RedisCommandArgument[]
- listener: PubSubListener<T, T extends true ? Buffer : string>
- Optional returnBuffers: T
Returns Promise<void>

unsubscribe

unsubscribe<T>(command: PubSubUnsubscribeCommands, channels?: string | string[], listener?: PubSubListener<T, T extends true ? Buffer : string>, returnBuffers?: T): Promise<void>

Type Parameters
- T extends boolean
Parameters
- command: PubSubUnsubscribeCommands
- Optional channels: string | string[]
- Optional listener: PubSubListener<T, T extends true ? Buffer : string>
- Optional returnBuffers: T
Returns Promise<void>

`Static` `Private` #emitPubSubMessage

#emitPubSubMessage(listenersMap: PubSubListenersMap, message: Buffer, channel: Buffer, pattern?: Buffer): void

Parameters
- listenersMap: PubSubListenersMap
- message: Buffer
- channel: Buffer
- Optional pattern: Buffer
Returns void

`Static` `Private` #flushQueue

#flushQueue<T>(queue: Yallist<T>, err: Error): void

Type Parameters
- T extends CommandWaitingForReply
Parameters
- queue: Yallist<T>
- err: Error
Returns void

Class default

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

maxLength: undefined | null | number

Returns default

Properties

Private #chainInExecution

Private #decoder

Private Readonly #maxLength

Private Readonly #pubSubState

Type declaration

isActive: boolean

listeners: { channels: Map<any, any>; patterns: Map<any, any> }

channels: Map<any, any>

patterns: Map<any, any>

subscribed: number

subscribing: number

unsubscribing: number

Private Readonly #waitingForReply

Private Readonly #waitingToBeSent

Static Private Readonly #PUB_SUB_MESSAGES

Type declaration

message: Buffer

pMessage: Buffer

pSubscribe: Buffer

pUnsubscribe: Buffer

subscribe: Buffer

unsubscribe: Buffer

Methods

Private #handlePubSubReply

Parameters

reply: any

Returns boolean

Private #pushPubSubCommand

Parameters

command: PubSubSubscribeCommands | PubSubUnsubscribeCommands

channels: number | RedisCommandArgument[]

Returns Promise<void>

Private #updatePubSubActiveState

Returns void

addCommand

Type Parameters

T = RedisCommandRawReply

Parameters

args: RedisCommandArguments

Optional options: QueueCommandOptions

Returns Promise<T>

flushAll

Parameters

err: Error

Returns void

flushWaitingForReply

Parameters

err: Error

Returns void

getCommandToSend

Returns undefined | RedisCommandArguments

onReplyChunk

Parameters

chunk: Buffer

Returns void

resubscribe

Returns undefined | Promise<any>

subscribe

Type Parameters

T extends boolean

Parameters

command: PubSubSubscribeCommands

channels: RedisCommandArgument | RedisCommandArgument[]

listener: PubSubListener<T, T extends true ? Buffer : string>

Optional returnBuffers: T

Returns Promise<void>

unsubscribe

Type Parameters

`Private` #chainInExecution

`Private` #decoder

`Private` `Readonly` #maxLength

`Private` `Readonly` #pubSubState

`Private` `Readonly` #waitingForReply

`Private` `Readonly` #waitingToBeSent

`Static` `Private` `Readonly` #PUB_SUB_MESSAGES

`Private` #handlePubSubReply

`Private` #pushPubSubCommand

`Private` #updatePubSubActiveState

`Optional` options: QueueCommandOptions

`Optional` returnBuffers: T

`Optional` channels: string | string[]

`Optional` listener: PubSubListener<T, T extends true ? Buffer : string>

`Optional` returnBuffers: T

`Static` `Private` #emitPubSubMessage

`Optional` pattern: Buffer

`Static` `Private` #flushQueue