Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ProgressReporter

Hierarchy

  • ProgressReporter

Index

Methods

Methods

complete

  • complete(): void
  • Completes the progress bar and hides the display. Sending a percentage of 100 has the same effect. No further progress updates can be sent after this.

    Returns void

error

  • error(error: any): void
  • Turns the progress display into an error display for the given error or message. Use if the operation failed. No further progress updates can be sent after this.

    Parameters

    • error: any

    Returns void

next

  • Updates the progress display with a new message and/or percentage.

    Parameters

    Returns void

Generated using TypeDoc