Class JobQueue

This class is used to represent queues of jobs waiting to be executed.

Hierarchy

  • RedisStore
    • JobQueue

Constructors

constructor

Properties

client credentialManager name

Methods

disconnect getJobById isEmpty length peek pop push

Constructors

constructor

Properties

Protected client

client: RedisClientType

Private credentialManager

credentialManager: CredentialManager = ...

Private name

name: string

Methods

disconnect

  • disconnect(): Promise<void>

  • Returns Promise<void>

Private getJobById

  • getJobById(id): Promise<null | Job>
  • Private

    Gets a job by the jobId. Also populates the job's credentials.

    Parameters

    • id: string

      jobId

    Returns Promise<null | Job>

    job with the given jobId

isEmpty

  • isEmpty(): Promise<boolean>

  • Returns whether the queue is empty.

    Returns Promise<boolean>

    true if empty; false otherwise

length

  • length(): Promise<number>

  • Returns the length of the redis queue.

    Returns Promise<number>

    length

peek

  • peek(): Promise<null | Job>

  • Returns the job at the front of the queue without mutating the queue.

    Returns Promise<null | Job>

    the job at the front or undefined if empty

pop

  • pop(): Promise<null | Job>

  • Shifts everything in the queue forwards and pops out the job at the front.

    Returns Promise<null | Job>

    the popped out job

push

  • push(item): Promise<void>

  • Pushes a job onto the queue.

    Parameters

    • item: Job

      the job to push

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

constructorclientcredentialManagernamedisconnectgetJobByIdisEmptylengthpeekpoppush

Generated using TypeDoc