Options
All
  • Public
  • Public/Protected
  • All
Menu

Fournis des informations quant à la durée estimée pour compléter des tâches

Hierarchy

  • ETA

Implements

Index

Constructors

constructor

  • Parameters

    Returns ETA

Properties

Private ETAProgressHistory

ETAProgressHistory: ETAProgress[]

Historique des ETA

complete

complete: number

Nombre de tâches réalisées

count

count: number

Nombre de tâches à réaliser

Private currentETAProgress

currentETAProgress: ETAProgress

ETA formaté pour être lisible

endedAt

endedAt: Date | undefined

Date de fin des tâches

Private options

options: ETAOptions

Options de l'ETA

startedAt

startedAt: Date | undefined

Date de début des tâches

stats

stats: ETAStats

Statistiques de l'ETA

Methods

clone

  • clone(): this
  • Clone l'objet ETA

    Returns this

    Clone de l'ETA

Private createETAProgress

  • Formate l'ETA pour être lisible par un humain

    Returns ETAProgress

    Progression de l'ETA

getOptions

  • Retourne les options de l'ETA

    Returns ETAOptions

    Options de l'ETA

getProgress

  • Retourne une progression de cet ETA formaté et lisible par des humains

    Returns ETAProgress

    Progression actuelle de l'ETA

getProgressHistory

  • Retourne l'historique des progressions de cet ETA

    Returns ETAProgress[]

    Historique des progressions de l'ETA

getStats

  • Calcule et retourne les statistiques de l'ETA

    Returns ETAStats

    Statistiques de l'ETA

increment

  • increment(tasksDone?: undefined | number): void
  • Incrémente le nombre de tâches réalisées

    Parameters

    • Optional tasksDone: undefined | number

      Nombre de tâches réalisées

    Returns void

Private millisecondsToStr

  • millisecondsToStr(milliseconds: number): string
  • Convertis un nombre de millisecondes en string lisible par un humain

    Parameters

    • milliseconds: number

      Nombre de millisecondes

    Returns string

    Estimation du temps restant lisible par un humain

Private parseTemplate

  • parseTemplate(eta: string): string
  • Parse le template fourni dans les options et ajoute l'ETA dans la string

    Parameters

    • eta: string

      ETA à intégrer dans le template

    Returns string

Private secondsToStr

  • secondsToStr(seconds: number): string
  • Convertis un nombre de secondes en string lisible par un humain

    Parameters

    • seconds: number

      Nombre de secondes

    Returns string

    Estimation du temps restant lisible par un humain

setComplete

  • setComplete(tasksCompleted: number): void
  • Définis le nombre de tâches ayant terminé

    Parameters

    • tasksCompleted: number

      Nombre de tâches terminées

    Returns void

setOptions

  • Définis les options de l'ETA

    Parameters

    Returns void

setProgress

  • Définis manuellement la progression de l'ETA

    Parameters

    Returns void

setProgressHistory

  • setProgressHistory(progressHistory: ETAProgress[]): void
  • Définis manuellement l'historique des progressions de l'ETA

    Parameters

    • progressHistory: ETAProgress[]

      Array d'objets ETAProgress

    Returns void

setStats

  • Définis manuellement les statistiques de l'ETA

    Parameters

    Returns void

start

  • start(): void
  • Démarre l'ETA

    Returns void

Legend

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

Generated using TypeDoc