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

EventEmitter
- QueueBase

Index

Constructors

Properties

closing keys name opts toKey

Accessors

client redisVersion

Methods

close disconnect emit waitUntilReady

Constructors

constructor

new QueueBase(name: string, opts?: QueueBaseOptions, Connection?: typeof RedisConnection): 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.
Returns QueueBase
Overrides EventEmitter.constructor
- Defined in classes/queue-base.ts:32

Properties

closing

closing: Promise<void>

keys

`Readonly` name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = {}

Options for the queue.

toKey

toKey: ((type: string) => string)

Type declaration

- (type: string): string
- Parameters
  - type: string
  Returns string

Accessors

client

get client(): Promise<RedisClient>
Returns a promise that resolves to a redis client. Normally used only by subclasses.

Returns Promise<RedisClient>
- Defined in classes/queue-base.ts:76

redisVersion

get redisVersion(): string
Returns the version of the Redis instance the client is connected to,

Returns string
- Defined in classes/queue-base.ts:83

Methods

close

close(): Promise<void>
Returns
Closes the connection and returns a promise that resolves when the connection is closed.

Returns Promise<void>
- Defined in classes/queue-base.ts:131

disconnect

disconnect(): Promise<void>
Force disconnects a connection.

Returns Promise<void>
- Defined in classes/queue-base.ts:142

emit

emit(event: string | symbol, ...args: any[]): boolean
Emits an event. Normally used by subclasses to emit events.

Returns
Parameters
- event: string | symbol
  
  The emitted event.
- Rest ...args: any[]
Returns boolean
Overrides EventEmitter.emit
- Defined in classes/queue-base.ts:101

waitUntilReady

waitUntilReady(): Promise<RedisClient>
Returns Promise<RedisClient>
- Defined in classes/queue-base.ts:114

Generated using TypeDoc