WorkerQueue - v0.4.0
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • EventTypes: string | symbol | {}

Hierarchy

  • EventEmitter
    • Queue

Index

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly id

id: string

ID de la Queue

Private options

options: QueueOptions

Options de la Queue

Private pending

pending: number

Indique le nombre de tâches en attente de complétion

Private running

running: boolean

Indique si la Queue est en cours de traitement

Private tasks

tasks: Task[]

Array des tasks

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Accessors

isPaused

  • get isPaused(): boolean

  • Returns boolean

isRunning

  • get isRunning(): boolean

  • Returns boolean

length

  • get length(): number

  • Returns number

Methods

add

  • add(task: Task): void

  • Ajoute une tâche à la Queue

    Parameters

    • task: Task

      Tâche à ajouter

    Returns void

addListener

  • addListener<T>(event: T, fn: ListenerFn<EventArgs<EventTypes, T>>, context?: any): this

  • Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any

    Returns this

emit

  • emit<T>(event: T, ...args: EventArgs<EventTypes, T>): boolean

  • Calls each of the listeners registered for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • Rest ...args: EventArgs<EventTypes, T>

    Returns boolean

end

  • end(error?: any): void

  • Parameters

    • Optional error: any

    Returns void

eventNames

  • eventNames(): Array<EventNames<EventTypes>>

  • Return an array listing the events for which the emitter has registered listeners.

    Returns Array<EventNames<EventTypes>>

listenerCount

  • listenerCount(event: EventNames<EventTypes>): number

  • Return the number of listeners listening to a given event.

    Parameters

    • event: EventNames<EventTypes>

    Returns number

listeners

  • listeners<T>(event: T): Array<ListenerFn<EventArgs<EventTypes, T>>>

  • Return the listeners registered for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T

    Returns Array<ListenerFn<EventArgs<EventTypes, T>>>

Private next

  • next(error: any | null, task: Task): void

  • Parameters

    • error: any | null
    • task: Task

    Returns void

off

  • off<T>(event: T, fn?: EventEmitter.ListenerFn<EventArgs<EventTypes, T>>, context?: any, once?: undefined | false | true): this

  • Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • Optional fn: EventEmitter.ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any
    • Optional once: undefined | false | true

    Returns this

on

  • on<T>(event: T, fn: ListenerFn<EventArgs<EventTypes, T>>, context?: any): this

  • Add a listener for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any

    Returns this

once

  • once<T>(event: T, fn: ListenerFn<EventArgs<EventTypes, T>>, context?: any): this

  • Add a one-time listener for a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • fn: ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any

    Returns this

removeAllListeners

  • removeAllListeners(event?: EventNames<EventTypes>): this

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optional event: EventNames<EventTypes>

    Returns this

removeListener

  • removeListener<T>(event: T, fn?: EventEmitter.ListenerFn<EventArgs<EventTypes, T>>, context?: any, once?: undefined | false | true): this

  • Remove the listeners of a given event.

    Type parameters

    • T: EventNames<EventTypes>

    Parameters

    • event: T
    • Optional fn: EventEmitter.ListenerFn<EventArgs<EventTypes, T>>
    • Optional context: any
    • Optional once: undefined | false | true

    Returns this

set

  • set(tasks: Task[]): void

  • Ajoute une liste de tâche à la Queue

    Parameters

    • tasks: Task[]

      Tâches à ajouter

    Returns void

start

  • start(): void

  • Lance le traitement des tâches de la Queue

    Returns void

stop

  • stop(): void

  • Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Private property
  • Private method
  • Static property

Generated using TypeDoc