Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RealQueueClass

This class should be minimal so we can control the queue items itself.

see

https://github.com/sindresorhus/p-queue#custom-RealQueueClass

see

https://github.com/sindresorhus/p-queue/blob/76b81cd707a6cd31b41f25e5d7fa8abc7486c4bf/source/priority-queue.ts#L12

Hierarchy

  • RealQueueClass

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Returns RealQueueClass

Properties

Private _handler

_handler: RealQueue

Private alreadyAddedJobIds

alreadyAddedJobIds: number[] = []

Private queue

queue: Array<RealQueueOptions & { run: RunFunction }> = []

Accessors

handler

  • Returns RealQueue

size

  • get size(): number

  • Returns number

Methods

dequeue

  • Returns RunFunction | undefined

enqueue

  • Parameters

    Returns void

enqueueFromList

  • enqueueFromList(list: Array<Job>): void

  • Parameters

    • list: Array<Job>

    Returns void

filter

  • Parameters

    Returns RunFunction[]

filterQueueItem

Private listenDeletions

  • listenDeletions(): void

  • Listen if jobs got deleted, remove them from the queue so they never get executed again.

    Returns void

Private listenRetries

  • listenRetries(): void

  • Listen if jobs got retried, remove them from the queue so they can be added again.

    Returns void

Private removeByType

  • removeByType(type: string, forgetAboutAlreadyAdded?: boolean): void

  • Parameters

    • type: string
    • Default value forgetAboutAlreadyAdded: boolean = true

    Returns void

setHandler

  • setHandler(handler: RealQueueClass["handler"]): void

  • Parameters

    • handler: RealQueueClass["handler"]

    Returns void

Generated using TypeDoc