Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueueListener<DataType, ResultType, NameType>

Type parameters

  • DataType

  • ResultType

  • NameType: string

Hierarchy

Index

Methods

  • cleaned(jobs: string[], type: string): void
  • Listen to 'cleaned' event.

    This event is triggered when the queue calls clean method.

    Parameters

    • jobs: string[]
    • type: string

    Returns void

  • error(err: Error): void
  • Listen to 'error' event.

    This event is triggered when an error is thrown.

    Parameters

    • err: Error

    Returns void

  • ioredis:close(): void
  • paused(): void
  • Listen to 'paused' event.

    This event is triggered when the queue is paused.

    Returns void

  • progress(job: Job<DataType, ResultType, NameType>, progress: number | object): void
  • Listen to 'progress' event.

    This event is triggered when the job updates its progress.

    Parameters

    • job: Job<DataType, ResultType, NameType>
    • progress: number | object

    Returns void

  • removed(job: Job<DataType, ResultType, NameType>): void
  • Listen to 'removed' event.

    This event is triggered when a job is removed.

    Parameters

    • job: Job<DataType, ResultType, NameType>

    Returns void

  • resumed(): void
  • Listen to 'resumed' event.

    This event is triggered when the queue is resumed.

    Returns void

  • waiting(job: Job<DataType, ResultType, NameType>): void
  • Listen to 'waiting' event.

    This event is triggered when the queue creates a new job.

    Parameters

    • job: Job<DataType, ResultType, NameType>

    Returns void

Generated using TypeDoc