Class Repeat

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: QueueBaseOptions
    • 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 Promise<RedisClient>

redisVersion

  • get redisVersion(): string

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

disconnect

  • Returns Promise<void>

emit

  • Parameters

    • event: string | symbol
    • 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;
        tz: string;
    }[]>

removeRepeatable

  • Parameters

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

    Returns Promise<void>

removeRepeatableByKey

  • Parameters

    • repeatJobKey: string

    Returns Promise<void>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc