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

Type parameters

  • EventTypes: string | symbol | {}

Hierarchy

  • EventEmitter
    • Worker

Implements

Index

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Properties

Private backupTasks

backupTasks: Task[]

Tâches originelles du Worker

Private cancelled

cancelled: boolean

Indique si le Worker a été annulé

Private counts

counts: WorkerCount

Private currentTasks

currentTasks: Task[]

Tâches en cours de traitement

description

description: string

Description de l'utilité de ce Worker

Private eta

eta: ETA

id

id: string

Private options

options: WorkerOptions

Private paused

paused: boolean

Indique si le Worker est en pause

Private progress

progress: WorkerProgress

Private running

running: boolean

Indique si le Worker a été lancé

Private state

state: WorkerState

Private status

status: WorkerStatus

Private tasks

tasks: Task[]

Tâches du Worker à vider comme une Queue

Private waiting

waiting: {}

Tâches en attente de traitement

Type declaration

  • [key: string]: boolean

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Methods

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

cancel

  • cancel(): void

  • Annule le Worker ainsi que la tâche en cours de réalisation

    Returns void

clone

  • clone(): this

  • Clone le Worker

    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

Private end

  • end(): void

  • Termine le Worker

    Returns void

eventNames

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

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

    Returns Array<EventNames<EventTypes>>

Private failedTask

  • failedTask(id: string, message: string): void

  • Marque une tâche comme ayant échoué et emet un event

    Parameters

    • id: string

      Identifiant de la tâche

    • message: string

      Message d'erreur

    Returns void

Private failedWorker

  • failedWorker(message: string): void

  • Termine le Worker en émettant un message d'erreur

    Parameters

    • message: string

      Message d'erreur

    Returns void

Private finishTask

  • finishTask(id: string, result: any): void

  • Termine une tâche en attente, met à jour les counts et emet un event

    Parameters

    • id: string

      Identifiant de la tâche

    • result: any

      Résultat de la tâche

    Returns void

Private finishWorker

  • finishWorker(result?: any): void

  • Met fin au Worker et emet un event

    Parameters

    • Optional result: any

      Résultat du batch

    Returns void

getCounts

  • Retourne les compteurs du Worker

    Returns WorkerCount

getProgress

  • Retourne la dernière progression du Worker

    Returns WorkerProgress

getState

  • Retourne l'état du Worker

    Returns WorkerState

getStatus

  • Retourne le status actuel du Worker

    Returns WorkerStatus

Private init

  • Parameters

    Returns void

isCancelled

  • isCancelled(): boolean

  • Indique si le Worker est annulé

    Returns boolean

isPaused

  • isPaused(): boolean

  • Indique si le Worker a été mis en pause

    Returns boolean

isRunning

  • isRunning(): boolean

  • Indique si le Worker est en cours de traitement

    Returns boolean

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(): void

  • Décide de continuer d'exécuter des tâches ou de terminer le Worker

    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

pause

  • pause(): void

  • Pause le Worker ainsi que la tâche en cours de réalisation

    Returns void

Private progressTask

  • progressTask(__namedParameters: { complete: undefined | number; failed: undefined | number; id: string; message: undefined | string; total: undefined | number }): void

  • Met à jour la progression d'une tâche et emet un event de progression

    Parameters

    • __namedParameters: { complete: undefined | number; failed: undefined | number; id: string; message: undefined | string; total: undefined | number }
      • complete: undefined | number
      • failed: undefined | number
      • id: string
      • message: undefined | string
      • total: undefined | number

    Returns void

Private progressWorker

  • progressWorker(message?: undefined | string): void

  • Consolide la progression des tâches et emet un event de progression

    Parameters

    • Optional message: undefined | string

      Message de progression

    Returns void

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

restore

  • Restaure le state d'un Worker à l'aide d'un Memento

    Parameters

    Returns void

  • Restaure le state du Worker à l'aide d'un WorkerState

    Parameters

    Returns void

resume

  • resume(): void

  • Reprend le Worker s'il a été mis en pause

    Returns void

save

  • Créé et retourne un Memento du Worker

    Returns WorkerMemento

setState

  • Définis l'état d'un Worker manuellement ou automatiquement si aucun état n'est fourni

    Parameters

    Returns void

size

  • size(): number

  • Retourne le nombre de tâches présentes dans le Worker

    Returns number

start

  • start(): Promise<void>

  • Démarre le Worker

    Returns Promise<void>

Private startTask

  • startTask(task: Task): void

  • Ajoute la tâche aux tâches en cours, incrémente les compteurs et emet un event

    Parameters

    • task: Task

      Tâche à démarrer

    Returns void

Legend

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

Generated using TypeDoc