rekwest 3.3.2 → 3.3.3

package/README.md

@@ -1,186 +1,186 @@
-The robust request library that humanity deserves 🌐
----
-This package provides highly likely functional and **easy-to-use** abstraction atop of
-native [http(s).request](https://nodejs.org/api/https.html#https_https_request_url_options_callback)
-and [http2.request](https://nodejs.org/api/http2.html#http2_clienthttp2session_request_headers_options).
-
-## Abstract
-
-* Fetch-alike
-* Cool-beans 🫐 config options (with defaults)
-* Automatic HTTP/2 support (ALPN negotiation)
-* Automatic or opt-in body parse (with non-UTF-8 charset decoding)
-* Automatic and simplistic `Cookies` treatment (with built-in jar)
-* Automatic decompression (with opt-in body compression)
-* Built-in streamable `File` & `FormData` interfaces
-* Support redirects & retries with fine-grained tune-ups
-* Support all legit request body types (include blobs & streams)
-* Support both CJS and ESM module systems
-* Fully promise-able and pipe-able
-* Zero dependencies
-
-## Prerequisites
-
-* Node.js `>= 16.x`
-
-## Installation
-
-```bash
-npm install rekwest --save
-```
-
-### Usage
-
-```javascript
-import rekwest, { constants } from 'rekwest';
-
-const {
-  HTTP2_HEADER_AUTHORIZATION,
-  HTTP2_HEADER_CONTENT_ENCODING,
-  HTTP2_METHOD_POST,
-  HTTP_STATUS_OK,
-} = constants;
-
-const url = 'https://somewhe.re/somewhat/endpoint';
-
-const res = await rekwest(url, {
-  body: { celestial: 'payload' },
-  headers: {
-    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
-    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
-    /** [HTTP2_HEADER_CONTENT_TYPE]
-     * is undue for
-     * Array/Blob/File/FormData/Object/URLSearchParams body types
-     * and will be set automatically, with an option to override it here
-     */
-  },
-  method: HTTP2_METHOD_POST,
-});
-
-console.assert(res.statusCode === HTTP_STATUS_OK);
-console.info(res.headers);
-console.log(res.body);
-```
-
----
-
-```javascript
-import rekwest, {
-  constants,
-  Blob,
-  File,
-  FormData,
-} from 'rekwest';
-import { Readable } from 'node:stream';
-
-const {
-  HTTP2_HEADER_AUTHORIZATION,
-  HTTP2_HEADER_CONTENT_ENCODING,
-  HTTP2_METHOD_POST,
-  HTTP_STATUS_OK,
-} = constants;
-
-const blob = new Blob(['bits']);
-const file = new File(['bits'], 'file.dab');
-const readable = Readable.from('bits');
-
-const fd = new FormData({
-  aux: Date.now(),  // either [[key, value]], or kv sequenceable
-});
-
-fd.append('celestial', 'payload');
-fd.append('blob', blob, 'blob.dab');
-fd.append('file', file);
-fd.append('readable', readable, 'readable.dab');
-
-const url = 'https://somewhe.re/somewhat/endpoint';
-
-const res = await rekwest(url, {
-  body: fd,
-  headers: {
-    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
-    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
-  },
-  method: HTTP2_METHOD_POST,
-});
-
-console.assert(res.statusCode === HTTP_STATUS_OK);
-console.info(res.headers);
-console.log(res.body);
-```
-
-### API
-
-#### `rekwest(url[, options])`
-
-* `url` **{string | URL}** The URL to send the request to
-* `options` **{Object}**
-  Extends [https.RequestOptions](https://nodejs.org/api/https.html#https_https_request_url_options_callback)
-  along with
-  extra [http2.ClientSessionOptions](https://nodejs.org/api/http2.html#http2_http2_connect_authority_options_listener)
-  & [http2.ClientSessionRequestOptions](https://nodejs.org/api/http2.html#http2_clienthttp2session_request_headers_options)
-  and [tls.ConnectionOptions](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback)
-  for HTTP/2 attunes
-  * `body` **{string | Array | ArrayBuffer | ArrayBufferView | AsyncIterator | Blob | Buffer | DataView | File |
-    FormData | Iterator | Object | Readable | SharedArrayBuffer | URLSearchParams}** The body to send with the request
-  * `cookies` **{boolean | Array<[k, v]> | Cookies | Object | URLSearchParams}** `Default: true` The cookies to add to
-    the request
-  * `digest` **{boolean}** `Default: true` Controls whether to read the response stream or simply add a mixin
-  * `follow` **{number}** `Default: 20` The number of redirects to follow
-  * `h2` **{boolean}** `Default: false` Forces the use of HTTP/2 protocol
-  * `headers` **{Object}** The headers to add to the request
-  * `maxRetryAfter` **{number}** The upper limit of `retry-after` header. If unset, it will use `timeout` value
-  * `parse` **{boolean}** `Default: true` Controls whether to parse response body or simply return a buffer
-  * `redirect` **{error | follow | manual}** `Default: follow` Controls the redirect flows
-  * `retry` **{Object}** Represents the retry options
-    * `attempts` **{number}** `Default: 0` The number of retry attempts
-    * `backoffStrategy` **{string}** `Default: interval * Math.log(Math.random() * (Math.E * Math.E - Math.E) + Math.E)`
-      The backoff strategy algorithm that increases logarithmically. To fixate set value to `interval * 1`
-    * `interval` **{number}** `Default: 1e3` The initial retry interval
-    * `retryAfter` **{boolean}** `Default: true` Controls `retry-after` header receptiveness
-    * `statusCodes` **{number[]}** `Default: [429, 503]` The list of status codes to retry on
-  * `thenable` **{boolean}** `Default: false` Controls the promise resolutions
-  * `timeout` **{number}** `Default: 3e5` The number of milliseconds a request can take before termination
-  * `trimTrailingSlashes` **{boolean}** `Default: false` Controls whether to trim trailing slashes in the URL before
-    proceed with the request
-* **Returns:** Promise that resolves to
-  extended [http.IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
-  or [http2.ClientHttp2Stream](https://nodejs.org/api/http2.html#http2_class_clienthttp2stream) which is respectively
-  readable and duplex streams
-  * if `degist: true` & `parse: true`
-    * `body` **{string | Array | Buffer | Object}** The body based on its content type
-  * if `degist: false`
-    * `arrayBuffer` **{AsyncFunction}** Reads the response and returns **ArrayBuffer**
-    * `blob` **{AsyncFunction}** Reads the response and returns **Blob**
-    * `body` **{AsyncFunction}** Reads the response and returns **Buffer** if `parse: false`
-    * `json` **{AsyncFunction}** Reads the response and returns **Object**
-    * `text` **{AsyncFunction}** Reads the response and returns **String**
-  * `bodyUsed` **{boolean}** Indicates whether the response were read or not
-  * `cookies` **{undefined | Cookies}** The cookies sent and received with the response
-  * `headers` **{Object}** The headers received with the response
-  * `httpVersion` **{string}** Indicates protocol version negotiated with the server
-  * `ok` **{boolean}** Indicates if the response was successful (statusCode: **200-299**)
-  * `redirected` **{boolean}** Indicates if the response is the result of a redirect
-  * `statusCode` **{number}** Indicates the status code of the response
-  * `trailers` **{undefined | Object}** The trailer headers received with the response
-
----
-
-#### `rekwest.defaults`
-
-The object to fulfill with default [options](#rekwesturl-options)
-
----
-
-#### `rekwest.stream(url[, options])`
-
-The method with limited functionality to use with streams and/or pipes
-
-* No automata
-* No redirects
-* Pass `h2: true` in options to use HTTP/2 protocol
-  * Or use `ackn({ url: URL })` method in advance to probe the available protocols
-
----
-
-For more details, please check tests (coverage: **>97%**) in the repository
+The robust request library that humanity deserves 🌐
+---
+This package provides highly likely functional and **easy-to-use** abstraction atop of
+native [http(s).request](https://nodejs.org/api/https.html#https_https_request_url_options_callback)
+and [http2.request](https://nodejs.org/api/http2.html#http2_clienthttp2session_request_headers_options).
+
+## Abstract
+
+* Fetch-alike
+* Cool-beans 🫐 config options (with defaults)
+* Automatic HTTP/2 support (ALPN negotiation)
+* Automatic or opt-in body parse (with non-UTF-8 charset decoding)
+* Automatic and simplistic `Cookies` treatment (with built-in jar)
+* Automatic decompression (with opt-in body compression)
+* Built-in streamable `File` & `FormData` interfaces
+* Support redirects & retries with fine-grained tune-ups
+* Support all legit request body types (include blobs & streams)
+* Support both CJS and ESM module systems
+* Fully promise-able and pipe-able
+* Zero dependencies
+
+## Prerequisites
+
+* Node.js `>= 16.5.x`
+
+## Installation
+
+```bash
+npm install rekwest --save
+```
+
+### Usage
+
+```javascript
+import rekwest, { constants } from 'rekwest';
+
+const {
+  HTTP2_HEADER_AUTHORIZATION,
+  HTTP2_HEADER_CONTENT_ENCODING,
+  HTTP2_METHOD_POST,
+  HTTP_STATUS_OK,
+} = constants;
+
+const url = 'https://somewhe.re/somewhat/endpoint';
+
+const res = await rekwest(url, {
+  body: { celestial: 'payload' },
+  headers: {
+    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
+    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
+    /** [HTTP2_HEADER_CONTENT_TYPE]
+     * is undue for
+     * Array/Blob/File/FormData/Object/URLSearchParams body types
+     * and will be set automatically, with an option to override it here
+     */
+  },
+  method: HTTP2_METHOD_POST,
+});
+
+console.assert(res.statusCode === HTTP_STATUS_OK);
+console.info(res.headers);
+console.log(res.body);
+```
+
+---
+
+```javascript
+import rekwest, {
+  constants,
+  Blob,
+  File,
+  FormData,
+} from 'rekwest';
+import { Readable } from 'node:stream';
+
+const {
+  HTTP2_HEADER_AUTHORIZATION,
+  HTTP2_HEADER_CONTENT_ENCODING,
+  HTTP2_METHOD_POST,
+  HTTP_STATUS_OK,
+} = constants;
+
+const blob = new Blob(['bits']);
+const file = new File(['bits'], 'file.dab');
+const readable = Readable.from('bits');
+
+const fd = new FormData({
+  aux: Date.now(),  // either [[key, value]], or kv sequenceable
+});
+
+fd.append('celestial', 'payload');
+fd.append('blob', blob, 'blob.dab');
+fd.append('file', file);
+fd.append('readable', readable, 'readable.dab');
+
+const url = 'https://somewhe.re/somewhat/endpoint';
+
+const res = await rekwest(url, {
+  body: fd,
+  headers: {
+    [HTTP2_HEADER_AUTHORIZATION]: 'Bearer [token]',
+    [HTTP2_HEADER_CONTENT_ENCODING]: 'br',  // enables: body compression
+  },
+  method: HTTP2_METHOD_POST,
+});
+
+console.assert(res.statusCode === HTTP_STATUS_OK);
+console.info(res.headers);
+console.log(res.body);
+```
+
+### API
+
+#### `rekwest(url[, options])`
+
+* `url` **{string | URL}** The URL to send the request to
+* `options` **{Object}**
+  Extends [https.RequestOptions](https://nodejs.org/api/https.html#https_https_request_url_options_callback)
+  along with
+  extra [http2.ClientSessionOptions](https://nodejs.org/api/http2.html#http2_http2_connect_authority_options_listener)
+  & [http2.ClientSessionRequestOptions](https://nodejs.org/api/http2.html#http2_clienthttp2session_request_headers_options)
+  and [tls.ConnectionOptions](https://nodejs.org/api/tls.html#tls_tls_connect_options_callback)
+  for HTTP/2 attunes
+  * `body` **{string | Array | ArrayBuffer | ArrayBufferView | AsyncIterator | Blob | Buffer | DataView | File |
+    FormData | Iterator | Object | Readable | SharedArrayBuffer | URLSearchParams}** The body to send with the request
+  * `cookies` **{boolean | Array<[k, v]> | Cookies | Object | URLSearchParams}** `Default: true` The cookies to add to
+    the request
+  * `digest` **{boolean}** `Default: true` Controls whether to read the response stream or simply add a mixin
+  * `follow` **{number}** `Default: 20` The number of redirects to follow
+  * `h2` **{boolean}** `Default: false` Forces the use of HTTP/2 protocol
+  * `headers` **{Object}** The headers to add to the request
+  * `maxRetryAfter` **{number}** The upper limit of `retry-after` header. If unset, it will use `timeout` value
+  * `parse` **{boolean}** `Default: true` Controls whether to parse response body or simply return a buffer
+  * `redirect` **{error | follow | manual}** `Default: follow` Controls the redirect flows
+  * `retry` **{Object}** Represents the retry options
+    * `attempts` **{number}** `Default: 0` The number of retry attempts
+    * `backoffStrategy` **{string}** `Default: interval * Math.log(Math.random() * (Math.E * Math.E - Math.E) + Math.E)`
+      The backoff strategy algorithm that increases logarithmically. To fixate set value to `interval * 1`
+    * `interval` **{number}** `Default: 1e3` The initial retry interval
+    * `retryAfter` **{boolean}** `Default: true` Controls `retry-after` header receptiveness
+    * `statusCodes` **{number[]}** `Default: [429, 503]` The list of status codes to retry on
+  * `thenable` **{boolean}** `Default: false` Controls the promise resolutions
+  * `timeout` **{number}** `Default: 3e5` The number of milliseconds a request can take before termination
+  * `trimTrailingSlashes` **{boolean}** `Default: false` Controls whether to trim trailing slashes in the URL before
+    proceed with the request
+* **Returns:** Promise that resolves to
+  extended [http.IncomingMessage](https://nodejs.org/api/http.html#http_class_http_incomingmessage)
+  or [http2.ClientHttp2Stream](https://nodejs.org/api/http2.html#http2_class_clienthttp2stream) which is respectively
+  readable and duplex streams
+  * if `degist: true` & `parse: true`
+    * `body` **{string | Array | Buffer | Object}** The body based on its content type
+  * if `degist: false`
+    * `arrayBuffer` **{AsyncFunction}** Reads the response and returns **ArrayBuffer**
+    * `blob` **{AsyncFunction}** Reads the response and returns **Blob**
+    * `body` **{AsyncFunction}** Reads the response and returns **Buffer** if `parse: false`
+    * `json` **{AsyncFunction}** Reads the response and returns **Object**
+    * `text` **{AsyncFunction}** Reads the response and returns **String**
+  * `bodyUsed` **{boolean}** Indicates whether the response were read or not
+  * `cookies` **{undefined | Cookies}** The cookies sent and received with the response
+  * `headers` **{Object}** The headers received with the response
+  * `httpVersion` **{string}** Indicates protocol version negotiated with the server
+  * `ok` **{boolean}** Indicates if the response was successful (statusCode: **200-299**)
+  * `redirected` **{boolean}** Indicates if the response is the result of a redirect
+  * `statusCode` **{number}** Indicates the status code of the response
+  * `trailers` **{undefined | Object}** The trailer headers received with the response
+
+---
+
+#### `rekwest.defaults`
+
+The object to fulfill with default [options](#rekwesturl-options)
+
+---
+
+#### `rekwest.stream(url[, options])`
+
+The method with limited functionality to use with streams and/or pipes
+
+* No automata
+* No redirects
+* Pass `h2: true` in options to use HTTP/2 protocol
+  * Or use `ackn({ url: URL })` method in advance to probe the available protocols
+
+---
+
+For more details, please check tests (coverage: **>97%**) in the repository

package/package.json

@@ -9,17 +9,17 @@
   },
   "devDependencies": {
     "@babel/cli": "^7.18.10",
-    "@babel/core": "^7.18.10",
-    "@babel/eslint-parser": "^7.18.9",
-    "@babel/preset-env": "^7.18.10",
+    "@babel/core": "^7.19.1",
+    "@babel/eslint-parser": "^7.19.1",
+    "@babel/preset-env": "^7.19.1",
     "c8": "^7.12.0",
-    "eslint": "^8.21.0",
+    "eslint": "^8.23.1",
     "eslint-config-ultra-refined": "^2.5.0",
     "mocha": "^10.0.0"
   },
   "description": "The robust request library that humanity deserves 🌐",
   "engines": {
-    "node": ">=16.x"
+    "node": ">=16.5.x"
   },
   "exports": {
     "import": "./src/index.mjs",
@@ -45,7 +45,8 @@
     "multipart",
     "request",
     "redirect",
-    "retry"
+    "retry",
+    "retry-after"
   ],
   "license": "MIT",
   "main": "./dist/index.js",
@@ -65,5 +66,5 @@
     "test:bail": "mocha --bail",
     "test:cover": "c8 --include=src --reporter=lcov --reporter=text npm test"
   },
-  "version": "3.3.2"
+  "version": "3.3.3"
 }