Interface Deferred<T>

interface Deferred<T> {
    "[toStringTag]": string;
    reject: (reason?: any) => void;
    resolve: (value?: T | PromiseLike<T>) => void;
    catch<TResult = never>(
        onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
    ): Promise<T | TResult>;
    finally(onfinally?: () => void): Promise<T>;
    then<TResult1 = T, TResult2 = never>(
        onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
        onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
    ): Promise<TResult1 | TResult2>;
}

Type Parameters

  • T

Hierarchy

  • Promise<T>
    • Deferred

Properties

[toStringTag] reject resolve

Methods

catch finally then

Properties

Readonly[toStringTag]

"[toStringTag]": string

reject

reject: (reason?: any) => void

Rejects the Deferred

resolve

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

Resolves the Deferred to a value T

Methods

catch

  • catch<TResult = never>(
        onrejected?: (reason: any) => TResult | PromiseLike<TResult>,
    ): Promise<T | TResult>

    Attaches a callback for only the rejection of the Promise.

    Type Parameters

    • TResult = never

    Parameters

    • Optionalonrejected: (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.

finally

  • finally(onfinally?: () => void): Promise<T>

    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: () => void

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

    Returns Promise<T>

    A Promise for the completion of the callback.

then

  • then<TResult1 = T, TResult2 = never>(
        onfulfilled?: (value: T) => TResult1 | PromiseLike<TResult1>,
        onrejected?: (reason: any) => TResult2 | PromiseLike<TResult2>,
    ): Promise<TResult1 | TResult2>

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

    Type Parameters

    • TResult1 = T
    • TResult2 = never

    Parameters

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

      The callback to execute when the Promise is resolved.

    • Optionalonrejected: (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.

Settings

Member Visibility

On This Page

Properties
Methods