Class Repeat

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 (view full)

QueueBase
- Repeat

Index

Constructors

Properties

closing keys name opts qualifiedName toKey

Accessors

client redisVersion

Methods

addNextRepeatableJob close disconnect emit getRepeatableCount getRepeatableJobs removeRepeatable removeRepeatableByKey waitUntilReady

Constructors

constructor

new Repeat(name, opts, Connection?): Repeat
Parameters
- name: string
- opts: RepeatBaseOptions
- Optional Connection: typeof RedisConnection
Returns Repeat
Overrides QueueBase.constructor
- Defined in classes/repeat.ts:13

Properties

closing

closing: Promise<void>

keys

`Readonly` name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = ...

Options for the queue.

`Readonly` qualifiedName

qualifiedName: string

toKey

toKey: ((type) => string)

Type declaration

- (type): 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>
Inherited from QueueBase.client
- Defined in classes/queue-base.ts:80

redisVersion

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

Returns string
Inherited from QueueBase.redisVersion
- Defined in classes/queue-base.ts:91

Methods

addNextRepeatableJob

addNextRepeatableJob<T, R, N>(name, data, opts, skipCheckExists?): Promise<Job<T, R, N>>
Type Parameters
- T = any
- R = any
- N extends string = string
Parameters
- name: N
- data: T
- opts: JobsOptions
- Optional skipCheckExists: boolean
Returns Promise<Job<T, R, N>>
- Defined in classes/repeat.ts:27

close

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

Returns Promise<void>
Inherited from QueueBase.close
- Defined in classes/queue-base.ts:140

disconnect

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

Returns Promise<void>
Inherited from QueueBase.disconnect
- Defined in classes/queue-base.ts:152

emit

emit(event, ...args): boolean
Emits an event. Normally used by subclasses to emit events.
Parameters
- event: string | symbol
  The emitted event.
- Rest ...args: any[]
Returns boolean
Inherited from QueueBase.emit
- Defined in classes/queue-base.ts:109

getRepeatableCount

getRepeatableCount(): Promise<number>
Returns Promise<number>
- Defined in classes/repeat.ts:208

getRepeatableJobs

getRepeatableJobs(start?, end?, asc?): Promise<RepeatableJob[]>
Parameters
- start: number = 0
- end: number = -1
- asc: boolean = false
Returns Promise<RepeatableJob[]>
- Defined in classes/repeat.ts:189

removeRepeatable

removeRepeatable(name, repeat, jobId?): Promise<number>
Parameters
- name: string
- repeat: RepeatOptions
- Optional jobId: string
Returns Promise<number>
- Defined in classes/repeat.ts:144

removeRepeatableByKey

removeRepeatableByKey(repeatJobKey): Promise<number>
Parameters
- repeatJobKey: string
Returns Promise<number>
- Defined in classes/repeat.ts:161

waitUntilReady

waitUntilReady(): Promise<RedisClient>
Returns Promise<RedisClient>
Inherited from QueueBase.waitUntilReady
- Defined in classes/queue-base.ts:123

Generated using TypeDoc