Class MemoryQueue

constructor

• new MemoryQueue(config?: Partial<ConnectionConfig>): MemoryQueue

  Parameters

  • config: Partial<ConnectionConfig> = {}

    The connection options.

  Returns MemoryQueue

Readonlyname

ack

• ack(job: Job): Promise<void>

  Parameters

  • job: Job

  Returns Promise<void>

  Inherit Doc

clear

• clear(queue?: string): Promise<void>

  Parameters

  • Optionalqueue: string

  Returns Promise<void>

  Inherit Doc

dispatch

• dispatch<T = unknown>(
      name: string,
      payload: T,
      options?: JobOptions,
  ): Promise<string>

  Type Parameters

  • T = unknown

  Parameters

  • name: string
  • payload: T
  • options: JobOptions = {}

  Returns Promise<string>

  Inherit Doc

fail

• fail(job: Job, _error: Error): Promise<void>

  Parameters

  • job: Job
  • _error: Error

  Returns Promise<void>

  Inherit Doc

failedJobs

• failedJobs(): Job<any>[]

  The dead-letter jobs (failed after exhausting attempts). Not part of the contract; useful for inspection and tests.

  Returns Job<any>[]

  The failed jobs.

later

• later<T = unknown>(
      delay: number,
      name: string,
      payload: T,
      options?: JobOptions,
  ): Promise<string>

  Type Parameters

  • T = unknown

  Parameters

  • delay: number
  • name: string
  • payload: T
  • options: JobOptions = {}

  Returns Promise<string>

  Inherit Doc

release

• release(job: Job, delay?: number): Promise<void>

  Parameters

  • job: Job
  • delay: number = 0

  Returns Promise<void>

  Inherit Doc

reserve

• reserve(queue?: string): Promise<Job<any>>

  Parameters

  • Optionalqueue: string

  Returns Promise<Job<any>>

  Inherit Doc

size

• size(queue?: string): Promise<number>

  Parameters

  • Optionalqueue: string

  Returns Promise<number>

  Inherit Doc

Staticcreate

• create(config?: Partial<ConnectionConfig>): MemoryQueue

  Create a memory queue.

  Parameters

  • config: Partial<ConnectionConfig> = {}

    The connection options.

  Returns MemoryQueue

  A new connection.