A Promise implementation that supports progress and cancelation.

Type parameters

  • V

Hierarchy

  • Promise

Index

Constructors

constructor

  • new Promise(init: function, oncancel?: any): Promise

Methods

cancel

  • cancel(): void

done

  • Parameters

    • Optional success: function
        • (value: V): void
        • Parameters

          • value: V

          Returns void

    • Optional error: function
        • (err: any): any
        • Parameters

          • err: any

          Returns any

    • Optional progress: ProgressCallback

    Returns void

then

  • Type parameters

    • U

    Parameters

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
    • Optional error: function
        • Parameters

          • err: any

          Returns Promise<U> | U

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
    • Optional error: function
        • (err: any): U
        • Parameters

          • err: any

          Returns U

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
    • Optional error: function
        • (err: any): void
        • Parameters

          • err: any

          Returns void

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • Parameters

          • value: V

          Returns Promise<U> | U

    • Optional error: function
    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • Parameters

          • value: V

          Returns Promise<U> | U

    • Optional error: function
        • Parameters

          • err: any

          Returns Promise<U> | U

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • Parameters

          • value: V

          Returns Promise<U> | U

    • Optional error: function
        • (err: any): U
        • Parameters

          • err: any

          Returns U

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • Parameters

          • value: V

          Returns Promise<U> | U

    • Optional error: function
        • (err: any): void
        • Parameters

          • err: any

          Returns void

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • (value: V): U
        • Parameters

          • value: V

          Returns U

    • Optional error: function
    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • (value: V): U
        • Parameters

          • value: V

          Returns U

    • Optional error: function
        • Parameters

          • err: any

          Returns Promise<U> | U

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • (value: V): U
        • Parameters

          • value: V

          Returns U

    • Optional error: function
        • (err: any): U
        • Parameters

          • err: any

          Returns U

    • Optional progress: ProgressCallback

    Returns Promise<U>

  • Type parameters

    • U

    Parameters

    • Optional success: function
        • (value: V): U
        • Parameters

          • value: V

          Returns U

    • Optional error: function
        • (err: any): void
        • Parameters

          • err: any

          Returns void

    • Optional progress: ProgressCallback

    Returns Promise<U>

Static any

  • any<ValueType>(promises: Promise<ValueType>[]): Promise<object>
  • Type parameters

    • ValueType

    Parameters

    • promises: Promise<ValueType>[]

    Returns Promise<object>

Static as

Static is

  • is(value: any): boolean

Static join

  • join<ValueType>(promises: Promise<ValueType>[]): Promise<ValueType[]>
  • join<ValueType>(promises: Thenable<ValueType>[]): Thenable<ValueType[]>
  • join<ValueType>(promises: object): Promise<object>
  • Type parameters

    • ValueType

    Parameters

    • promises: Promise<ValueType>[]

    Returns Promise<ValueType[]>

  • Type parameters

    • ValueType

    Parameters

    • promises: Thenable<ValueType>[]

    Returns Thenable<ValueType[]>

  • Type parameters

    • ValueType

    Parameters

    • promises: object

    Returns Promise<object>

Static timeout

  • timeout(delay: number): Promise<void>

Static wrap

  • wrap<ValueType>(value: Thenable<ValueType>): Promise<ValueType>
  • wrap<ValueType>(value: ValueType): Promise<ValueType>

Static wrapError

  • wrapError<ValueType>(error: Error): Promise<ValueType>