Options
All
  • Public
  • Public/Protected
  • All
Menu

Class QueueBase

description

Base class for all classes that need to interact with queues. This class is normally not used directly, but extended by the other classes.

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • name: string

      The name of the queue.

    • opts: QueueBaseOptions = {}

      Options for the queue.

    • Connection: typeof RedisConnection = RedisConnection

      An optional "Connection" class used to instantiate a Connection. This is useful for testing with mockups and/or extending the Connection class and passing an alternate implementation.

    Returns QueueBase

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

Readonly name

name: string

opts

opts: QueueBaseOptions = {}

toKey

toKey: (type: string) => string

Type declaration

    • (type: string): string

    • Parameters

      • type: string

      Returns string

Accessors

client

redisVersion

  • get redisVersion(): string

  • Returns the version of the Redis instance the client is connected to,

    Returns string

Methods

close

  • close(): Promise<void>

  • Returns Promise<void>

    Closes the connection and returns a promise that resolves when the connection is closed.

disconnect

  • disconnect(): Promise<void>

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Emits an event. Normally used by subclasses to emit events.

    Parameters

    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

waitUntilReady

Generated using TypeDoc