Skip to content

Wrapper on request module with validation on top of format and rules used

License

Notifications You must be signed in to change notification settings

LCMApps/lcm-requester

Repository files navigation

lcm-requester - is a wrapper on request module with validation on top of format and rules used

NPM version Release Status Build Status Coverage Status

Installation

Using npm:

$ npm install --save lcm-requester

Using yarn:

$ yarn add lcm-requester

#Configuration All available transports and configuration options listed below: Parameter "agentOptions" support the same options like HTTP Agent or HTTPS Agent

Example:

{
    "requester": {
        "timeoutMsecs": 1000,
        "timing": true,
        "agentOptions": {
            "keepAlive": true,
            "keepAliveMsecs": 500,
            "maxSockets": 10000,
            "maxFreeSockets": 200,
            "timeout": 2000
        }
    }
}

Super simple to use

const {Requester} = require('lcm-requester');
// Use default configuration
const requester = new Requester();
// Use custom timeout on request with timing info
const requester = new Requester({
    timeoutMsecs: 2000,
    timing: true
});
// Use custom HTTP Agent for requests
const requester = new Requester({
    timeoutMsecs: 2000,
    agentOptions: {
        keepAlive: true
    }
});
const {response, responseBody} = await requester.getRequest('https://google.com/path?arg1=val1');
const {response, responseBody} = await requester.postFormUrlencodedRequest('https://google.com/path?arg1=val1');
const {response, responseBody} = await requester.postJsonRequest('https://google.com/path?arg1=val1', {});
const {response, responseBody} = await requester.deleteRequest('https://google.com/path?arg1=val1');

About

Wrapper on request module with validation on top of format and rules used

Resources

License

Stars

Watchers

Forks

Packages

No packages published