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

File d'attente avec gestion de priorité de Workers

Type parameters

  • EventTypes: string | symbol | {}

Hierarchy

  • EventEmitter
    • WorkerQueue

Implements

Index

Interfaces

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private cancelled

cancelled: boolean

Indique si la WorkerQueue a été annulée

Private counts

counts: WorkerQueueCounts

Compteurs de la WorkerQueue

Private currentWorkers

currentWorkers: Worker[]

Workers en cours de traitement

Private etaByTask

etaByTask: ETA

ETA par tâche

Private etaByWorker

etaByWorker: ETA

ETA par Worker

id

id: string

Identifiant de la WorkerQueue

Private options

options: WorkerQueueOptions

Options de la WorkerQueue

Private paused

paused: boolean

Indique si la WorkerQueue a été mise en pause

Private progress

progress: WorkerQueueProgress

Progression de la WorkerQueue

Private queue

queue: WorkerQueueElement[]

Queue de Workers

Private running

running: boolean

Indique si la WorkerQueue est lancée

Private state

state: WorkerQueueState

Etat de la WorkerQueue

status

status: WorkerQueueStatus

Statut de la WorkerQueue

Private waiting

waiting: {}

Workers en attente de traitement

Type declaration

  • [key: string]: boolean

Static EventEmitter

EventEmitter: EventEmitterStatic

Static prefixed

prefixed: string | boolean

Accessors

size

  • get size(): number

  • Indique la taille de la WorkerQueue

    Returns number

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 toute la file d'attente et les Workers en cours de traitement

    Returns void

cancelCurrent

  • cancelCurrent(): void

  • Annule les Workers en cours de traitement

    Returns void

clone

  • clone(): this

  • Clône le WorkerQueue

    Returns this

Private dequeue

  • Retourne le prochain élément de la file d'attente et le supprime

    Returns WorkerQueueElement | undefined

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

enqueue

  • Ajoute un Worker à la file d'attente selon son niveau de priorité

    Parameters

    • worker: Worker

      Worker à ajouter à la queue

    • Default value priority: WorkerQueuePriority = WorkerQueuePriority.Normal

      Niveau de priorité du Worker (normal par défaut)

    Returns void

enqueueAll

  • enqueueAll(workers: Worker[]): void

  • Ajoute un ensemble de Workers à la file d'attente avec une priorité normale

    Parameters

    • workers: Worker[]

      Workers à ajouter

    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(worker: Worker, taskId: string, message: string): void

  • Emet un event pour notifier qu'une tâche a échoué

    Parameters

    • worker: Worker

      Worker

    • taskId: string

      Identifiant de la tâche

    • message: string

      Message d'erreur

    Returns void

Private failedWorker

  • failedWorker(worker: Worker, message: string): void

  • Indique qu'un Worker a échoué, modifie les compteurs et l'état, et emet un event Note : si l'option "stopOnFirstFail" a été passée, cette méthode termine la WorkerQueue

    Parameters

    • worker: Worker

      Worker

    • message: string

      Message d'erreur

    Returns void

Private finishTask

  • finishTask(worker: Worker, taskId: string, results?: any): void

  • Emet un event pour la fin d'une tâche

    Parameters

    • worker: Worker
    • taskId: string

      Identifiant de la tâche

    • Optional results: any

      Résultat de la tâche

    Returns void

Private finishWorker

  • finishWorker(worker: Worker, results?: any): void

  • Termine un Worker en modifiant les compteurs et l'état, et en envoyant un event

    Parameters

    • worker: Worker

      Worker

    • Optional results: any

      Résultats éventuels du Worker

    Returns void

front

  • Retourne le premier Worker de la queue

    Returns WorkerQueueElement | undefined

getCounts

  • Retourne les compteurs de la WorkerQueue

    Returns WorkerQueueCounts

getETAByTask

  • getETAByTask(): ETA

  • Retourne l'ETA de la WorkerQueue par Task

    Returns ETA

getETAByWorker

  • getETAByWorker(): ETA

  • Retourne l'ETA de la WorkerQueue par Worker

    Returns ETA

getOptions

  • Retourne les options de la WorkerQueue

    Returns WorkerQueueOptions

getProgress

  • Retourne la dernière progression de la WorkerQueue

    Returns WorkerQueueProgress

getState

  • Retourne une copie immutable de l'état de cette WorkerQueue

    Returns WorkerQueueState

isCancelled

  • isCancelled(): boolean

  • Indique si la WorkerQueue a été annulée

    Returns boolean

isEmpty

  • isEmpty(): boolean

  • Indique si cette WorkerQueue est vide

    Returns boolean

isPaused

  • isPaused(): boolean

  • Indique si la WorkerQueue a été mise en pause

    Returns boolean

isRunning

  • isRunning(): boolean

  • Indique si la WorkerQueue a été lancée

    Returns boolean

Private launchWorker

  • Lance un Worker et route les events vers les méthodes de la WorkerQueue

    Parameters

    • worker: Worker

      Worker à lancer

    Returns Promise<Worker>

    Worker ayant été lancé

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étermine s'il faut passer au Worker suivant dans la file d'attente

    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

  • Met la file d'attente en pause

    Returns void

Private progressWorker

  • Emet un event pour la progression d'un Worker

    Parameters

    Returns void

Private progressWorkerQueue

  • progressWorkerQueue(worker: Worker, message?: undefined | string): void

  • Met à jour la progression de la WorkerQueue et emet un event

    Parameters

    • worker: Worker

      Worker

    • Optional message: undefined | string

      Message de progression (par défaut celui du Worker)

    Returns void

rear

  • Retourne le dernier Worker de la queue

    Returns WorkerQueueElement | undefined

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

Private resetCounts

  • resetCounts(): void

  • Remet les compteurs à zéro

    Returns void

restore

  • Restaure l'état d'une WorkerQueue à l'aide d'un Memento

    Parameters

    Returns void

resume

  • resume(): void

  • Reprends la file d'attente

    Returns void

save

  • Retourne un Memento pour cette WorkerQueue

    Returns WorkerQueueMemento

setOptions

  • Définis manuellement les options de la WorkerQueue

    Parameters

    Returns void

setState

  • Définis l'état d'une WorkerQueue à l'aide d'un objet ou, s'il n'est pas fourni, automatiquement

    Parameters

    Returns void

start

  • start(): Promise<void>

  • Lance la file d'attente du WorkerQueue

    Returns Promise<void>

Private startTask

  • startTask(workerId: string, task: Task): void

  • Emet un event pour le démarrage d'une tâche

    Parameters

    • workerId: string

      Identifiant du Worker

    • task: Task

      Tâche

    Returns void

Private startWorker

  • startWorker(workerId: string): void

  • Emet un event pour le démarrage d'un Worker et modifie l'état de la Queue

    Parameters

    • workerId: string

      Identifiant du Worker

    Returns void

Private startWorkerQueue

  • startWorkerQueue(): void

  • Emet un event pour notifier du démarrage de la WorkerQueue

    Returns void

Legend

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

Generated using TypeDoc