Class default

Hierarchy

default

Index

Constructors

Properties

#executor #firstKey #multi EXEC

Methods

addCommand commandsExecutor exec execAsPipeline functionsExecutor scriptsExecutor extend

Constructors

constructor

new default(executor: RedisClusterMultiExecutor, firstKey?: RedisCommandArgument): default

Parameters
- executor: RedisClusterMultiExecutor
- Optional firstKey: RedisCommandArgument
Returns default

Properties

`Private` `Readonly` #executor

#executor: RedisClusterMultiExecutor

`Private` #firstKey

#firstKey: undefined | RedisCommandArgument

`Private` `Readonly` #multi

#multi: default = ...

EXEC

EXEC: ((execAsPipeline?: boolean) => Promise<RedisCommandRawReply[]>) = ...

Type declaration

- (execAsPipeline?: boolean): Promise<RedisCommandRawReply[]>
- Parameters
  - execAsPipeline: boolean = false
  Returns Promise<RedisCommandRawReply[]>

Methods

addCommand

addCommand(firstKey: undefined | RedisCommandArgument, args: RedisCommandArguments, transformReply?: ((this: void, reply: any, preserved?: any) => any)): default

Parameters
- firstKey: undefined | RedisCommandArgument
- args: RedisCommandArguments
- Optional transformReply: ((this: void, reply: any, preserved?: any) => any)
  - - (this: void, reply: any, preserved?: any): any
    - Parameters
      
      this: void
      
      reply: any
      
      Optional preserved: any
      
      Returns any
Returns default

commandsExecutor

commandsExecutor(command: RedisCommand, args: unknown[]): default

Parameters
- command: RedisCommand
- args: unknown[]
Returns default

exec

exec(execAsPipeline?: boolean): Promise<RedisCommandRawReply[]>

Parameters
- execAsPipeline: boolean = false
Returns Promise<RedisCommandRawReply[]>

execAsPipeline

execAsPipeline(): Promise<RedisCommandRawReply[]>

Returns Promise<RedisCommandRawReply[]>

functionsExecutor

functionsExecutor(fn: RedisFunction, args: unknown[], name: string): default

Parameters
- fn: RedisFunction
- args: unknown[]
- name: string
Returns default

scriptsExecutor

scriptsExecutor(script: RedisScript, args: unknown[]): default

Parameters
- script: RedisScript
- args: unknown[]
Returns default

`Static` extend

extend<M, F, S>(extensions?: RedisExtensions<M, F, S>): InstantiableRedisClusterMultiCommandType<M, F, S>

Type Parameters
- M extends RedisModules
- F extends RedisFunctions
- S extends RedisScripts
Parameters
- Optional extensions: RedisExtensions<M, F, S>
Returns InstantiableRedisClusterMultiCommandType<M, F, S>

Generated using TypeDoc