Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AsyncWorkerQueue<T>

Type parameters

Hierarchy

  • EventEmitter
    • AsyncWorkerQueue

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

_done

_done: number = 0

_error

_error: number = 0

_inc

_inc: number = 0

_paused

_paused: boolean = false

active

active: QueueJob<T>[] = []

logger

logger: ILoggerApi

options

options: IAsyncQueueOptions

processor

processor: IQueueProcessor<T>

runningTasks

runningTasks: number = 0

worker

worker: QueueJob<T>[] = []

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.

Methods

addListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

amount

  • amount(): number

await

  • await(): Promise<void>

Private drained

  • drained(): void

emit

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

  • Parameters

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

    Returns boolean

Private enqueue

enqueued

  • enqueued(): number

eventNames

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

  • Returns (string | symbol)[]

Private fireProcess

  • fireProcess(): void

getMaxListeners

  • getMaxListeners(): number

  • Returns number

isIdle

  • isIdle(): boolean

isOccupied

  • isOccupied(): boolean

isPaused

  • isPaused(): boolean

isRunning

  • isRunning(): boolean

listenerCount

  • listenerCount(event: string | symbol): number

  • Parameters

    • event: string | symbol

    Returns number

listeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

Private next

  • next(): void

off

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

on

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

once

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

pause

  • pause(): Promise<boolean>

prependListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

prependOnceListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

Private process

  • process(): void

push

rawListeners

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

  • Parameters

    • event: string | symbol

    Returns Function[]

removeAllListeners

  • Parameters

    • Optional event: string | symbol

    Returns AsyncWorkerQueue<T>

removeListener

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

  • Parameters

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

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns AsyncWorkerQueue<T>

resume

  • resume(): void

running

  • running(): number

setMaxListeners

  • Parameters

    • n: number

    Returns AsyncWorkerQueue<T>

shutdown

  • shutdown(doAwait?: boolean): Promise<void>

status

  • status(): IAsyncQueueStats

Static getEventListener

  • getEventListener(emitter: EventEmitter | DOMEventTarget, name: string | symbol): Function[]

  • Returns a list listener for a specific emitter event name.

    Parameters

    • emitter: EventEmitter | DOMEventTarget
    • name: string | symbol

    Returns Function[]

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, options?: StaticEventEmitterOptions): AsyncIterableIterator<any>

  • Parameters

    • emitter: EventEmitter
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns AsyncIterableIterator<any>

Static once

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

  • Parameters

    • emitter: NodeEventTarget
    • event: string | symbol
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

  • Parameters

    • emitter: DOMEventTarget
    • event: string
    • Optional options: StaticEventEmitterOptions

    Returns Promise<any[]>

Generated using TypeDoc