@faasjs/request 0.0.2-beta.362 → 0.0.2-beta.366

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +17 -15
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -1,26 +1,28 @@
1
1
  # @faasjs/request
2
2
 
3
- 网络请求库
4
-
5
3
  [![License: MIT](https://img.shields.io/npm/l/@faasjs/request.svg)](https://github.com/faasjs/faasjs/blob/main/packages/faasjs/request/LICENSE)
6
4
  [![NPM Stable Version](https://img.shields.io/npm/v/@faasjs/request/stable.svg)](https://www.npmjs.com/package/@faasjs/request)
7
5
  [![NPM Beta Version](https://img.shields.io/npm/v/@faasjs/request/beta.svg)](https://www.npmjs.com/package/@faasjs/request)
8
6
 
9
- https://faasjs.com/doc/request.html
7
+ FaasJS's request module.
8
+
9
+ ## Install
10
+
11
+ npm install @faasjs/request
10
12
 
11
13
  ## Modules
12
14
 
13
15
  ### Type aliases
14
16
 
15
- - [Request](modules.md#request)
16
- - [RequestOptions](modules.md#requestoptions)
17
- - [Response](modules.md#response)
17
+ - [Request](#request)
18
+ - [RequestOptions](#requestoptions)
19
+ - [Response](#response)
18
20
 
19
21
  ### Functions
20
22
 
21
- - [querystringify](modules.md#querystringify)
22
- - [request](modules.md#request)
23
- - [setMock](modules.md#setmock)
23
+ - [querystringify](#querystringify)
24
+ - [request](#request)
25
+ - [setMock](#setmock)
24
26
 
25
27
  ## Type aliases
26
28
 
@@ -32,7 +34,7 @@ https://faasjs.com/doc/request.html
32
34
 
33
35
  | Name | Type |
34
36
  | :------ | :------ |
35
- | `body?` | `Object` |
37
+ | `body?` | { [key: string]: `any`; } |
36
38
  | `headers?` | `http.OutgoingHttpHeaders` |
37
39
  | `host?` | `string` |
38
40
  | `method?` | `string` |
@@ -58,7 +60,7 @@ ___
58
60
  | `method?` | `string` | 请求方法，默认为 GET |
59
61
  | `passphrase?` | `string` | - |
60
62
  | `pfx?` | `Buffer` | - |
61
- | `query?` | `Object` | 请求参数，放置于 path 后，若需放置在 body 中，请使用 body 参数 |
63
+ | `query?` | { [key: string]: `any`; } | 请求参数，放置于 path 后，若需放置在 body 中，请使用 body 参数 |
62
64
  | `timeout?` | `number` | 最长耗时，单位为毫秒 |
63
65
  | `parse?` | (`body`: `string`) => `any` | body 解析器，默认为 JSON.parse |
64
66
 
@@ -80,7 +82,7 @@ ___
80
82
  | :------ | :------ |
81
83
  | `body` | `T` |
82
84
  | `headers` | `http.OutgoingHttpHeaders` |
83
- | `request?` | [`Request`](modules.md#request) |
85
+ | `request?` | [`Request`](#request) |
84
86
  | `statusCode?` | `number` |
85
87
  | `statusMessage?` | `string` |
86
88
 
@@ -104,7 +106,7 @@ ___
104
106
 
105
107
  ### request
106
108
 
107
- ▸ **request**<`T`\>(`url`, `[options={}]?`): `Promise`<[`Response`](modules.md#response)<`T`\>\>
109
+ ▸ **request**<`T`\>(`url`, `[options={}]?`): `Promise`<[`Response`](#response)<`T`\>\>
108
110
 
109
111
  发起网络请求
110
112
 
@@ -121,11 +123,11 @@ ___
121
123
  | Name | Type | Description |
122
124
  | :------ | :------ | :------ |
123
125
  | `url` | `string` | 请求路径或完整网址 |
124
- | `[options={}]` | [`RequestOptions`](modules.md#requestoptions) | 参数和配置 |
126
+ | `[options={}]` | [`RequestOptions`](#requestoptions) | 参数和配置 |
125
127
 
126
128
  #### Returns
127
129
 
128
- `Promise`<[`Response`](modules.md#response)<`T`\>\>
130
+ `Promise`<[`Response`](#response)<`T`\>\>
129
131
 
130
132
  ___
131
133
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@faasjs/request",
3
- "version": "0.0.2-beta.362",
3
+ "version": "0.0.2-beta.366",
4
4
  "license": "MIT",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
- "homepage": "https://faasjs.com/doc/request.html",
7
+ "homepage": "https://faasjs.com/doc/request",
8
8
  "repository": {
9
9
  "type": "git",
10
10
  "url": "git+https://github.com/faasjs/faasjs.git",
@@ -22,7 +22,7 @@
22
22
  "dist"
23
23
  ],
24
24
  "peerDependencies": {
25
- "@faasjs/logger": "^0.0.2-beta.362"
25
+ "@faasjs/logger": "^0.0.2-beta.366"
26
26
  },
27
27
  "devDependencies": {
28
28
  "tsup": "*",