Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

Implements

Index

Constructors

constructor

Properties

Protected _disposableObjectName

_disposableObjectName: string

Protected Optional _error

_error: any

Protected Optional _result

_result: T

Protected _state

_state: State

Accessors

error

  • get error(): any
  • Returns any

isFulfilled

  • get isFulfilled(): boolean

isPending

  • get isPending(): boolean

isRejected

  • get isRejected(): boolean

isSettled

  • get isSettled(): boolean

result

  • get result(): T
  • Returns T

state

wasDisposed

  • get wasDisposed(): boolean

Methods

Protected _onDispose

  • _onDispose(): void

catch

  • Shortcut for trapping a rejection.

    Type parameters

    • TResult

    Parameters

    Returns PromiseBase<TResult>

catchAllowFatal

  • Shortcut for trapping a rejection but will allow exceptions to propagate within the onRejected handler.

    Type parameters

    • TResult

    Parameters

    Returns PromiseBase<TResult>

delayAfterResolve

  • delayAfterResolve(milliseconds?: number): PromiseBase<T>
  • Will yield for a number of milliseconds from after this promise resolves. If the promise is already resolved, the delay will start from now.

    Parameters

    • Default value milliseconds: number = 0

    Returns PromiseBase<T>

    A promise that yields to the current execution and executes after a delay.

delayFromNow

  • Will yield for a number of milliseconds from the time called before continuing.

    Parameters

    • Default value milliseconds: number = 0

    Returns PromiseBase<T>

    A promise that yields to the current execution and executes after a delay.

dispose

  • dispose(): void

done

  • done(onFulfilled: Fulfill<T, any>, onRejected?: Reject<any>): void
  • .done is provided as a non-standard means that maps to similar functionality in other promise libraries. As stated by promisejs.org: 'then' is to 'done' as 'map' is to 'forEach'.

    Parameters

    Returns void

finally

  • finally<TResult>(fin: function): PromiseBase<TResult>
  • Shortcut to for handling either resolve or reject.

    Type parameters

    • TResult

    Parameters

    Returns PromiseBase<TResult>

finallyAllowFatal

  • finallyAllowFatal<TResult>(fin: function): PromiseBase<TResult>
  • Shortcut to for handling either resolve or reject but will allow exceptions to propagate within the handler.

    Type parameters

    • TResult

    Parameters

    Returns PromiseBase<TResult>

finallyThis

  • finallyThis(fin: function, synchronous?: boolean)
  • Shortcut to for handling either resolve or reject. Returns the current promise instead. You may not need an additional promise result, and this will not create a new one.

    Parameters

    • fin: function
        • (): void
        • Returns void

    • Optional synchronous: boolean

Protected getError

  • getError(): any

Protected getResult

  • getResult(): T

Protected getState

then

  • Standard .then method that defers execution until resolved.

    Type parameters

    • TResult

    Parameters

    • onFulfilled: Fulfill<T, TResult>
    • Optional onRejected: Reject<TResult>

    Returns PromiseBase<TResult>

thenAllowFatal

  • Same as .then but doesn't trap errors. Exceptions may end up being fatal.

    Type parameters

    • TResult

    Parameters

    • onFulfilled: Fulfill<T, TResult>
    • Optional onRejected: Reject<TResult>

    Returns PromiseBase<TResult>

thenSynchronous

thenThis

  • thenThis(onFulfilled: function, onRejected?: function)
  • Parameters

    • onFulfilled: function
        • (v?: T): any
        • Parameters

          • Optional v: T

          Returns any

    • Optional onRejected: function
        • (v?: any): any
        • Parameters

          • Optional v: any

          Returns any

Protected throwIfDisposed

  • throwIfDisposed(message?: string, objectName?: string): boolean
  • Parameters

    • Optional message: string
    • Default value objectName: string = this._disposableObjectName

    Returns boolean

Generated using TypeDoc