A Deferred object is a Promise with public methods to resolve and reject.

Example:

 const deferred = new Deferred<number>()
setTimeout(() => {
deferred.resolve(42)
}, 1000)

deferred.then(value => console.log('Resolved to:', value))

Type Parameters

  • T

Implements

  • Promise<T>

Constructors

Properties

Accessors

Methods

Constructors

  • Type Parameters

    • T

    Returns Deferred<T>

Properties

reject: ((reason?: any) => void)
resolve: ((value: T | PromiseLike<T>) => void)

Accessors

  • get [toStringTag](): string
  • Returns string

Methods

  • Attaches a callback for only the rejection of the Promise.

    Type Parameters

    • TResult = never

    Parameters

    • Optionalonrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)

      The callback to execute when the Promise is rejected.

    Returns Promise<T | TResult>

    A Promise for the completion of the callback.

  • Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

    Parameters

    • Optionalonfinally: null | (() => void)

      The callback to execute when the Promise is settled (fulfilled or rejected).

    Returns Promise<T>

    A Promise for the completion of the callback.

  • Attaches callbacks for the resolution and/or rejection of the Promise.

    Type Parameters

    • TResult1 = T
    • TResult2 = never

    Parameters

    • Optionalonfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)

      The callback to execute when the Promise is resolved.

    • Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

      The callback to execute when the Promise is rejected.

    Returns Promise<TResult1 | TResult2>

    A Promise for the completion of which ever callback is executed.