@faasjs/request 0.0.3-beta.100 → 0.0.3-beta.102

package/README.md

@@ -111,10 +111,6 @@ ___
 
 Request
 
-**`Url`**
-
-https://faasjs.com/doc/request.html
-
 #### Type parameters
 
 | Name | Type |
@@ -132,6 +128,10 @@ https://faasjs.com/doc/request.html
 
 `Promise`<[`Response`](#response)<`T`\>\>
 
+**`Url`**
+
+https://faasjs.com/doc/request.html
+
 ___
 
 ### setMock
@@ -140,12 +140,6 @@ ___
 
 Mock requests
 
-**`Example`**
-
-```ts
-setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
-```
-
 #### Parameters
 
 | Name | Type | Description |
@@ -155,3 +149,9 @@ setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200,
 #### Returns
 
 `void`
+
+**`Example`**
+
+```ts
+setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
+```

package/dist/index.d.mts

@@ -49,11 +49,21 @@ type RequestOptions = {
      * Create a write stream to download a file.
      *
      * ```ts
+     * import { createWriteStream } from 'fs'
+     *
      * const stream = createWriteStream('filepath')
      * await request('https://example.com', { downloadStream: stream })
      * ```
      */
     downloadStream?: NodeJS.WritableStream;
+    /**
+     * Path of downloading a file from the server.
+     *
+     * ```ts
+     * await request('https://example.com', { downloadFile: 'filepath' })
+     * ```
+     */
+    downloadFile?: string;
     pfx?: Buffer;
     passphrase?: string;
     agent?: boolean;
@@ -83,6 +93,7 @@ declare function querystringify(obj: any): string;
  * @param {string=} options.auth Auth, format: user:password
  * @param {string=} options.file Upload file path
  * @param {WritableStream=} options.downloadStream Download stream
+ * @param {string=} options.downloadFile Download to file
  * @param {Buffer=} options.pfx pfx
  * @param {string=} options.passphrase passphrase
  * @param {boolean=} options.agent agent
@@ -91,6 +102,6 @@ declare function querystringify(obj: any): string;
  * @returns {promise}
  * @url https://faasjs.com/doc/request.html
  */
-declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
+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 };

package/dist/index.d.ts

@@ -49,11 +49,21 @@ type RequestOptions = {
      * Create a write stream to download a file.
      *
      * ```ts
+     * import { createWriteStream } from 'fs'
+     *
      * const stream = createWriteStream('filepath')
      * await request('https://example.com', { downloadStream: stream })
      * ```
      */
     downloadStream?: NodeJS.WritableStream;
+    /**
+     * Path of downloading a file from the server.
+     *
+     * ```ts
+     * await request('https://example.com', { downloadFile: 'filepath' })
+     * ```
+     */
+    downloadFile?: string;
     pfx?: Buffer;
     passphrase?: string;
     agent?: boolean;
@@ -83,6 +93,7 @@ declare function querystringify(obj: any): string;
  * @param {string=} options.auth Auth, format: user:password
  * @param {string=} options.file Upload file path
  * @param {WritableStream=} options.downloadStream Download stream
+ * @param {string=} options.downloadFile Download to file
  * @param {Buffer=} options.pfx pfx
  * @param {string=} options.passphrase passphrase
  * @param {boolean=} options.agent agent
@@ -91,6 +102,6 @@ declare function querystringify(obj: any): string;
  * @returns {promise}
  * @url https://faasjs.com/doc/request.html
  */
-declare function request<T = any>(url: string, { headers, method, query, body, timeout, auth, file, downloadStream, pfx, passphrase, agent, parse, logger, }?: RequestOptions): Promise<Response<T>>;
+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 };

package/dist/index.js

@@ -61,6 +61,7 @@ async function request(url$1, {
   auth,
   file,
   downloadStream,
+  downloadFile,
   pfx,
   passphrase,
   agent,
@@ -99,7 +100,7 @@ async function request(url$1, {
     host: uri.host ? uri.host.replace(/:[0-9]+$/, "") : uri.host,
     method: method ? method.toUpperCase() : "GET",
     path: uri.pathname + uri.search,
-    port: uri.port,
+    port: uri.port || (uri.protocol === "https:" ? "443" : "80"),
     timeout,
     auth,
     pfx,
@@ -124,9 +125,11 @@ async function request(url$1, {
     const req = protocol.request(options, function(res) {
       if (downloadStream) {
         res.pipe(downloadStream);
-        downloadStream.on("finish", function() {
-          resolve(void 0);
-        });
+        downloadStream.on("finish", () => resolve(void 0));
+      } else if (downloadFile) {
+        const stream = fs.createWriteStream(downloadFile);
+        res.pipe(stream);
+        stream.on("finish", () => resolve(void 0));
       } else {
         const raw = [];
         res.on("data", (chunk) => {

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import * as http from 'http';
 import * as https from 'https';
 import { URL } from 'url';
-import { readFileSync } from 'fs';
+import { createWriteStream, readFileSync } from 'fs';
 import { basename } from 'path';
 import { Logger } from '@faasjs/logger';
 
@@ -38,6 +38,7 @@ async function request(url, {
   auth,
   file,
   downloadStream,
+  downloadFile,
   pfx,
   passphrase,
   agent,
@@ -76,7 +77,7 @@ async function request(url, {
     host: uri.host ? uri.host.replace(/:[0-9]+$/, "") : uri.host,
     method: method ? method.toUpperCase() : "GET",
     path: uri.pathname + uri.search,
-    port: uri.port,
+    port: uri.port || (uri.protocol === "https:" ? "443" : "80"),
     timeout,
     auth,
     pfx,
@@ -101,9 +102,11 @@ async function request(url, {
     const req = protocol.request(options, function(res) {
       if (downloadStream) {
         res.pipe(downloadStream);
-        downloadStream.on("finish", function() {
-          resolve(void 0);
-        });
+        downloadStream.on("finish", () => resolve(void 0));
+      } else if (downloadFile) {
+        const stream = createWriteStream(downloadFile);
+        res.pipe(stream);
+        stream.on("finish", () => resolve(void 0));
       } else {
         const raw = [];
         res.on("data", (chunk) => {

package/package.json

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