Skip to content

Latest commit

 

History

History
113 lines (92 loc) · 2.97 KB

README.md

File metadata and controls

113 lines (92 loc) · 2.97 KB

@sknx/request

Simple HTTP client for Node.JS with async/await without dependencies.

Usage

import { request } from '@sknx/request';

const response = await request({
  url: 'https://google.com',
  method: 'GET',
  timeout: 1000,
  follow: 5,

  // Specify request body
  headers: {
    'Content-Type': 'application/json',
  },
  body: { foo: 'bar' },

  // Specify response format
  format: 'json',

  // Validate response statusCode
  validate: (status) => statusCode >= 200 && statusCode < 300,

  // HTTP / HTTPS Proxy URL
  proxy: 'http://user:pass@proxy:port',
});

console.log(response.data);

Object body is automatically converted into JSON string with 'Content-Type': 'application/json' header. If you provide 'Content-Type' as 'x-www-form-urlencoded', body will be converted to urlencoded string.

The following options are available:

  • url: A string with that represents an absolute URL
  • method: 'GET', 'PUT', or any other ALLCAPS string will be used to set the HTTP method. Defaults to 'GET'.
  • format: Available formats are 'string', 'buffer', and 'json'. By default, the response will be returned as 'string'
  • headers: An object can be passed to set request headers.
  • validate: Function that defines whether to resolve or reject the promise for a given HTTP response status code.
  • follow: A number, that specifies max redirects. If undefined - no redirects will be followed
  • timeout: A number, that specifies request timeout in milliseconds
  • body: Object, Buffer, or string that will be sent to the server
  • agent: A custom agent to be used when performing requests
  • proxy: A string with that represents HTTP / HTTPS Proxy URL

Response Object contains:

  • status: HTTP status message
  • statusCode: HTTP status code
  • headers: Response headers Object
  • data: Response data in specified format
  • res: Raw HTTP response (IncomingMessage)

Response example (without res):

{
  "status": "OK",
  "statusCode": 200,
  "headers": {
    "access-control-allow-origin": "*",
    "content-type": "text/plain; charset=utf-8",
    "content-length": "13"
  },
  "data": "Hello, world!"
}

Examples

// Instance request example
const instance = new Request({
  headers: { 'content-type': 'application/json' },
});
instance.defaults.timeout = 5000;
instance.request({ url: 'https://ifconfig.me' }).then((response) => {
  const { res, ...data } = response;
  console.log(JSON.stringify(data));
});
// StatusCode validation example
request({
  url: 'https://ifconfig.me',
  validate: (status) => status === 400,
}).catch((error) => {
  // Check if validate statusCode error
  if (Request.isValidateError(error)) {
    console.log(error.response?.statusCode);
  }
});
// Http Proxy request example
request({
  url: 'https://ifconfig.me',
  proxy: 'http://user:pass@proxy:port',
}).then(({ res, ...data }) => {
  console.log(JSON.stringify(data));
});

TODO