Module: legio-async/promise

Members

awaiting :Thenable

Type:

• Thenable

Source:

• promise.js, line 29

fulfilled :Boolean

Type:

• Boolean

Source:

• promise.js, line 31

pending :Boolean

Type:

• Boolean

Source:

• promise.js, line 27

rejected :Boolean

Type:

• Boolean

Source:

• promise.js, line 33

Methods

(static) all(list) → {Promise}

Parameters:

Name	Type	Description
list	Array.<Promise>

Source:

• promise.js, line 344

Returns:

Type

Promise

(static) allSettled(list) → {Promise}

Parameters:

Name	Type	Description
list	Array.<Promise>

Source:

• promise.js, line 402

Returns:

Type

Promise

(static) when(thenable) → {Promise}

Parameters:

Name	Type	Description
thenable	Thenable

Source:

• promise.js, line 410

Returns:

Type

Promise

bindFulfill() → {function}

Source:

• promise.js, line 246

Returns:

Type

function

bindNotify() → {function}

Source:

• promise.js, line 267

Returns:

Type

function

bindReject() → {function}

Source:

• promise.js, line 253

Returns:

Type

function

bindResolve() → {function}

Source:

• promise.js, line 260

Returns:

Type

function

catch()

Alias for module:legio-async/promise#failed

Source:

• promise.js, line 434

done()

Alias for module:legio-async/promise#then

Source:

• promise.js, line 427

failed(onRejected) → {Promise}

Parameters:

Name	Type	Description
onRejected	function

Source:

• promise.js, line 80

Returns:

Type

Promise

finally()

Alias for module:legio-async/promise#settled

Source:

• promise.js, line 441

fulfill(value) → {Boolean}

Parameters:

Name	Type	Description
value	*

Source:

• promise.js, line 127

Returns:

A boolean indicating whether the promise was fulfilled.

Type

Boolean

nodeifyResolve() → {function}

Returns a function in the node-async-style form which when called resolves the promise

Source:

• promise.js, line 325

Returns:

Type

function

nodeifyThen(fn) → {Promise}

Parameters:

Name	Type	Description
fn	function	A function in the node-async-style form (err, res)

Source:

• promise.js, line 310

Returns:

Type

Promise

notified(onNotified) → {this}

Parameters:

Name	Type	Description
onNotified	function

Source:

• promise.js, line 96

Returns:

Type

this

notify(value) → {Boolean}

Parameters:

Name	Type	Description
value	*

Source:

• promise.js, line 234

Returns:

A boolean indicating whether the promise was notified.

Type

Boolean

reject(reason) → {Boolean}

Parameters:

Name	Type	Description
reason	*

Source:

• promise.js, line 152

Returns:

A boolean indicating whether the promise was rejected.

Type

Boolean

resolve(x)

Parameters:

Name	Type	Description
x	*

Source:

• promise.js, line 193

run(fn) → {this}

Runs the given function after the fulfillment with the value as a parameter and stores the result as a new value.

Parameters:

Name	Type	Description
fn	function

Source:

• promise.js, line 110

Returns:

Type

this

settled(onSettled) → {Promise}

Parameters:

Name	Type	Description
onSettled	function

Source:

• promise.js, line 88

Returns:

Type

Promise

then(onFulfilledopt, onRejectedopt) → {Promise}

Parameters:

Name	Type	Attributes	Description
onFulfilled	function	<optional>
onRejected	function	<optional>

Source:

• promise.js, line 40

Returns:

Type

Promise