Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RedisConnection

A simple Redis client.

Hierarchy

  • RedisConnection

Implements

  • any

Index

Methods

Methods

batch

  • Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

    Parameters

    Returns PromiseLike<Response>

  • Sends a list of commands in a single IO operation, this prevents any inter twinning to happen from other client users.

    Parameters

    Returns RedisConnection

close

  • close(): PromiseLike<void>
  • close(onClose: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): RedisConnection

  • Closes the connection or returns to the pool.

    Returns PromiseLike<void>

  • Closes the connection or returns to the pool.

    Parameters

    • onClose: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns RedisConnection

endHandler

  • endHandler(endHandler: ((res: void) => void) | Handler<void> | null | undefined): RedisConnection

  • Parameters

    • endHandler: ((res: void) => void) | Handler<void> | null | undefined

    Returns RedisConnection

exceptionHandler

  • exceptionHandler(handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined): RedisConnection

  • Parameters

    • handler: ((res: Throwable) => void) | Handler<Throwable> | null | undefined

    Returns RedisConnection

fetch

  • Parameters

    • amount: number

    Returns RedisConnection

handler

  • Parameters

    Returns RedisConnection

pause

  • Returns RedisConnection

pendingQueueFull

  • pendingQueueFull(): boolean

  • Flag to notify if the pending message queue (commands in transit) is full.

    When the pending message queue is full and a new send command is issued it will result in a exception to be thrown. Checking this flag before sending can allow the application to wait before sending the next message.

    Returns boolean

pipe

  • Returns Pipe<Response>

pipeTo

  • pipeTo(dst: WriteStream<Response>): PromiseLike<void>
  • pipeTo(dst: WriteStream<Response>, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): void

  • Parameters

    Returns PromiseLike<void>

  • Parameters

    • dst: WriteStream<Response>
    • handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

    Returns void

resume

  • Returns RedisConnection

send

  • Send the given command to the redis server or cluster.

    Parameters

    Returns PromiseLike<Response>

  • Send the given command to the redis server or cluster.

    Parameters

    Returns RedisConnection

Generated using TypeDoc