npm

Need private packages and team management tools?Check out npm Orgs. »

mnr-request

2.0.0 • Public • Published

mnr-request

Opinionated wrapper around node-fetch

You may not need it!

This is a custom, highly opinionated solution aimed at code re-use for a few private projects. You'd be better off using node-fetch directly.

Version 2 Breaking Changes

  • This is a complete re-write using node-fetch instead of request-promise-native under the hood.

  • Module initialization API is incompatible with v1. Though, request API is incompatible.

Archive documentation: v1.

Installation

$ npm install mnr-request --save

Usage Examples

const mnrRequest = require('mnr-request');
 
const apis = new Map([
  ['httpbin', {
    baseUrl: 'https://httpbin.org',
    apiOptions: {
      requestTimeoutMs: 5000,
      retries: 5,
      retryTimeoutMs: 500,
      customErrors: new Map([
        [401, { name: 'UnauthorizedError', message: 'request unauthorized' }]
      ])
    }
  }],
  ['example', { baseUrl: 'http://example.com' }]
]);
 
const globalOptions = {
  requestTimeoutMs: 10000,
  retries: 1,
  retryTimeoutMs: 3000,
  customErrors: new Map([
    [409, { name: 'ConflictError', message: 'request resulted in 409 Conflict response' }]
  ])
};
 
 
const request = mnrRequest(apis, globalOptions);
 
const responseData1 = request({
  apiName: 'httpbin',
  path: '/get',
  method: 'GET',
  headers: {
    'Authorization': 'Bearer 123foo='
  },
  qs: {
    foo: 'bar'
  }
});
 
const responseData2 = request({
  apiName: 'example',
  path: '/',
  method: 'PUT',
  body: {
    foo: 'bar'
  },
  requestOptions: {
    requestTimeoutMs: 0,
    retries: 0,
    retryTimeoutMs: 0,
    customErrors: new Map([
      [500, { name: 'CriticalError', message: 'backend is broken' }]
    ])
  }
});

API Reference

mnrRequest(apis, globalOptions) - see JSDoc comments in ./index.js file.

request(opts) - see JSDoc comments in ./lib/request.js file.

install

npm i mnr-request

Downloadsweekly downloads

1

version

2.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability