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

Constructors

constructor

Properties

closing keys name opts toKey

Accessors

client redisVersion

Methods

addNextRepeatableJob close disconnect emit getRepeatableCount getRepeatableJobs removeRepeatable removeRepeatableByKey waitUntilReady

Constructors

constructor

  • Parameters

    • name: string
    • Optional opts: RepeatBaseOptions
    • Optional Connection: typeof RedisConnection

    Returns Repeat

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

Readonly name

name: string

opts

opts: QueueBaseOptions

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>

redisVersion

  • get redisVersion(): string

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

    Returns string

Methods

addNextRepeatableJob

  • 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

  • Returns Promise<void>

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

disconnect

  • Force disconnects a connection.

    Returns Promise<void>

emit

  • Emits an event. Normally used by subclasses to emit events.

    Parameters

    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

getRepeatableCount

  • Returns Promise<number>

getRepeatableJobs

  • Parameters

    • Optional start: number
    • Optional end: number
    • Optional asc: boolean

    Returns Promise<{
        cron: string;
        endDate: number;
        id: string;
        key: string;
        name: string;
        next: number;
        pattern: string;
        tz: string;
    }[]>

removeRepeatable

  • Parameters

    • name: string
    • repeat: RepeatOptions
    • Optional jobId: string

    Returns Promise<number>

removeRepeatableByKey

  • Parameters

    • repeatJobKey: string

    Returns Promise<number>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc