frestjs v1.1.2

frest.js

Send multiple HTTP REST requests in a single request and get aggregated response. Just 3kb.

Why

A typical web application generally needs to sends multiple HTTP REST requests one by one and then process their response. Managing multiple promise callbacks is tedious.

That's why frest.js exists.

Install

You can get it on npm.

npm install frestjs --save

Or if you're not into package management, just download a ZIP file.

Setup

First, include the script located on the dist folder.

<script src="node_modules/frestjs/dist/frest.js"></script>

Or you can use CDN Server

Usage

casecaded() - Sends multiple HTTP REST request by casecading response parameters

There are situation when one HTTP REST APIs response needs to be processed to get some parameter and this parameter needs to be passed to next HTTP REST requests.

casecaded() function does this for you.

Example

function casecaded() {
            var requests = [
                {
                    url: 'https://jsonplaceholder.typicode.com/posts/1'
                },
                {
                    url: 'https://jsonplaceholder.typicode.com/comments?postId={param}',
                    param: 'id'
                }];
            let result = frest.casecaded(requests);
            result.then(response => {
                console.log(JSON.stringify(response, null, 4));
            });
        }

waterfall() - Sends multiple HTTP REST request one by one

To send HTTP REST requests one after another you can use waterfall() function.

Example

function waterfall() {
            let urls = ['https://jsonplaceholder.typicode.com/posts/1',
                'https://jsonplaceholder.typicode.com/posts/2',
                'https://jsonplaceholder.typicode.com/posts/3']
            let result = frest.waterfall(urls);
            result.then(response => {
                console.log(JSON.stringify(response, null, 4));
            });
        }

getAll() - Sends multiple GET requests

A pretty common use case is to fetch multiple resources from different REST APIs.

getAll() accepts array of REST API urls and returns a promise object whose response contains aggregated response of all REST APIs.

Example

function getAll() {
            let urls = ['https://jsonplaceholder.typicode.com/posts/1',
                'https://jsonplaceholder.typicode.com/posts/2',
                'https://jsonplaceholder.typicode.com/posts/3']
            let result = frest.getAll(urls);
            result.then(response => {
                console.log(JSON.stringify(response, null, 4));
            });
        }

putAll() - sends multiple PUT requests

It is similar to postAll() requests.

deleteAll() - Sends multiple DELETE requests

deleteAll() accepts array of REST API urls and returns a promise object whose response contains aggregated response of all REST APIs.

Example

function deleteAll() {
            let urls = ['https://jsonplaceholder.typicode.com/posts/1',
                'https://jsonplaceholder.typicode.com/posts/2',
                'https://jsonplaceholder.typicode.com/posts/3']
            let result = frest.deleteAll(urls);
            result.then(response => {
                console.log(JSON.stringify(response, null, 4));
            });
        }

Browser Support

Iternally frestjs uses fetch() API. This library will support all browsers which supports fetch().

https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API

License

MIT License © Balram Chavan