Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ItemQueue<ItemT>

Queue to process items async

Type parameters

  • ItemT = unknown

Hierarchy

  • EventEmitter
    • ItemQueue

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private Promise

Promise: PromiseConstructor

Private _concurrency

_concurrency: number

Private _deferred

_deferred: boolean

Private _empty

_empty: boolean

Private _failed

_failed: boolean | Error

Private _id

_id: number

Private _itemQ

_itemQ: ItemQueueData<ItemT>[]

Private _pause

_pause: boolean

Private _pending

_pending: Inflight<unknown>

Private _processItem

_processItem: ProcessCb<ItemT>

Private _processing

_processing: boolean

Private _startTime

_startTime: number

Private _stopOnError

_stopOnError: boolean

Private _timeout

_timeout: number

Private _watchPeriod

_watchPeriod: number

Private _watchTime

_watchTime: number

Private _watchTimer

_watchTimer: any

Private _watched

_watched: boolean

Static Private Promise

Promise: PromiseConstructor = ...

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean

Sets or gets the default captureRejection value for all emitters.

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Accessors

count

  • get count(): number

  • get the total items still left in the queue, including those that are being processed.

    Returns number

isPause

  • get isPause(): boolean

isPending

  • get isPending(): boolean

Static pauseItem

  • get pauseItem(): symbol

  • Get the special item to add to the queue so processing will pause when it's reached

    Returns symbol

Methods

Private _emit

Private _emitDone

  • _emitDone(): void

Private _emitEmpty

  • _emitEmpty(): void

Private _handleQueueItemDone

Private _pendingWatcher

  • _pendingWatcher(): void

Private _process

  • _process(): number

Private _setupWatch

  • _setupWatch(): void

Private _wrap

  • _wrap(item: symbol | ItemT, stopOnError?: boolean): ItemQueueData<ItemT>

addItem

  • addItem(item: ItemT, noStart?: boolean, stopOnError?: boolean): ItemQueue<ItemT>

  • add an item to the end of the queue

    Parameters

    • item: ItemT

      item to add

    • Optional noStart: boolean

      if true then don't start processing

    • Optional stopOnError: boolean

      stop if error occurred for this item

    Returns ItemQueue<ItemT>

    instance self

addItems

  • addItems(items: ItemT[], noStart?: boolean): ItemQueue<ItemT>

  • add an array of items to the end of the queue

    Parameters

    • items: ItemT[]

      items to add

    • Optional noStart: boolean

      if true then don't start processing

    Returns ItemQueue<ItemT>

    instance self

addListener

  • addListener(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

deferProcess

  • deferProcess(): void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]

  • Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

off

  • off(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

on

  • on(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

once

  • once(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

pause

prependListener

  • prependListener(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

rawListeners

  • rawListeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): ItemQueue<ItemT>

  • Parameters

    • Optional event: string | symbol

    Returns ItemQueue<ItemT>

removeListener

  • removeListener(event: string | symbol, listener: (...args: any[]) => void): ItemQueue<ItemT>

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns ItemQueue<ItemT>

resume

setItemQ

  • setItemQ(itemQ: ItemT[], noStart?: boolean): ItemQueue<ItemT>

  • replace current array of items with a new one for processing

    Parameters

    • itemQ: ItemT[]

      array of items

    • Optional noStart: boolean

      don't start processing after adding

    Returns ItemQueue<ItemT>

    item q instance itself

setMaxListeners

  • setMaxListeners(n: number): ItemQueue<ItemT>

  • Parameters

    • n: number

    Returns ItemQueue<ItemT>

start

unpause

  • mark the queue to unpause.

    NOTE: this doesn't actually start the processing. Typically you should use resume to unpause and start processing.

    Returns ItemQueue<ItemT>

    instance self

wait

  • wait(): Promise<void>

  • Wait for the queue to finish processing items

    • while processing, events are emitted for each item

    Returns Promise<void>

    promise that wait for queue to finish

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Static on

  • on(emitter: EventEmitter, event: string): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string

    Returns AsyncIterableIterator<any>

Static once

  • once(emitter: NodeEventTarget, event: string | symbol): Promise<any[]>
  • once(emitter: DOMEventTarget, event: string): Promise<any[]>

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string

    Returns Promise<any[]>

Generated using TypeDoc