Skip to content

Deferred

A Deferred Promise that can be resolved or rejected elsewhere in the code.

Extends

  • Promise<T>

Type Parameters

T

Err = Error

Methods

catch()

catch<TResult>(onrejected?): Promise<T | TResult>

Attaches a callback for only the rejection of the Promise.

Type Parameters

TResult = never

Parameters

onrejected?

The callback to execute when the Promise is rejected.

null | (reason) => TResult | PromiseLike<TResult>

Returns

Promise<T | TResult>

A Promise for the completion of the callback.

Inherited from

Promise.catch


finally()

finally(onfinally?): 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

onfinally?

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

null | () => void

Returns

Promise<T>

A Promise for the completion of the callback.

Inherited from

Promise.finally


then()

then<TResult1, TResult2>(onfulfilled?, onrejected?): Promise<TResult1 | TResult2>

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

Type Parameters

TResult1 = T

TResult2 = never

Parameters

onfulfilled?

The callback to execute when the Promise is resolved.

null | (value) => TResult1 | PromiseLike<TResult1>

onrejected?

The callback to execute when the Promise is rejected.

null | (reason) => TResult2 | PromiseLike<TResult2>

Returns

Promise<TResult1 | TResult2>

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

Inherited from

Promise.then

Properties

[toStringTag]

readonly [toStringTag]: string

Inherited from

Promise.[toStringTag]


reject()

reject: (error) => void

Parameters

error

Err

Returns

void


resolve

resolve: T extends void ? () => void : (value) => void