Class TaskProgress

src/shared/utils/TaskProgress.ts:14–83

}

export class TaskProgress extends EventEmitter implements ITaskProgress {
  private readonly _stageCount: number;
  private _stage: number;
  private _stageTask: string;
  private _stageProgressDone: number;
  private _stageProgressTask: string;
  private _done: boolean;

  constructor(stageCount?: number) {
    super();
    if (stageCount) {
      this._stageCount = stageCount;
    } else {
      this._stageCount = 1;
    }
    this._stage = 1;
    this._stageProgressDone = 0;
    this._stageTask = '...';
    this._stageProgressTask = '...';
    this._done = false;
  }

  /**
   * Advance the stage ahead forcefully, setting progress of that stage to 0
   * @param stage Numbered stage to skip to
   * @param task Task progress string to show user
   */
  setStage(stage: number, task: string) {
    if (!this._done) {
      if (stage > this._stageCount) {
        throw Error('Stage given exceeds Progress Stage Count');
      } else {
        this._stage = stage;
        this._stageTask = task;
        this._stageProgressDone = 0;
        this._stageProgressTask = '...';
        this._fireProgress();
      }
    }
  }

  /**
   * Set progress and task string for a stage
   * @param done Demical progress (1 is done)
   * @param task Task progress string to show user
   */
  setStageProgress(done: number, task: string) {
    if (!this._done) {
      this._stageProgressDone = Math.min(done, 1);
      this._stageProgressTask = task;
      this._fireProgress();
    }
  }

  done(stageTask: string) {
    if (!this._done) {
      this._stageTask = stageTask;
      this._done = true;