async-request-builder v1.0.0

async-request-builder

AsyncRequestBuilder is a small library that simplifies async requests made in JS. Define all asynchronous requests in JSON format and use async-request-builder to convert that JSON definition file into methods that return promises. Built to support browser based XHR's and a number of NodeJS async requests like http, mysql, mongo and file reads. Improves code readability, promotes separation of concern and provides built in mocking for test purposes.

e.g. The following XHR JSON contract:

{
  "getXHRData": {
    "asyncModule": "http",
    "operationDetails": {
      "url": "https://httpstat.us/200?sleep=:sleep",
      "method": "GET"
    }
  }
}

is translated into an object with a getXHRData method that returns a promise. It also lets the caller of the method pass params.

The call would look like:

asyncLayer.getXHRData({params:{sleep: 1000}}).then(data => {
    console.log('got xhr data -> ',data );
});

Table of Contents

• Setup
• Running Local Examples
• Using This Library

Setup

Run the following commands:

npm install
npm run build

Running Local Examples

Browser:   Open example.html and watch console output

Node:   Run example.js and watch console output

Using This Library

Coming soon....

• Support for mysql and mongodb
• Support for swagger based JSON
• Support for build time output

Todos

• Add mysql, aggregation, & fs
• async-modules format validation
• caching async responses
• Add typescript