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 Summary)

QueueBase
- Repeat

Index

Constructors

Properties

closing keys name opts toKey

Accessors

client redisVersion

Methods

addNextRepeatableJob close disconnect emit getRepeatableCount getRepeatableJobs removeRepeatable removeRepeatableByKey waitUntilReady

Constructors

constructor

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

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

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:76

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:83

Methods

addNextRepeatableJob

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

close

close(): Promise<void>
Returns Promise<void>
Closes the connection and returns a promise that resolves when the connection is closed.
Inherited from QueueBase.close
- Defined in classes/queue-base.ts:131

disconnect

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

Returns Promise<void>
Inherited from QueueBase.disconnect
- 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.
Parameters
- event: string | symbol
  The emitted event.
- ...args: any[]
Returns boolean
Inherited from QueueBase.emit
- Defined in classes/queue-base.ts:101

getRepeatableCount

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

getRepeatableJobs

getRepeatableJobs(
    start?: number,
    end?: number,
    asc?: boolean,
): Promise<
    {
        cron: string;
        endDate: number;
        id: string;
        key: string;
        name: string;
        next: number;
        pattern: string;
        tz: string;
    }[],
>
Parameters
- start: number = 0
- end: number = -1
- asc: boolean = false
Returns Promise<
    {
        cron: string;
        endDate: number;
        id: string;
        key: string;
        name: string;
        next: number;
        pattern: string;
        tz: string;
    }[],
>
- Defined in classes/repeat.ts:178

removeRepeatable

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

removeRepeatableByKey

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

waitUntilReady

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