PromiseConstructor | typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • PromiseConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

  • new PromiseConstructor<T>(executor: function): Promise<T>
  • Creates a new Promise.

    Type parameters

    • T

    Parameters

    • executor: function

      A callback used to initialize the promise. This callback is passed two arguments: a resolve callback used resolve the promise with a value or the result of another promise, and a reject callback used to reject the promise with a provided reason or error.

        • (resolve: function, reject: function): void
        • Parameters

          • resolve: function
          • reject: function
              • (reason?: any): void
              • Parameters

                • Optional reason: any

                Returns void

          Returns void

    Returns Promise<T>

Properties

prototype

prototype: Promise<any>

A reference to the prototype.

Methods

all

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    • T9

    • T10

    Parameters

    Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    • T9

    Parameters

    Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns Promise<[T1, T2, T3, T4, T5, T6, T7]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns Promise<[T1, T2, T3, T4, T5, T6]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns Promise<[T1, T2, T3, T4, T5]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    Returns Promise<[T1, T2, T3, T4]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    • T3

    Parameters

    Returns Promise<[T1, T2, T3]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T1

    • T2

    Parameters

    Returns Promise<[T1, T2]>

    A new Promise.

  • Creates a Promise that is resolved with an array of results when all of the provided Promises resolve, or rejected when any Promise is rejected.

    Type parameters

    • T

    Parameters

    Returns Promise<T[]>

    A new Promise.

race

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    • T9

    • T10

    Parameters

    Returns Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9 | T10>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    • T9

    Parameters

    Returns Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8 | T9>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    • T8

    Parameters

    Returns Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7 | T8>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    • T7

    Parameters

    Returns Promise<T1 | T2 | T3 | T4 | T5 | T6 | T7>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    • T6

    Parameters

    Returns Promise<T1 | T2 | T3 | T4 | T5 | T6>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    • T5

    Parameters

    Returns Promise<T1 | T2 | T3 | T4 | T5>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    • T4

    Parameters

    Returns Promise<T1 | T2 | T3 | T4>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    • T3

    Parameters

    Returns Promise<T1 | T2 | T3>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T1

    • T2

    Parameters

    Returns Promise<T1 | T2>

    A new Promise.

  • Creates a Promise that is resolved or rejected when any of the provided Promises are resolved or rejected.

    Type parameters

    • T

    Parameters

    Returns Promise<T>

    A new Promise.

reject

  • reject(reason: any): Promise<never>
  • reject<T>(reason: any): Promise<T>
  • Creates a new rejected promise for the provided reason.

    Parameters

    • reason: any

      The reason the promise was rejected.

    Returns Promise<never>

    A new rejected Promise.

  • Creates a new rejected promise for the provided reason.

    Type parameters

    • T

    Parameters

    • reason: any

      The reason the promise was rejected.

    Returns Promise<T>

    A new rejected Promise.

resolve

  • resolve<T>(value: T | PromiseLike<T>): Promise<T>
  • resolve(): Promise<void>
  • Creates a new resolved promise for the provided value.

    Type parameters

    • T

    Parameters

    Returns Promise<T>

    A promise whose internal state matches the provided promise.

  • Creates a new resolved promise .

    Returns Promise<void>

    A resolved promise.

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