@faasjs/request 0.0.4-beta.1 → 0.0.4-beta.11

package/README.md

@@ -12,6 +12,10 @@ FaasJS's request module.
 
 ## Modules
 
+### Classes
+
+- [ResponseError](classes/ResponseError.md)
+
 ### Type Aliases
 
 - [Request](#request)
@@ -34,7 +38,7 @@ FaasJS's request module.
 
 | Name | Type |
 | :------ | :------ |
-| `body?` | { `[key: string]`: `any`;  } |
+| `body?` | \{ `[key: string]`: `any`;  } |
 | `headers?` | `http.OutgoingHttpHeaders` |
 | `host?` | `string` |
 | `method?` | `string` |
@@ -53,7 +57,7 @@ ___
 | :------ | :------ | :------ |
 | `agent?` | `boolean` | - |
 | `auth?` | `string` | The authentication credentials to use for the request. Format: `username:password` |
-| `body?` | { `[key: string]`: `any`;  } \| `string` | - |
+| `body?` | \{ `[key: string]`: `any`;  } \| `string` | - |
 | `downloadFile?` | `string` | Path of downloading a file from the server. ```ts await request('https://example.com', { downloadFile: 'filepath' }) ``` |
 | `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. ```ts import { createWriteStream } from 'fs' const stream = createWriteStream('filepath') await request('https://example.com', { downloadStream: stream }) ``` |
 | `file?` | `string` | Path of uploading a file to the server. ```ts await request('https://example.com', { file: 'filepath' }) ``` |
@@ -63,14 +67,14 @@ ___
 | `parse?` | (`body`: `string`) => `any` | Body parser. Defaults to `JSON.parse`. |
 | `passphrase?` | `string` | - |
 | `pfx?` | `Buffer` | - |
-| `query?` | { `[key: string]`: `any`;  } | - |
+| `query?` | \{ `[key: string]`: `any`;  } | - |
 | `timeout?` | `number` | - |
 
 ___
 
 ### Response
 
-Ƭ **Response**<`T`\>: `Object`
+Ƭ **Response**\<`T`\>: `Object`
 
 #### Type parameters
 
@@ -108,7 +112,7 @@ ___
 
 ### request
 
-▸ **request**<`T`\>(`url`, `options?`): `Promise`<[`Response`](#response)<`T`\>\>
+▸ **request**\<`T`\>(`url`, `options?`): `Promise`\<[`Response`](#response)\<`T`\>\>
 
 Request
 
@@ -127,7 +131,7 @@ Request
 
 #### Returns
 
-`Promise`<[`Response`](#response)<`T`\>\>
+`Promise`\<[`Response`](#response)\<`T`\>\>
 
 **`Url`**
 

package/dist/index.d.mts

@@ -81,8 +81,21 @@ type Mock = (url: string, options: RequestOptions) => Promise<Response>;
  */
 declare function setMock(handler: Mock | null): void;
 declare function querystringify(obj: any): string;
+/**
+ * ResponseError class
+ */
+declare class ResponseError extends Error {
+    response: Response;
+    request: Request;
+    statusCode: number;
+    statusMessage: string;
+    headers: http.OutgoingHttpHeaders;
+    body: any;
+    constructor(message: string, response: Response<any>);
+}
 /**
  * Request
+ *
  * @param {string} url Url
  * @param {object=} [options={}] Options
  * @param {string} [options.method=GET] Method
@@ -100,8 +113,9 @@ declare function querystringify(obj: any): string;
  * @param {parse=} options.parse body parser, default is JSON.parse
  *
  * @returns {promise}
+ *
  * @url https://faasjs.com/doc/request.html
  */
 declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, downloadFile, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
 
-export { Request, RequestOptions, Response, querystringify, request, setMock };
+export { Request, RequestOptions, Response, ResponseError, querystringify, request, setMock };

package/dist/index.d.ts

@@ -81,8 +81,21 @@ type Mock = (url: string, options: RequestOptions) => Promise<Response>;
  */
 declare function setMock(handler: Mock | null): void;
 declare function querystringify(obj: any): string;
+/**
+ * ResponseError class
+ */
+declare class ResponseError extends Error {
+    response: Response;
+    request: Request;
+    statusCode: number;
+    statusMessage: string;
+    headers: http.OutgoingHttpHeaders;
+    body: any;
+    constructor(message: string, response: Response<any>);
+}
 /**
  * Request
+ *
  * @param {string} url Url
  * @param {object=} [options={}] Options
  * @param {string} [options.method=GET] Method
@@ -100,8 +113,9 @@ declare function querystringify(obj: any): string;
  * @param {parse=} options.parse body parser, default is JSON.parse
  *
  * @returns {promise}
+ *
  * @url https://faasjs.com/doc/request.html
  */
 declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, downloadFile, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
 
-export { Request, RequestOptions, Response, querystringify, request, setMock };
+export { Request, RequestOptions, Response, ResponseError, querystringify, request, setMock };

package/dist/index.js

@@ -40,7 +40,7 @@ function querystringify(obj) {
   for (key in obj) {
     if (Object.prototype.hasOwnProperty.call(obj, key)) {
       value = obj[key];
-      if (!value && (value === null || value === void 0 || isNaN(value))) {
+      if (!value && (value === null || value === void 0 || Number.isNaN(value))) {
         value = "";
       }
       key = encodeURIComponent(key);
@@ -52,6 +52,17 @@ function querystringify(obj) {
   }
   return pairs.length ? pairs.join("&") : "";
 }
+var ResponseError = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+    this.request = response.request;
+    this.statusCode = response.statusCode;
+    this.statusMessage = response.statusMessage;
+    this.headers = response.headers;
+    this.body = response.body;
+  }
+};
 async function request(url$1, {
   headers,
   method,
@@ -145,7 +156,7 @@ async function request(url$1, {
             res.headers["content-type"],
             data
           );
-          const response = res.statusCode >= 200 && res.statusCode < 400 ? /* @__PURE__ */ Object.create(null) : new Error();
+          const response = /* @__PURE__ */ Object.create(null);
           response.request = options;
           response.request.body = body;
           response.statusCode = res.statusCode;
@@ -164,8 +175,12 @@ async function request(url$1, {
             resolve(response);
           else {
             logger$1.debug("response.error %j", response);
-            response.message = `${res.statusMessage || res.statusCode} ${options.host}${options.path}`;
-            reject(response);
+            reject(
+              new ResponseError(
+                `${res.statusMessage || res.statusCode} ${options.host}${options.path}`,
+                response
+              )
+            );
           }
         });
       }
@@ -199,6 +214,7 @@ async function request(url$1, {
   });
 }
 
+exports.ResponseError = ResponseError;
 exports.querystringify = querystringify;
 exports.request = request;
 exports.setMock = setMock;

package/dist/index.mjs

@@ -17,7 +17,7 @@ function querystringify(obj) {
   for (key in obj) {
     if (Object.prototype.hasOwnProperty.call(obj, key)) {
       value = obj[key];
-      if (!value && (value === null || value === void 0 || isNaN(value))) {
+      if (!value && (value === null || value === void 0 || Number.isNaN(value))) {
         value = "";
       }
       key = encodeURIComponent(key);
@@ -29,6 +29,17 @@ function querystringify(obj) {
   }
   return pairs.length ? pairs.join("&") : "";
 }
+var ResponseError = class extends Error {
+  constructor(message, response) {
+    super(message);
+    this.response = response;
+    this.request = response.request;
+    this.statusCode = response.statusCode;
+    this.statusMessage = response.statusMessage;
+    this.headers = response.headers;
+    this.body = response.body;
+  }
+};
 async function request(url, {
   headers,
   method,
@@ -122,7 +133,7 @@ async function request(url, {
             res.headers["content-type"],
             data
           );
-          const response = res.statusCode >= 200 && res.statusCode < 400 ? /* @__PURE__ */ Object.create(null) : new Error();
+          const response = /* @__PURE__ */ Object.create(null);
           response.request = options;
           response.request.body = body;
           response.statusCode = res.statusCode;
@@ -141,8 +152,12 @@ async function request(url, {
             resolve(response);
           else {
             logger.debug("response.error %j", response);
-            response.message = `${res.statusMessage || res.statusCode} ${options.host}${options.path}`;
-            reject(response);
+            reject(
+              new ResponseError(
+                `${res.statusMessage || res.statusCode} ${options.host}${options.path}`,
+                response
+              )
+            );
           }
         });
       }
@@ -176,4 +191,4 @@ async function request(url, {
   });
 }
 
-export { querystringify, request, setMock };
+export { ResponseError, querystringify, request, setMock };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "0.0.4-beta.1",
+  "version": "0.0.4-beta.11",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -21,10 +21,10 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/logger": "0.0.3-beta.109"
+    "@faasjs/logger": "0.0.4-beta.11"
   },
   "devDependencies": {
-    "@faasjs/logger": "0.0.4-beta.1"
+    "@faasjs/logger": "0.0.4-beta.11"
   },
   "engines": {
     "npm": ">=9.0.0",