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

Properties

closing: Promise<void>
keys: KeysMap
name: string

The name of the queue.

opts: QueueBaseOptions = {}

Options for the queue.

qualifiedName: string
toKey: ((type) => string)

Type declaration

    • (type): string
    • Parameters

      • type: string

      Returns string

Accessors

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

    Returns string

Methods

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

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

    Returns Promise<void>

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

    Parameters

    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

  • Parameters

    Returns Promise<number>

  • Parameters

    • repeatJobKey: string

    Returns Promise<number>

Generated using TypeDoc