@faasjs/request 0.0.2-beta.394 → 0.0.2-beta.395

package/README.md

@@ -12,7 +12,7 @@ FaasJS's request module.
 
 ## Modules
 
-### Type aliases
+### Type Aliases
 
 - [Request](#request)
 - [RequestOptions](#requestoptions)
@@ -24,7 +24,7 @@ FaasJS's request module.
 - [request](#request-1)
 - [setMock](#setmock)
 
-## Type aliases
+## Type Aliases
 
 ### Request
 
@@ -52,17 +52,17 @@ ___
 | Name | Type | Description |
 | :------ | :------ | :------ |
 | `agent?` | `boolean` | - |
-| `auth?` | `string` | HTTP 认证头，格式为 user:password |
-| `body?` | { `[key: string]`: `any`;  } \| `string` | 请求体 |
-| `downloadStream?` | `NodeJS.WritableStream` | 下载流，用于直接将响应内容保存到本地文件，通过 fs.createWriteStream 创建 |
-| `file?` | `string` | 上传文件的完整路径 |
-| `headers?` | `http.OutgoingHttpHeaders` | 请求头 |
-| `method?` | `string` | 请求方法，默认为 GET |
+| `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. |
+| `headers?` | `http.OutgoingHttpHeaders` | - |
+| `method?` | `string` | The HTTP method to use when making the request. Defaults to GET. |
+| `parse?` | (`body`: `string`) => `any` | Body parser. Defaults to `JSON.parse`. |
 | `passphrase?` | `string` | - |
 | `pfx?` | `Buffer` | - |
-| `query?` | { `[key: string]`: `any`;  } | 请求参数，放置于 path 后，若需放置在 body 中，请使用 body 参数 |
-| `timeout?` | `number` | 最长耗时，单位为毫秒 |
-| `parse?` | (`body`: `string`) => `any` | body 解析器，默认为 JSON.parse |
+| `query?` | { `[key: string]`: `any`;  } | - |
+| `timeout?` | `number` | - |
 
 ___
 
@@ -106,11 +106,13 @@ ___
 
 ### request
 
-▸ **request**<`T`\>(`url`, `[options={}]?`): `Promise`<[`Response`](#response)<`T`\>\>
+▸ **request**<`T`\>(`url`, `options?`): `Promise`<[`Response`](#response)<`T`\>\>
 
-发起网络请求
+Request
 
-**`url`** https://faasjs.com/doc/request.html
+**`Url`**
+
+https://faasjs.com/doc/request.html
 
 #### Type parameters
 
@@ -122,8 +124,8 @@ ___
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `url` | `string` | 请求路径或完整网址 |
-| `[options={}]` | [`RequestOptions`](#requestoptions) | 参数和配置 |
+| `url` | `string` | Url |
+| `options?` | [`RequestOptions`](#requestoptions) | Options |
 
 #### Returns
 
@@ -135,15 +137,19 @@ ___
 
 ▸ **setMock**(`handler`): `void`
 
-设置模拟请求
+Mock requests
+
+**`Example`**
 
-**`example`** setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
+```ts
+setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
+```
 
 #### Parameters
 
 | Name | Type | Description |
 | :------ | :------ | :------ |
-| `handler` | `Mock` | 模拟函数，若设置为 null 则表示清除模拟函数 |
+| `handler` | `Mock` | {function \| null} null to disable mock |
 
 #### Returns
 

package/dist/index.d.ts

@@ -18,56 +18,64 @@ declare type Response<T = any> = {
     body: T;
 };
 declare type RequestOptions = {
-    /** 请求头 */
     headers?: http.OutgoingHttpHeaders;
-    /** 请求方法，默认为 GET */
+    /**
+     * The HTTP method to use when making the request. Defaults to GET.
+     */
     method?: string;
-    /** 请求参数，放置于 path 后，若需放置在 body 中，请使用 body 参数 */
     query?: {
         [key: string]: any;
     };
-    /** 请求体 */
     body?: {
         [key: string]: any;
     } | string;
-    /** 最长耗时，单位为毫秒 */
     timeout?: number;
-    /** HTTP 认证头，格式为 user:password */
+    /**
+     * The authentication credentials to use for the request.
+     *
+     * Format: `username:password`
+     */
     auth?: string;
-    /** 上传文件的完整路径 */
+    /**
+     * Path of uploading a file to the server.
+     */
     file?: string;
-    /** 下载流，用于直接将响应内容保存到本地文件，通过 fs.createWriteStream 创建 */
+    /**
+     * Create a write stream to download a file.
+     */
     downloadStream?: NodeJS.WritableStream;
     pfx?: Buffer;
     passphrase?: string;
     agent?: boolean;
-    /** body 解析器，默认为 JSON.parse */
+    /**
+     * Body parser. Defaults to `JSON.parse`.
+     */
     parse?: (body: string) => any;
 };
 declare type Mock = (url: string, options: RequestOptions) => Promise<Response>;
 /**
- * 设置模拟请求
- * @param handler {function | null} 模拟函数，若设置为 null 则表示清除模拟函数
+ * Mock requests
+ * @param handler {function | null} null to disable mock
  * @example setMock(async (url, options) => Promise.resolve({ headers: {}, statusCode: 200, body: { data: 'ok' } }))
  */
 declare function setMock(handler: Mock | null): void;
 declare function querystringify(obj: any): string;
 /**
- * 发起网络请求
- * @param {string} url 请求路径或完整网址
- * @param {object=} [options={}] 参数和配置
- * @param {string} [options.method=GET] 请求方法
- * @param {object} [options.query={}] 请求参数，放置于 path 后，若需放置在 body 中，请使用 body 参数
- * @param {object} [options.headers={}] 请求头
- * @param {object=} options.body 请求体
- * @param {number=} options.timeout 最长耗时，单位为毫秒
- * @param {string=} options.auth HTTP 认证头，格式为 user:password
- * @param {string=} options.file 上传文件的完整路径
- * @param {WritableStream=} options.downloadStream 下载流，用于直接将响应内容保存到本地文件
+ * Request
+ * @param {string} url Url
+ * @param {object=} [options={}] Options
+ * @param {string} [options.method=GET] Method
+ * @param {object} [options.query={}] Query
+ * @param {object} [options.headers={}] Headers
+ * @param {object=} options.body Body
+ * @param {number=} options.timeout Timeout
+ * @param {string=} options.auth Auth, format: user:password
+ * @param {string=} options.file Upload file path
+ * @param {WritableStream=} options.downloadStream Download stream
  * @param {Buffer=} options.pfx pfx
  * @param {string=} options.passphrase passphrase
  * @param {boolean=} options.agent agent
- * @param {parse=} options.parse body 解析器，默认为 JSON.parse
+ * @param {parse=} options.parse body parser, default is JSON.parse
  *
  * @returns {promise}
  * @url https://faasjs.com/doc/request.html

package/dist/index.js

@@ -1,26 +1,10 @@
+"use strict";
 var __create = Object.create;
 var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
 var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -133,9 +117,10 @@ async function request(url, {
   if (body && !options.headers["Content-Length"])
     options.headers["Content-Length"] = Buffer.byteLength(body);
   return await new Promise(function(resolve, reject) {
-    log.debug("request %j", __spreadProps(__spreadValues({}, options), {
+    log.debug("request %j", {
+      ...options,
       body
-    }));
+    });
     const req = protocol.request(options, function(res) {
       if (downloadStream) {
         res.pipe(downloadStream);

package/dist/index.mjs

@@ -1,22 +1,4 @@
-var __defProp = Object.defineProperty;
-var __defProps = Object.defineProperties;
-var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
-var __getOwnPropSymbols = Object.getOwnPropertySymbols;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __propIsEnum = Object.prototype.propertyIsEnumerable;
-var __defNormalProp = (obj, key, value) => key in obj ? __defProp(obj, key, { enumerable: true, configurable: true, writable: true, value }) : obj[key] = value;
-var __spreadValues = (a, b) => {
-  for (var prop in b || (b = {}))
-    if (__hasOwnProp.call(b, prop))
-      __defNormalProp(a, prop, b[prop]);
-  if (__getOwnPropSymbols)
-    for (var prop of __getOwnPropSymbols(b)) {
-      if (__propIsEnum.call(b, prop))
-        __defNormalProp(a, prop, b[prop]);
-    }
-  return a;
-};
-var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+"use strict";
 
 // src/index.ts
 import * as http from "http";
@@ -108,9 +90,10 @@ async function request(url, {
   if (body && !options.headers["Content-Length"])
     options.headers["Content-Length"] = Buffer.byteLength(body);
   return await new Promise(function(resolve, reject) {
-    log.debug("request %j", __spreadProps(__spreadValues({}, options), {
+    log.debug("request %j", {
+      ...options,
       body
-    }));
+    });
     const req = protocol.request(options, function(res) {
       if (downloadStream) {
         res.pipe(downloadStream);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@faasjs/request",
-  "version": "0.0.2-beta.394",
+  "version": "0.0.2-beta.395",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,7 +22,7 @@
     "dist"
   ],
   "peerDependencies": {
-    "@faasjs/logger": "^0.0.2-beta.394"
+    "@faasjs/logger": "^0.0.2-beta.395"
   },
   "devDependencies": {
     "tsup": "*",