Options
All
  • Public
  • Public/Protected
  • All
Menu

A simple progress service for tracking active asynchronous operations and showing status messages.

Hierarchy

  • ProgressService

Index

Constructors

constructor

Properties

inProgress

inProgress: boolean = false

Static inject

inject: EventAggregator[] = [EventAggregator]

Methods

attempt

  • attempt(operation: function, options?: Partial<object>): boolean

attemptPromise

  • attemptPromise(operation: function, options?: Partial<object>): Promise<boolean>

error

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

    • message: Error | string
    • Optional title: string
    • Default value cleanError: boolean = false

    Returns void

increment

  • increment(big?: boolean): number
  • If there's an active operation, increments it's progress display.

    Parameters

    • Default value big: boolean = false

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

    Returns number

info

  • info(message: string, title?: string, options?: ToastrOptions): void
  • Parameters

    • message: string
    • Optional title: string
    • Optional options: ToastrOptions

    Returns void

start

stopOperation

  • Completes the progress visualization for an operation and (optionally) displays a message. This is not intended to be used directly, but rather internally by the return result of start().

    Parameters

    • id: string

      The id of the operation to stop.

    • Optional options: ICompletedOptions

      Additional operations related to showing a status message upon completion.

    Returns void

success

  • success(message: string, title?: string, options?: ToastrOptions): void
  • Parameters

    • message: string
    • Optional title: string
    • Optional options: ToastrOptions

    Returns void

warning

  • warning(message: string, title?: string, options?: ToastrOptions): void
  • Parameters

    • message: string
    • Optional title: string
    • Optional options: ToastrOptions

    Returns 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