@davalapar/request v0.0.31

@davalapar/request

server-side requests made ez

Usage

yarn add @davalapar/request

const request = require('@davalapar/request');

(async () => {
  const response = await request({

    // optional Object
    headers: {},

    // optional String
    auth: '',

    // optional String
    userAgent: '',
  
    // optional String
    referer: '',

    // required String
    url: 'https://...',

    // optional Object
    query: {},

    // optional Boolean
    text: true,

    // optional Boolean
    json: true,

    // optional Boolean
    compression: true,

    // optional Object with JSON-compatible values:
    // non-NaN finite numbers, booleans, undefined, null, plain arrays, plain objects
    body: {},

    // optional Array
    form: [
      {
        // required String
        name: 'photo',

        // optional String
        filename: 'photo.jpg',

        // required String or Buffer or JSON-compatible values:
        // non-NaN finite numbers, booleans, undefined, null, plain arrays, plain objects
        data: '',
      }
    ],

    // optional String
    destination: './dir/filename.ext',

    // optional Number
    timeout: 30000,

    // optional Number
    maxSize: 1000,

    // optional Function
    onProgress: (chunkSize, rContentLength, hContentLength) => {
      console.log('received:', chunkSize);
      console.log('total received:', rContentLength);
      console.log('total expected:', hContentLength);
      console.log('progress:', ((rContentLength / hContentLength) * 100).toFixed(2), ' %');
    },
  });
})();

Highlights

• headers parameter
  • sets headers
• userAgent parameter
  • sets user-agent: userAgent
• referer or referrer parameter
  • sets referrer: referer || referrer
• auth or authorization parameter
  • sets authorization: auth || authorization
• query parameter
  • for search / query parameters such as ?foo=bar
  • compatible with: body, form
• text parameter
  • sets accept: text/*
  • parse response into String if content-type: text/*
  • incompatible with: json, destination
• json parameter
  • sets accept: application/json
  • parse response into Object if content-type: application/json
  • incompatible with: text, destination
• body parameter
  • sets method: POST
  • sets accept: application/json
  • sets content-type: application/json
  • accepts non-ascii utf8 strings, emojis
  • incompatible with: form
  • uses POST method
• form parameter
  • sets method: POST
  • sets content-type: multipart/form-data
  • accepts utf8 strings, binary data
  • incompatible with: body
• destination parameter
  • file destination path
  • creates parent directories
  • only works with valid 2XX responses
  • incompatible with: text, json
• timeout parameter
  • request timeout in ms
• maxSize parameter
  • response max size in bytes
• compression parameter
  • sets accept-encoding: br, gzip, deflate
  • accepts content-encoding: br/gzip/deflate
• built-ins
  • valid 2XX responses: 200, 201, 204
  • valid 3XX responses: 301, 302, 307, 308
  • for 3XX responses: verifies location if exists, then follows it
  • verifies content-length if exists, for both compressed & non-compressed responses
  • returns Buffer if text & json parameter not set
  • rejects with error on response data json parsing error
  • rejects with error on valid responses, with response data as error.data
  • caching of DNS lookups in respect to ttl, with Map instance accessible at request.dnsCache

License

MIT | @davalapar