@jsweb/asyncs

@jsweb/asyncs

Simple JS module for Promise and Fetch APIs, with some useful abstraction

Create: date 2016-06-25 03:14:48
Modify: date 2019-06-18 00:42:23
Version: 3.0.7
Author: Alex Bruno [e-mail]
Example

import { requestJSON, requestAll, requestRace } from '@jsweb/asyncs'

exec(fn, ...args) ⇒ Promise

Excute any function asyncronously with any number of arguments.

Param	Type
fn	function
...args	arguments

asap(fn, ...args) ⇒ *

Execute any function asyncronously As Soon As Possible with any number of arguments.

Param	Type
fn	function
...args	arguments

task(input) ⇒ Promise

Turn any input in a Promise to use it on asyncronous threads

Param	Type
input	*

execAll(...args) ⇒ Promise

Turn any number of arguments into asyncronous group to resolve only if all threads resolve.

Param	Type
...args	arguments

execRace(...args) ⇒ Promise

Turn any number of arguments into asyncronous race to resolve or reject with the fastest thread.

Param	Type
...args	arguments

request(url, [cfg]) ⇒ Promise

Execute asyncronous HTTP requests with configurable options.

It uses Fetch API with some useful abstractions.

To send parameters on request, just add a body in cfg containing the object for any HTTP method request.

GET requests (default), will serialize parameters into a query string.

Other methods will convert parameters into FormData object if necessary.

So you can also send HTML Form or FormData object for non GET requests.

It is also possible to send JSON content. Just set content-type to application/json at cfg.headers.

Then your cfg.body literal object will be serialized using JSON.stringify.

The promise returned also checks HTTP response. Any status >= 300 will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestAll(urls, [cfg], [resp]) ⇒ Promise

Use execAll to make a request for each urls using the same cfg and resp type for all.

The returned Promise resolves only if all requests resolve.

If any request fails it will cause an entire Promise.reject.

Possible response types are: response, json, text, blob, boolean, number, xml and html.

Param	Type	Default
urls	Array.<string>
[cfg]	RequestInit	{}
[resp]	string	"'response'"

requestRace(urls, [cfg], [resp]) ⇒ Promise

Use execRace to make a request race with all urls using the same cfg and resp type for all.

The returned Promise resolves or rejects with the fastest request.

Possible response types are: response, json, text, blob, boolean, number, xml and html.

Param	Type	Default
urls	Array.<string>
[cfg]	RequestInit	{}
[resp]	string	"'response'"

requestJSON(url, [cfg]) ⇒ Promise

Execute a request expecting for a valid JSON response.

HTTP errors or invalid JSON response will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestText(url, [cfg]) ⇒ Promise

Execute a request expecting for any response and get it as text.

HTTP errors will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestBlob(url, [cfg]) ⇒ Promise

Execute a request expecting for a valid Blob response.

HTTP errors or not readable Blob response will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestBoolean(url, [cfg]) ⇒ Promise

Execute a request expecting for any response and get it as boolean.

HTTP errors will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestNumber(url, [cfg]) ⇒ Promise

Execute a request expecting for a valid Number response.

The response can be number, string or any value that can be parsed as Number.

Invalid values will resolve as NaN object (not a number).

HTTP errors will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestXML(url, [cfg]) ⇒ Promise

Execute a request expecting for a valid XML document response.

HTTP errors response will cause a Promise.reject.

Param	Type	Default
url	string
[cfg]	RequestInit	{}

requestHTML(url, [cfg]) ⇒ Promise

Execute a request expecting for any response and get it as HTML.

HTTP errors response will cause a Promise.reject.

Param	Type
url	string
[cfg]	RequestInit