@rqt/aqt NPM | npm.io

@rqt/aqt

aqt is a network request package for Node.JS that returns the body (parsed if returned as JSON), headers and status after gzip decompression when necessary.

rqt:~$ \
yarn add @rqt/aqt
npm install @rqt/aqt

API

The package exports the main default asynchronous function to make requests.

import aqt from '@rqt/aqt'

async aqt( `address: string,` `options=: !AqtOptions,`): !AqtReturn

Request a web page and return information including headers, statusCode, statusMessage along with the body (which is also parsed if JSON received).

address* string: The URL to request data from.
options !AqtOptions (optional): The options for the request.

Makes a request to the URL, either with or without options.

AqtOptions: Configuration for requests.

In the example below, a function is created to query data from a server.

import aqt from '@rqt/aqt'

const Request = async (url) => {
  const res = await aqt(url)
  const resp = JSON.stringify(res, null, 2)
  console.log(resp)
}

{
  "body": "Hello World",
  "headers": {
    "content-type": "text/plain",
    "date": "Tue, 07 Jan 2020 22:25:31 GMT",
    "connection": "close",
    "transfer-encoding": "chunked"
  },
  "statusCode": 200,
  "statusMessage": "OK"
}

`AqtReturn` Type

The result of the aqt function will have the following structure:

{
  "server": "GitHub.com",
  "date": "Wed, 18 Jul 2018 01:32:47 GMT",
  "content-type": "application/json; charset=utf-8",
  "content-length": "2",
  "connection": "close",
  "status": "200 OK",
  "x-ratelimit-limit": "60",
  "x-ratelimit-remaining": "59",
  "x-ratelimit-reset": "1531881167",
  "cache-control": "public, max-age=60, s-maxage=60",
  "vary": "Accept",
  "etag": "\"d751713988987e9331980363e24189ce\"",
  "x-github-media-type": "github.v3; format=json",
  "access-control-allow-origin": "*",
  "x-frame-options": "deny",
  "x-content-type-options": "nosniff",
  "x-xss-protection": "1; mode=block",
  "content-security-policy": "default-src 'none'",
  "x-runtime-rack": "0.018822",
  "x-github-request-id": "F187:785E:65A1E8A:C2A36B5:5B4E98BF"
}