@faasjs/request 0.0.3-beta.4 → 0.0.3-beta.40

package/README.md

@@ -52,10 +52,10 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `agent?` | `boolean` | - |
-| `auth?` | `string` | The authentication credentials to use for the request.  Format: `username:password` |
+| `auth?` | `string` | The authentication credentials to use for the request. Format: `username:password` |
 | `body?` | { `[key: string]`: `any`;  } \| `string` | - |
-| `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. |
-| `file?` | `string` | Path of uploading a file to the server. |
+| `downloadStream?` | `NodeJS.WritableStream` | Create a write stream to download a file. ```ts 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' }) ``` |
 | `headers?` | `http.OutgoingHttpHeaders` | - |
 | `logger?` | `Logger` | - |
 | `method?` | `string` | The HTTP method to use when making the request. Defaults to GET. |

package/dist/index.d.ts

@@ -39,10 +39,19 @@ type RequestOptions = {
     auth?: string;
     /**
      * Path of uploading a file to the server.
+     *
+     * ```ts
+     * await request('https://example.com', { file: 'filepath' })
+     * ```
      */
     file?: string;
     /**
      * Create a write stream to download a file.
+     *
+     * ```ts
+     * const stream = createWriteStream('filepath')
+     * await request('https://example.com', { downloadStream: stream })
+     * ```
      */
     downloadStream?: NodeJS.WritableStream;
     pfx?: Buffer;

package/dist/index.js

@@ -145,7 +145,7 @@ async function request(url, {
           response.body = data;
           if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
             try {
-              response.body = parse ? parse(response.body) : JSON.parse(response.body);
+              response.body = (parse || JSON.parse)(response.body);
               logger.debug("response.parse JSON");
             } catch (error) {
               console.warn("response plain body", response.body);

package/dist/index.mjs

@@ -113,7 +113,7 @@ async function request(url, {
           response.body = data;
           if (response.body && response.headers["content-type"] && response.headers["content-type"].includes("application/json"))
             try {
-              response.body = parse ? parse(response.body) : JSON.parse(response.body);
+              response.body = (parse || JSON.parse)(response.body);
               logger.debug("response.parse JSON");
             } catch (error) {
               console.warn("response plain body", response.body);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "0.0.3-beta.4",
+  "version": "0.0.3-beta.40",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
     "dist"
   ],
   "dependencies": {
-    "@faasjs/logger": "^0.0.3-beta.4"
+    "@faasjs/logger": "^0.0.3-beta.40"
   },
   "engines": {
     "npm": ">=8.0.0",