Class QueueBase

constructor

• new QueueBase(
      name: string,
      opts?: QueueBaseOptions,
      Connection?: typeof RedisConnection,
      hasBlockingConnection?: boolean,
  ): QueueBase

  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.

  • hasBlockingConnection: boolean = false

  Returns QueueBase

closing

keys

Readonlyname

opts

ReadonlyqualifiedName

scripts

toKey

client

• get client(): Promise<IRedisClient>

  Returns a promise that resolves to a redis client. Normally used only by subclasses.

  Returns Promise<IRedisClient>

databaseType

• get databaseType(): DatabaseType

  Returns the database type of the Redis instance the client is connected to,

  Returns DatabaseType

redisVersion

• get redisVersion(): string

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

  Returns string

close

• close(): Promise<void>

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

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Force disconnects a connection.

  Returns 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.

  • ...args: any[]

    The arguments to pass to the event listeners.

  Returns boolean

  True if the event had listeners, false otherwise.

trace

• trace<T>(
      spanKind: SpanKind,
      operation: string,
      destination: string,
      callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>,
      srcPropagationMetadata?: string,
  ): Promise<T | Promise<T>>

  Wraps the code with telemetry and provides a span for configuration.

  Type Parameters

  • T

  Parameters

  • spanKind: SpanKind

    kind of the span: Producer, Consumer, Internal

  • operation: string

    operation name (such as add, process, etc)

  • destination: string

    destination name (normally the queue name)

  • callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>

    code to wrap with telemetry

  • OptionalsrcPropagationMetadata: string

    The source propagation metadata for telemetry context.

  Returns Promise<T | Promise<T>>

  The result of the callback function.

waitUntilReady

• waitUntilReady(): Promise<IRedisClient>

  Returns Promise<IRedisClient>