Options
All
  • Public
  • Public/Protected
  • All
Menu

A wrapper to simplify operation completion.

Hierarchy

  • ProgressOperation

Index

Constructors

Accessors

Methods

Constructors

constructor

Accessors

Status

Status:

Methods

cancel

  • cancel(message?: string, title?: string): void

done

  • Complete's an operation, optionally with a message and/or non-neutral status.

    Parameters

    • Optional options: ICompletedOptions | Error | string

      The message, message options, or error of the operation completion.

    Returns void

error

  • error(error: Error | string, title?: string, cleanError?: boolean): void
  • Parameters

    • error: Error | string
    • Optional title: string
    • Optional cleanError: boolean

    Returns void

increment

  • increment(big?: boolean): number
  • Increments the current progress's value.

    Parameters

    • Default value big: boolean = false

      Whether or not to increment the progress by a small (5%) or big (10%) amount

    Returns number

ok

  • ok(message?: string, title?: string): void

stop

  • stop(message?: string, title?: string): void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc