Class Repeat

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)

Constructors

constructor

Properties

closing keys name opts toKey

Accessors

client redisVersion

Methods

addNextRepeatableJob close disconnect emit getRepeatableCount getRepeatableJobs removeRepeatable removeRepeatableByKey waitUntilReady

Constructors

constructor

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

Readonly name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = {}

Options for the queue.

toKey

toKey: ((type) => string)

Type declaration

    • (type): 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

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

close

  • close(): Promise<void>

  • Returns Promise<void>

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

disconnect

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

getRepeatableCount

getRepeatableJobs

  • getRepeatableJobs(start?, end?, asc?): Promise<{
        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<{
        endDate: number;
        id: string;
        key: string;
        name: string;
        next: number;
        pattern: string;
        tz: string;
    }[]>

removeRepeatable

  • removeRepeatable(name, repeat, jobId?): Promise<number>

  • Parameters

    Returns Promise<number>

removeRepeatableByKey

  • removeRepeatableByKey(repeatJobKey): Promise<number>

  • Parameters

    • repeatJobKey: string

    Returns Promise<number>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc