@maiyunnet/kebab 9.18.0 → 9.18.2
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.
- package/doc/kebab-rag.md +317 -163
- package/index.d.ts +3 -1
- package/index.js +1 -1
- package/lib/undici/request.d.ts +10 -0
- package/lib/undici/request.js +16 -0
- package/lib/undici.d.ts +16 -0
- package/lib/undici.js +33 -1
- package/package.json +1 -1
- package/sys/child.js +1 -1
- package/sys/ctr.d.ts +7 -0
- package/sys/ctr.js +28 -1
- package/sys/route.d.ts +2 -1
- package/sys/route.js +49 -9
package/doc/kebab-rag.md
CHANGED
|
@@ -225,7 +225,7 @@ Defined in: [index.ts:183](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
225
225
|
|
|
226
226
|
> **ctrPath**: `string`
|
|
227
227
|
|
|
228
|
-
Defined in: [index.ts:
|
|
228
|
+
Defined in: [index.ts:210](https://github.com/maiyunnet/kebab/blob/master/index.ts#L210)
|
|
229
229
|
|
|
230
230
|
***
|
|
231
231
|
|
|
@@ -233,7 +233,7 @@ Defined in: [index.ts:208](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
233
233
|
|
|
234
234
|
> **dataPath**: `string`
|
|
235
235
|
|
|
236
|
-
Defined in: [index.ts:
|
|
236
|
+
Defined in: [index.ts:212](https://github.com/maiyunnet/kebab/blob/master/index.ts#L212)
|
|
237
237
|
|
|
238
238
|
***
|
|
239
239
|
|
|
@@ -289,7 +289,7 @@ Defined in: [index.ts:195](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
289
289
|
|
|
290
290
|
> **modPath**: `string`
|
|
291
291
|
|
|
292
|
-
Defined in: [index.ts:
|
|
292
|
+
Defined in: [index.ts:209](https://github.com/maiyunnet/kebab/blob/master/index.ts#L209)
|
|
293
293
|
|
|
294
294
|
***
|
|
295
295
|
|
|
@@ -327,7 +327,7 @@ Defined in: [index.ts:189](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
327
327
|
|
|
328
328
|
> **rootPath**: `string`
|
|
329
329
|
|
|
330
|
-
Defined in: [index.ts:
|
|
330
|
+
Defined in: [index.ts:208](https://github.com/maiyunnet/kebab/blob/master/index.ts#L208)
|
|
331
331
|
|
|
332
332
|
***
|
|
333
333
|
|
|
@@ -351,7 +351,7 @@ Defined in: [index.ts:190](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
351
351
|
|
|
352
352
|
> **uri**: [`IUrlParse`](IUrlParse.md)
|
|
353
353
|
|
|
354
|
-
Defined in: [index.ts:
|
|
354
|
+
Defined in: [index.ts:204](https://github.com/maiyunnet/kebab/blob/master/index.ts#L204)
|
|
355
355
|
|
|
356
356
|
***
|
|
357
357
|
|
|
@@ -359,7 +359,7 @@ Defined in: [index.ts:202](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
359
359
|
|
|
360
360
|
> **urlBase**: `string`
|
|
361
361
|
|
|
362
|
-
Defined in: [index.ts:
|
|
362
|
+
Defined in: [index.ts:217](https://github.com/maiyunnet/kebab/blob/master/index.ts#L217)
|
|
363
363
|
|
|
364
364
|
***
|
|
365
365
|
|
|
@@ -367,7 +367,17 @@ Defined in: [index.ts:215](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
367
367
|
|
|
368
368
|
> **urlFull**: `string`
|
|
369
369
|
|
|
370
|
-
Defined in: [index.ts:
|
|
370
|
+
Defined in: [index.ts:219](https://github.com/maiyunnet/kebab/blob/master/index.ts#L219)
|
|
371
|
+
|
|
372
|
+
***
|
|
373
|
+
|
|
374
|
+
### urlOrigin
|
|
375
|
+
|
|
376
|
+
> **urlOrigin**: `string`
|
|
377
|
+
|
|
378
|
+
Defined in: [index.ts:203](https://github.com/maiyunnet/kebab/blob/master/index.ts#L203)
|
|
379
|
+
|
|
380
|
+
协议与 host,如 https://example.com:8443
|
|
371
381
|
|
|
372
382
|
***
|
|
373
383
|
|
|
@@ -375,7 +385,7 @@ Defined in: [index.ts:217](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
375
385
|
|
|
376
386
|
> **urlStc**: `string`
|
|
377
387
|
|
|
378
|
-
Defined in: [index.ts:
|
|
388
|
+
Defined in: [index.ts:218](https://github.com/maiyunnet/kebab/blob/master/index.ts#L218)
|
|
379
389
|
|
|
380
390
|
***
|
|
381
391
|
|
|
@@ -383,7 +393,7 @@ Defined in: [index.ts:216](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
383
393
|
|
|
384
394
|
> **urlStcFull**: `string`
|
|
385
395
|
|
|
386
|
-
Defined in: [index.ts:
|
|
396
|
+
Defined in: [index.ts:220](https://github.com/maiyunnet/kebab/blob/master/index.ts#L220)
|
|
387
397
|
|
|
388
398
|
***
|
|
389
399
|
|
|
@@ -391,7 +401,7 @@ Defined in: [index.ts:218](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
391
401
|
|
|
392
402
|
> **viewPath**: `string`
|
|
393
403
|
|
|
394
|
-
Defined in: [index.ts:
|
|
404
|
+
Defined in: [index.ts:211](https://github.com/maiyunnet/kebab/blob/master/index.ts#L211)
|
|
395
405
|
|
|
396
406
|
***
|
|
397
407
|
|
|
@@ -407,7 +417,7 @@ Defined in: [index.ts:196](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
407
417
|
|
|
408
418
|
> **wsPath**: `string`
|
|
409
419
|
|
|
410
|
-
Defined in: [index.ts:
|
|
420
|
+
Defined in: [index.ts:213](https://github.com/maiyunnet/kebab/blob/master/index.ts#L213)
|
|
411
421
|
|
|
412
422
|
index/interfaces/IConfigDb.md
|
|
413
423
|
---
|
|
@@ -967,7 +977,7 @@ index/interfaces/IPostFile.md
|
|
|
967
977
|
|
|
968
978
|
# Interface: IPostFile
|
|
969
979
|
|
|
970
|
-
Defined in: [index.ts:
|
|
980
|
+
Defined in: [index.ts:232](https://github.com/maiyunnet/kebab/blob/master/index.ts#L232)
|
|
971
981
|
|
|
972
982
|
上传的文件信息对象
|
|
973
983
|
|
|
@@ -977,7 +987,7 @@ Defined in: [index.ts:230](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
977
987
|
|
|
978
988
|
> `readonly` **name**: `string`
|
|
979
989
|
|
|
980
|
-
Defined in: [index.ts:
|
|
990
|
+
Defined in: [index.ts:233](https://github.com/maiyunnet/kebab/blob/master/index.ts#L233)
|
|
981
991
|
|
|
982
992
|
***
|
|
983
993
|
|
|
@@ -985,7 +995,7 @@ Defined in: [index.ts:231](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
985
995
|
|
|
986
996
|
> `readonly` **origin**: `string`
|
|
987
997
|
|
|
988
|
-
Defined in: [index.ts:
|
|
998
|
+
Defined in: [index.ts:234](https://github.com/maiyunnet/kebab/blob/master/index.ts#L234)
|
|
989
999
|
|
|
990
1000
|
***
|
|
991
1001
|
|
|
@@ -993,7 +1003,7 @@ Defined in: [index.ts:232](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
993
1003
|
|
|
994
1004
|
> `readonly` **path**: `string`
|
|
995
1005
|
|
|
996
|
-
Defined in: [index.ts:
|
|
1006
|
+
Defined in: [index.ts:236](https://github.com/maiyunnet/kebab/blob/master/index.ts#L236)
|
|
997
1007
|
|
|
998
1008
|
***
|
|
999
1009
|
|
|
@@ -1001,7 +1011,7 @@ Defined in: [index.ts:234](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1001
1011
|
|
|
1002
1012
|
> `readonly` **size**: `number`
|
|
1003
1013
|
|
|
1004
|
-
Defined in: [index.ts:
|
|
1014
|
+
Defined in: [index.ts:235](https://github.com/maiyunnet/kebab/blob/master/index.ts#L235)
|
|
1005
1015
|
|
|
1006
1016
|
index/interfaces/IUrlParse.md
|
|
1007
1017
|
---
|
|
@@ -1115,7 +1125,7 @@ index/interfaces/IVhost.md
|
|
|
1115
1125
|
|
|
1116
1126
|
# Interface: IVhost
|
|
1117
1127
|
|
|
1118
|
-
Defined in: [index.ts:
|
|
1128
|
+
Defined in: [index.ts:224](https://github.com/maiyunnet/kebab/blob/master/index.ts#L224)
|
|
1119
1129
|
|
|
1120
1130
|
虚拟机配置对象
|
|
1121
1131
|
|
|
@@ -1125,7 +1135,7 @@ Defined in: [index.ts:222](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1125
1135
|
|
|
1126
1136
|
> `readonly` **domains**: `string`[]
|
|
1127
1137
|
|
|
1128
|
-
Defined in: [index.ts:
|
|
1138
|
+
Defined in: [index.ts:226](https://github.com/maiyunnet/kebab/blob/master/index.ts#L226)
|
|
1129
1139
|
|
|
1130
1140
|
***
|
|
1131
1141
|
|
|
@@ -1133,7 +1143,7 @@ Defined in: [index.ts:224](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1133
1143
|
|
|
1134
1144
|
> `readonly` `optional` **name?**: `string`
|
|
1135
1145
|
|
|
1136
|
-
Defined in: [index.ts:
|
|
1146
|
+
Defined in: [index.ts:225](https://github.com/maiyunnet/kebab/blob/master/index.ts#L225)
|
|
1137
1147
|
|
|
1138
1148
|
***
|
|
1139
1149
|
|
|
@@ -1141,7 +1151,7 @@ Defined in: [index.ts:223](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1141
1151
|
|
|
1142
1152
|
> `readonly` `optional` **remark?**: `string`
|
|
1143
1153
|
|
|
1144
|
-
Defined in: [index.ts:
|
|
1154
|
+
Defined in: [index.ts:228](https://github.com/maiyunnet/kebab/blob/master/index.ts#L228)
|
|
1145
1155
|
|
|
1146
1156
|
***
|
|
1147
1157
|
|
|
@@ -1149,7 +1159,7 @@ Defined in: [index.ts:226](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1149
1159
|
|
|
1150
1160
|
> `readonly` **root**: `string`
|
|
1151
1161
|
|
|
1152
|
-
Defined in: [index.ts:
|
|
1162
|
+
Defined in: [index.ts:227](https://github.com/maiyunnet/kebab/blob/master/index.ts#L227)
|
|
1153
1163
|
|
|
1154
1164
|
index.md
|
|
1155
1165
|
---
|
|
@@ -1428,7 +1438,7 @@ index/variables/VER.md
|
|
|
1428
1438
|
|
|
1429
1439
|
# Variable: VER
|
|
1430
1440
|
|
|
1431
|
-
> `const` **VER**: `"9.18.
|
|
1441
|
+
> `const` **VER**: `"9.18.2"` = `'9.18.2'`
|
|
1432
1442
|
|
|
1433
1443
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1434
1444
|
|
|
@@ -127887,7 +127897,7 @@ lib/undici/functions/fetch.md
|
|
|
127887
127897
|
|
|
127888
127898
|
> **fetch**(`input`, `init?`): `Promise`\<`Response`\>
|
|
127889
127899
|
|
|
127890
|
-
Defined in: [lib/undici.ts:
|
|
127900
|
+
Defined in: [lib/undici.ts:292](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L292)
|
|
127891
127901
|
|
|
127892
127902
|
发起一个完全兼容 fetch 的请求
|
|
127893
127903
|
|
|
@@ -127922,7 +127932,7 @@ lib/undici/functions/filterHeaders.md
|
|
|
127922
127932
|
|
|
127923
127933
|
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
127924
127934
|
|
|
127925
|
-
Defined in: [lib/undici.ts:
|
|
127935
|
+
Defined in: [lib/undici.ts:672](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L672)
|
|
127926
127936
|
|
|
127927
127937
|
剔除不代理的 header,返回新的 header
|
|
127928
127938
|
|
|
@@ -127963,7 +127973,7 @@ lib/undici/functions/getFormData.md
|
|
|
127963
127973
|
|
|
127964
127974
|
> **getFormData**(): [`FormData`](../formdata/classes/FormData.md)
|
|
127965
127975
|
|
|
127966
|
-
Defined in: [lib/undici.ts:
|
|
127976
|
+
Defined in: [lib/undici.ts:656](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L656)
|
|
127967
127977
|
|
|
127968
127978
|
创建 FormData 对象
|
|
127969
127979
|
|
|
@@ -127984,7 +127994,7 @@ lib/undici/functions/get.md
|
|
|
127984
127994
|
|
|
127985
127995
|
> **get**(`u`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
127986
127996
|
|
|
127987
|
-
Defined in: [lib/undici.ts:
|
|
127997
|
+
Defined in: [lib/undici.ts:169](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L169)
|
|
127988
127998
|
|
|
127989
127999
|
发起一个 get 请求
|
|
127990
128000
|
|
|
@@ -128046,7 +128056,7 @@ lib/undici/functions/getResponseJson.md
|
|
|
128046
128056
|
|
|
128047
128057
|
> **getResponseJson**(`u`, `opt?`): `Promise`\<`any`\>
|
|
128048
128058
|
|
|
128049
|
-
Defined in: [lib/undici.ts:
|
|
128059
|
+
Defined in: [lib/undici.ts:280](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L280)
|
|
128050
128060
|
|
|
128051
128061
|
发起 GET 请求并解析 JSON 响应
|
|
128052
128062
|
|
|
@@ -128083,7 +128093,7 @@ lib/undici/functions/mproxyData.md
|
|
|
128083
128093
|
|
|
128084
128094
|
> **mproxyData**(`ctr`): `any`
|
|
128085
128095
|
|
|
128086
|
-
Defined in: [lib/undici.ts:
|
|
128096
|
+
Defined in: [lib/undici.ts:778](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L778)
|
|
128087
128097
|
|
|
128088
128098
|
获取 mproxy 的附加数据
|
|
128089
128099
|
|
|
@@ -128112,7 +128122,7 @@ lib/undici/functions/mproxy.md
|
|
|
128112
128122
|
|
|
128113
128123
|
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
128114
128124
|
|
|
128115
|
-
Defined in: [lib/undici.ts:
|
|
128125
|
+
Defined in: [lib/undici.ts:712](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L712)
|
|
128116
128126
|
|
|
128117
128127
|
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
128118
128128
|
get: url, auth
|
|
@@ -128154,7 +128164,7 @@ lib/undici/functions/open.md
|
|
|
128154
128164
|
|
|
128155
128165
|
> **open**(`u`): [`Request`](../request/classes/Request.md)
|
|
128156
128166
|
|
|
128157
|
-
Defined in: [lib/undici.ts:
|
|
128167
|
+
Defined in: [lib/undici.ts:160](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L160)
|
|
128158
128168
|
|
|
128159
128169
|
创建一个请求对象
|
|
128160
128170
|
|
|
@@ -128181,7 +128191,7 @@ lib/undici/functions/postJson.md
|
|
|
128181
128191
|
|
|
128182
128192
|
> **postJson**(`u`, `data`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
128183
128193
|
|
|
128184
|
-
Defined in: [lib/undici.ts:
|
|
128194
|
+
Defined in: [lib/undici.ts:194](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L194)
|
|
128185
128195
|
|
|
128186
128196
|
发起 JSON 请求
|
|
128187
128197
|
|
|
@@ -128222,7 +128232,7 @@ lib/undici/functions/postJsonResponseJson.md
|
|
|
128222
128232
|
|
|
128223
128233
|
> **postJsonResponseJson**(`u`, `data`, `opt?`): `Promise`\<`any`\>
|
|
128224
128234
|
|
|
128225
|
-
Defined in: [lib/undici.ts:
|
|
128235
|
+
Defined in: [lib/undici.ts:252](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L252)
|
|
128226
128236
|
|
|
128227
128237
|
发起 JSON 请求并解析 JSON 响应
|
|
128228
128238
|
|
|
@@ -128265,7 +128275,7 @@ lib/undici/functions/post.md
|
|
|
128265
128275
|
|
|
128266
128276
|
> **post**(`u`, `data`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
128267
128277
|
|
|
128268
|
-
Defined in: [lib/undici.ts:
|
|
128278
|
+
Defined in: [lib/undici.ts:179](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L179)
|
|
128269
128279
|
|
|
128270
128280
|
发起一个 post 请求
|
|
128271
128281
|
|
|
@@ -128306,7 +128316,7 @@ lib/undici/functions/postResponseJson.md
|
|
|
128306
128316
|
|
|
128307
128317
|
> **postResponseJson**(`u`, `data`, `opt?`): `Promise`\<`any`\>
|
|
128308
128318
|
|
|
128309
|
-
Defined in: [lib/undici.ts:
|
|
128319
|
+
Defined in: [lib/undici.ts:267](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L267)
|
|
128310
128320
|
|
|
128311
128321
|
发起 POST 请求并解析 JSON 响应
|
|
128312
128322
|
|
|
@@ -128349,7 +128359,7 @@ lib/undici/functions/request.md
|
|
|
128349
128359
|
|
|
128350
128360
|
> **request**(`u`, `data?`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
128351
128361
|
|
|
128352
|
-
Defined in: [lib/undici.ts:
|
|
128362
|
+
Defined in: [lib/undici.ts:470](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L470)
|
|
128353
128363
|
|
|
128354
128364
|
发起一个请求
|
|
128355
128365
|
|
|
@@ -128386,7 +128396,7 @@ lib/undici/functions/rproxy.md
|
|
|
128386
128396
|
|
|
128387
128397
|
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
128388
128398
|
|
|
128389
|
-
Defined in: [lib/undici.ts:
|
|
128399
|
+
Defined in: [lib/undici.ts:808](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L808)
|
|
128390
128400
|
|
|
128391
128401
|
反向代理,将本服务器的某个路由反代到其他网址
|
|
128392
128402
|
|
|
@@ -128475,7 +128485,7 @@ lib/undici/interfaces/IMproxyOptions.md
|
|
|
128475
128485
|
|
|
128476
128486
|
# Interface: IMproxyOptions
|
|
128477
128487
|
|
|
128478
|
-
Defined in: [lib/undici.ts:
|
|
128488
|
+
Defined in: [lib/undici.ts:943](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L943)
|
|
128479
128489
|
|
|
128480
128490
|
正向代理请求的传入参数选项
|
|
128481
128491
|
|
|
@@ -128485,7 +128495,7 @@ Defined in: [lib/undici.ts:902](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128485
128495
|
|
|
128486
128496
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
128487
128497
|
|
|
128488
|
-
Defined in: [lib/undici.ts:
|
|
128498
|
+
Defined in: [lib/undici.ts:956](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L956)
|
|
128489
128499
|
|
|
128490
128500
|
过滤 header,返回 true 则留下
|
|
128491
128501
|
|
|
@@ -128505,7 +128515,7 @@ Defined in: [lib/undici.ts:911](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128505
128515
|
|
|
128506
128516
|
> `optional` **follow?**: `number`
|
|
128507
128517
|
|
|
128508
|
-
Defined in: [lib/undici.ts:
|
|
128518
|
+
Defined in: [lib/undici.ts:946](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L946)
|
|
128509
128519
|
|
|
128510
128520
|
***
|
|
128511
128521
|
|
|
@@ -128513,7 +128523,7 @@ Defined in: [lib/undici.ts:905](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128513
128523
|
|
|
128514
128524
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
128515
128525
|
|
|
128516
|
-
Defined in: [lib/undici.ts:
|
|
128526
|
+
Defined in: [lib/undici.ts:950](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L950)
|
|
128517
128527
|
|
|
128518
128528
|
***
|
|
128519
128529
|
|
|
@@ -128521,17 +128531,27 @@ Defined in: [lib/undici.ts:909](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128521
128531
|
|
|
128522
128532
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
128523
128533
|
|
|
128524
|
-
Defined in: [lib/undici.ts:
|
|
128534
|
+
Defined in: [lib/undici.ts:948](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L948)
|
|
128525
128535
|
|
|
128526
128536
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
128527
128537
|
|
|
128528
128538
|
***
|
|
128529
128539
|
|
|
128540
|
+
### keepAliveTimeout?
|
|
128541
|
+
|
|
128542
|
+
> `optional` **keepAliveTimeout?**: `number`
|
|
128543
|
+
|
|
128544
|
+
Defined in: [lib/undici.ts:952](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L952)
|
|
128545
|
+
|
|
128546
|
+
空闲连接允许复用的最长秒数;非正数或无效值按未设置处理;默认无服务端提示时为 4 秒,有提示时采用提示值减 2 秒且最多 600 秒
|
|
128547
|
+
|
|
128548
|
+
***
|
|
128549
|
+
|
|
128530
128550
|
### local?
|
|
128531
128551
|
|
|
128532
128552
|
> `optional` **local?**: `string`
|
|
128533
128553
|
|
|
128534
|
-
Defined in: [lib/undici.ts:
|
|
128554
|
+
Defined in: [lib/undici.ts:949](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L949)
|
|
128535
128555
|
|
|
128536
128556
|
***
|
|
128537
128557
|
|
|
@@ -128539,17 +128559,27 @@ Defined in: [lib/undici.ts:908](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128539
128559
|
|
|
128540
128560
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
128541
128561
|
|
|
128542
|
-
Defined in: [lib/undici.ts:
|
|
128562
|
+
Defined in: [lib/undici.ts:958](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L958)
|
|
128543
128563
|
|
|
128544
128564
|
默认为 default
|
|
128545
128565
|
|
|
128546
128566
|
***
|
|
128547
128567
|
|
|
128568
|
+
### reuseTimeout?
|
|
128569
|
+
|
|
128570
|
+
> `optional` **reuseTimeout?**: `number`
|
|
128571
|
+
|
|
128572
|
+
Defined in: [lib/undici.ts:954](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L954)
|
|
128573
|
+
|
|
128574
|
+
连接建立后允许承接新请求的最长秒数;非正数或无效值按未设置处理;达到后不再复用但不会中断在途请求,默认不限制
|
|
128575
|
+
|
|
128576
|
+
***
|
|
128577
|
+
|
|
128548
128578
|
### timeout?
|
|
128549
128579
|
|
|
128550
128580
|
> `optional` **timeout?**: `number`
|
|
128551
128581
|
|
|
128552
|
-
Defined in: [lib/undici.ts:
|
|
128582
|
+
Defined in: [lib/undici.ts:945](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L945)
|
|
128553
128583
|
|
|
128554
128584
|
秒数,默认 300 秒
|
|
128555
128585
|
|
|
@@ -128564,7 +128594,7 @@ lib/undici/interfaces/IRequestOptions.md
|
|
|
128564
128594
|
|
|
128565
128595
|
# Interface: IRequestOptions
|
|
128566
128596
|
|
|
128567
|
-
Defined in: [lib/undici.ts:
|
|
128597
|
+
Defined in: [lib/undici.ts:900](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L900)
|
|
128568
128598
|
|
|
128569
128599
|
请求的传入参数选项
|
|
128570
128600
|
|
|
@@ -128574,7 +128604,7 @@ Defined in: [lib/undici.ts:863](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128574
128604
|
|
|
128575
128605
|
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
128576
128606
|
|
|
128577
|
-
Defined in: [lib/undici.ts:
|
|
128607
|
+
Defined in: [lib/undici.ts:935](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L935)
|
|
128578
128608
|
|
|
128579
128609
|
cookie 托管对象
|
|
128580
128610
|
|
|
@@ -128584,7 +128614,7 @@ cookie 托管对象
|
|
|
128584
128614
|
|
|
128585
128615
|
> `optional` **follow?**: `number`
|
|
128586
128616
|
|
|
128587
|
-
Defined in: [lib/undici.ts:
|
|
128617
|
+
Defined in: [lib/undici.ts:912](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L912)
|
|
128588
128618
|
|
|
128589
128619
|
追踪 location 次数,0 为不追踪,默认为 0
|
|
128590
128620
|
|
|
@@ -128594,7 +128624,7 @@ Defined in: [lib/undici.ts:875](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128594
128624
|
|
|
128595
128625
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
128596
128626
|
|
|
128597
|
-
Defined in: [lib/undici.ts:
|
|
128627
|
+
Defined in: [lib/undici.ts:917](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L917)
|
|
128598
128628
|
|
|
128599
128629
|
***
|
|
128600
128630
|
|
|
@@ -128602,7 +128632,7 @@ Defined in: [lib/undici.ts:880](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128602
128632
|
|
|
128603
128633
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
128604
128634
|
|
|
128605
|
-
Defined in: [lib/undici.ts:
|
|
128635
|
+
Defined in: [lib/undici.ts:914](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L914)
|
|
128606
128636
|
|
|
128607
128637
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
128608
128638
|
|
|
@@ -128612,17 +128642,27 @@ Defined in: [lib/undici.ts:877](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128612
128642
|
|
|
128613
128643
|
> `optional` **keep?**: `boolean`
|
|
128614
128644
|
|
|
128615
|
-
Defined in: [lib/undici.ts:
|
|
128645
|
+
Defined in: [lib/undici.ts:927](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L927)
|
|
128616
128646
|
|
|
128617
128647
|
连接是否保持长连接(即是否允许复用),默认为 true
|
|
128618
128648
|
|
|
128619
128649
|
***
|
|
128620
128650
|
|
|
128651
|
+
### keepAliveTimeout?
|
|
128652
|
+
|
|
128653
|
+
> `optional` **keepAliveTimeout?**: `number`
|
|
128654
|
+
|
|
128655
|
+
Defined in: [lib/undici.ts:929](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L929)
|
|
128656
|
+
|
|
128657
|
+
空闲连接允许复用的最长秒数;非正数或无效值按未设置处理;默认无服务端提示时为 4 秒,有提示时采用提示值减 2 秒且最多 600 秒;自定义 Agent 由其自身配置
|
|
128658
|
+
|
|
128659
|
+
***
|
|
128660
|
+
|
|
128621
128661
|
### local?
|
|
128622
128662
|
|
|
128623
128663
|
> `optional` **local?**: `string`
|
|
128624
128664
|
|
|
128625
|
-
Defined in: [lib/undici.ts:
|
|
128665
|
+
Defined in: [lib/undici.ts:916](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L916)
|
|
128626
128666
|
|
|
128627
128667
|
***
|
|
128628
128668
|
|
|
@@ -128630,7 +128670,7 @@ Defined in: [lib/undici.ts:879](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128630
128670
|
|
|
128631
128671
|
> `optional` **log?**: `boolean`
|
|
128632
128672
|
|
|
128633
|
-
Defined in: [lib/undici.ts:
|
|
128673
|
+
Defined in: [lib/undici.ts:937](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L937)
|
|
128634
128674
|
|
|
128635
128675
|
若有异常写入文件日志,默认为 true
|
|
128636
128676
|
|
|
@@ -128640,7 +128680,7 @@ Defined in: [lib/undici.ts:896](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128640
128680
|
|
|
128641
128681
|
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
128642
128682
|
|
|
128643
|
-
Defined in: [lib/undici.ts:
|
|
128683
|
+
Defined in: [lib/undici.ts:901](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L901)
|
|
128644
128684
|
|
|
128645
128685
|
***
|
|
128646
128686
|
|
|
@@ -128648,7 +128688,7 @@ Defined in: [lib/undici.ts:864](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128648
128688
|
|
|
128649
128689
|
> `optional` **mproxy?**: `object`
|
|
128650
128690
|
|
|
128651
|
-
Defined in: [lib/undici.ts:
|
|
128691
|
+
Defined in: [lib/undici.ts:919](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L919)
|
|
128652
128692
|
|
|
128653
128693
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
128654
128694
|
|
|
@@ -128676,7 +128716,7 @@ Defined in: [lib/undici.ts:882](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128676
128716
|
|
|
128677
128717
|
> `optional` **retry?**: `number`
|
|
128678
128718
|
|
|
128679
|
-
Defined in: [lib/undici.ts:
|
|
128719
|
+
Defined in: [lib/undici.ts:906](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L906)
|
|
128680
128720
|
|
|
128681
128721
|
网络异常后的重试次数,默认 0;流式请求体不可重试,非幂等请求需由调用方保证安全
|
|
128682
128722
|
|
|
@@ -128686,7 +128726,7 @@ Defined in: [lib/undici.ts:869](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128686
128726
|
|
|
128687
128727
|
> `optional` **retryJson?**: `number`
|
|
128688
128728
|
|
|
128689
|
-
Defined in: [lib/undici.ts:
|
|
128729
|
+
Defined in: [lib/undici.ts:908](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L908)
|
|
128690
128730
|
|
|
128691
128731
|
JSON 解析失败后的重试次数,默认 0;仅适用于 ResponseJson 快捷方法,非幂等请求需由调用方保证安全
|
|
128692
128732
|
|
|
@@ -128696,7 +128736,7 @@ JSON 解析失败后的重试次数,默认 0;仅适用于 ResponseJson 快
|
|
|
128696
128736
|
|
|
128697
128737
|
> `optional` **retryJsonHandler?**: (`json`) => `boolean`
|
|
128698
128738
|
|
|
128699
|
-
Defined in: [lib/undici.ts:
|
|
128739
|
+
Defined in: [lib/undici.ts:910](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L910)
|
|
128700
128740
|
|
|
128701
128741
|
JSON 重试验证方法;返回 false 时按 retryJson 的设置重试,仅适用于 ResponseJson 快捷方法
|
|
128702
128742
|
|
|
@@ -128716,17 +128756,27 @@ JSON 重试验证方法;返回 false 时按 retryJson 的设置重试,仅适
|
|
|
128716
128756
|
|
|
128717
128757
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
128718
128758
|
|
|
128719
|
-
Defined in: [lib/undici.ts:
|
|
128759
|
+
Defined in: [lib/undici.ts:933](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L933)
|
|
128720
128760
|
|
|
128721
128761
|
复用池名/Agent,默认为 default
|
|
128722
128762
|
|
|
128723
128763
|
***
|
|
128724
128764
|
|
|
128765
|
+
### reuseTimeout?
|
|
128766
|
+
|
|
128767
|
+
> `optional` **reuseTimeout?**: `number`
|
|
128768
|
+
|
|
128769
|
+
Defined in: [lib/undici.ts:931](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L931)
|
|
128770
|
+
|
|
128771
|
+
连接建立后允许承接新请求的最长秒数;非正数或无效值按未设置处理;达到后不再复用但不会中断在途请求,默认不限制;自定义 Agent 由其自身配置
|
|
128772
|
+
|
|
128773
|
+
***
|
|
128774
|
+
|
|
128725
128775
|
### save?
|
|
128726
128776
|
|
|
128727
128777
|
> `optional` **save?**: `string`
|
|
128728
128778
|
|
|
128729
|
-
Defined in: [lib/undici.ts:
|
|
128779
|
+
Defined in: [lib/undici.ts:915](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L915)
|
|
128730
128780
|
|
|
128731
128781
|
***
|
|
128732
128782
|
|
|
@@ -128734,7 +128784,7 @@ Defined in: [lib/undici.ts:878](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128734
128784
|
|
|
128735
128785
|
> `optional` **signal?**: `AbortSignal`
|
|
128736
128786
|
|
|
128737
|
-
Defined in: [lib/undici.ts:
|
|
128787
|
+
Defined in: [lib/undici.ts:939](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L939)
|
|
128738
128788
|
|
|
128739
128789
|
请求中止信号
|
|
128740
128790
|
|
|
@@ -128744,7 +128794,7 @@ Defined in: [lib/undici.ts:898](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128744
128794
|
|
|
128745
128795
|
> `optional` **timeout?**: `number`
|
|
128746
128796
|
|
|
128747
|
-
Defined in: [lib/undici.ts:
|
|
128797
|
+
Defined in: [lib/undici.ts:904](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L904)
|
|
128748
128798
|
|
|
128749
128799
|
秒数,默认 300 秒
|
|
128750
128800
|
|
|
@@ -128754,7 +128804,7 @@ Defined in: [lib/undici.ts:867](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128754
128804
|
|
|
128755
128805
|
> `optional` **type?**: `"form"` \| `"json"`
|
|
128756
128806
|
|
|
128757
|
-
Defined in: [lib/undici.ts:
|
|
128807
|
+
Defined in: [lib/undici.ts:902](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L902)
|
|
128758
128808
|
|
|
128759
128809
|
lib/undici/interfaces/IRproxyOptions.md
|
|
128760
128810
|
---
|
|
@@ -128767,7 +128817,7 @@ lib/undici/interfaces/IRproxyOptions.md
|
|
|
128767
128817
|
|
|
128768
128818
|
# Interface: IRproxyOptions
|
|
128769
128819
|
|
|
128770
|
-
Defined in: [lib/undici.ts:
|
|
128820
|
+
Defined in: [lib/undici.ts:962](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L962)
|
|
128771
128821
|
|
|
128772
128822
|
反向代理请求的传入参数选项
|
|
128773
128823
|
|
|
@@ -128777,7 +128827,7 @@ Defined in: [lib/undici.ts:917](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128777
128827
|
|
|
128778
128828
|
> `optional` **body?**: `string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
128779
128829
|
|
|
128780
|
-
Defined in: [lib/undici.ts:
|
|
128830
|
+
Defined in: [lib/undici.ts:985](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L985)
|
|
128781
128831
|
|
|
128782
128832
|
手动传入请求体(优先于原始 req 流),用于 req 流已消费后仍需转发 body 的场景
|
|
128783
128833
|
|
|
@@ -128787,7 +128837,7 @@ Defined in: [lib/undici.ts:936](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128787
128837
|
|
|
128788
128838
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
128789
128839
|
|
|
128790
|
-
Defined in: [lib/undici.ts:
|
|
128840
|
+
Defined in: [lib/undici.ts:975](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L975)
|
|
128791
128841
|
|
|
128792
128842
|
过滤 header,返回 true 则留下
|
|
128793
128843
|
|
|
@@ -128807,7 +128857,7 @@ Defined in: [lib/undici.ts:926](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128807
128857
|
|
|
128808
128858
|
> `optional` **follow?**: `number`
|
|
128809
128859
|
|
|
128810
|
-
Defined in: [lib/undici.ts:
|
|
128860
|
+
Defined in: [lib/undici.ts:965](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L965)
|
|
128811
128861
|
|
|
128812
128862
|
***
|
|
128813
128863
|
|
|
@@ -128815,7 +128865,7 @@ Defined in: [lib/undici.ts:920](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128815
128865
|
|
|
128816
128866
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
128817
128867
|
|
|
128818
|
-
Defined in: [lib/undici.ts:
|
|
128868
|
+
Defined in: [lib/undici.ts:969](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L969)
|
|
128819
128869
|
|
|
128820
128870
|
***
|
|
128821
128871
|
|
|
@@ -128823,17 +128873,27 @@ Defined in: [lib/undici.ts:924](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128823
128873
|
|
|
128824
128874
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
128825
128875
|
|
|
128826
|
-
Defined in: [lib/undici.ts:
|
|
128876
|
+
Defined in: [lib/undici.ts:967](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L967)
|
|
128827
128877
|
|
|
128828
128878
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
128829
128879
|
|
|
128830
128880
|
***
|
|
128831
128881
|
|
|
128882
|
+
### keepAliveTimeout?
|
|
128883
|
+
|
|
128884
|
+
> `optional` **keepAliveTimeout?**: `number`
|
|
128885
|
+
|
|
128886
|
+
Defined in: [lib/undici.ts:971](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L971)
|
|
128887
|
+
|
|
128888
|
+
空闲连接允许复用的最长秒数;非正数或无效值按未设置处理;默认无服务端提示时为 4 秒,有提示时采用提示值减 2 秒且最多 600 秒
|
|
128889
|
+
|
|
128890
|
+
***
|
|
128891
|
+
|
|
128832
128892
|
### local?
|
|
128833
128893
|
|
|
128834
128894
|
> `optional` **local?**: `string`
|
|
128835
128895
|
|
|
128836
|
-
Defined in: [lib/undici.ts:
|
|
128896
|
+
Defined in: [lib/undici.ts:968](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L968)
|
|
128837
128897
|
|
|
128838
128898
|
***
|
|
128839
128899
|
|
|
@@ -128841,7 +128901,7 @@ Defined in: [lib/undici.ts:923](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128841
128901
|
|
|
128842
128902
|
> `optional` **mproxy?**: `object`
|
|
128843
128903
|
|
|
128844
|
-
Defined in: [lib/undici.ts:
|
|
128904
|
+
Defined in: [lib/undici.ts:977](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L977)
|
|
128845
128905
|
|
|
128846
128906
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
128847
128907
|
|
|
@@ -128869,7 +128929,7 @@ Defined in: [lib/undici.ts:928](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128869
128929
|
|
|
128870
128930
|
> `optional` **querys?**: `Record`\<`string`, `any`\>
|
|
128871
128931
|
|
|
128872
|
-
Defined in: [lib/undici.ts:
|
|
128932
|
+
Defined in: [lib/undici.ts:987](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L987)
|
|
128873
128933
|
|
|
128874
128934
|
自定义 GET 查询参数,传入后直接替换代理目标 URL 的整个 query string
|
|
128875
128935
|
|
|
@@ -128879,17 +128939,27 @@ Defined in: [lib/undici.ts:938](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
128879
128939
|
|
|
128880
128940
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
128881
128941
|
|
|
128882
|
-
Defined in: [lib/undici.ts:
|
|
128942
|
+
Defined in: [lib/undici.ts:989](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L989)
|
|
128883
128943
|
|
|
128884
128944
|
默认为 default
|
|
128885
128945
|
|
|
128886
128946
|
***
|
|
128887
128947
|
|
|
128948
|
+
### reuseTimeout?
|
|
128949
|
+
|
|
128950
|
+
> `optional` **reuseTimeout?**: `number`
|
|
128951
|
+
|
|
128952
|
+
Defined in: [lib/undici.ts:973](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L973)
|
|
128953
|
+
|
|
128954
|
+
连接建立后允许承接新请求的最长秒数;非正数或无效值按未设置处理;达到后不再复用但不会中断在途请求,默认不限制
|
|
128955
|
+
|
|
128956
|
+
***
|
|
128957
|
+
|
|
128888
128958
|
### timeout?
|
|
128889
128959
|
|
|
128890
128960
|
> `optional` **timeout?**: `number`
|
|
128891
128961
|
|
|
128892
|
-
Defined in: [lib/undici.ts:
|
|
128962
|
+
Defined in: [lib/undici.ts:964](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L964)
|
|
128893
128963
|
|
|
128894
128964
|
秒数,默认 300 秒
|
|
128895
128965
|
|
|
@@ -128952,7 +129022,7 @@ Defined in: [lib/undici/request.ts:30](https://github.com/maiyunnet/kebab/blob/m
|
|
|
128952
129022
|
|
|
128953
129023
|
> **follow**(`follow?`): `this`
|
|
128954
129024
|
|
|
128955
|
-
Defined in: [lib/undici/request.ts:
|
|
129025
|
+
Defined in: [lib/undici/request.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L114)
|
|
128956
129026
|
|
|
128957
129027
|
设置是否跟随请求方的 location,留空为跟随,不设置为不跟随
|
|
128958
129028
|
|
|
@@ -128986,7 +129056,7 @@ method get 方法别名
|
|
|
128986
129056
|
|
|
128987
129057
|
> **headers**(`headers`): `this`
|
|
128988
129058
|
|
|
128989
|
-
Defined in: [lib/undici/request.ts:
|
|
129059
|
+
Defined in: [lib/undici/request.ts:150](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L150)
|
|
128990
129060
|
|
|
128991
129061
|
批量设置提交的 headers
|
|
128992
129062
|
|
|
@@ -129006,7 +129076,7 @@ Defined in: [lib/undici/request.ts:132](https://github.com/maiyunnet/kebab/blob/
|
|
|
129006
129076
|
|
|
129007
129077
|
> **hosts**(`hosts`): `this`
|
|
129008
129078
|
|
|
129009
|
-
Defined in: [lib/undici/request.ts:
|
|
129079
|
+
Defined in: [lib/undici/request.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L123)
|
|
129010
129080
|
|
|
129011
129081
|
设置域名 -> ip的对应键值,就像电脑里的 hosts 一样
|
|
129012
129082
|
|
|
@@ -129036,11 +129106,33 @@ type json 方法别名
|
|
|
129036
129106
|
|
|
129037
129107
|
***
|
|
129038
129108
|
|
|
129109
|
+
### keepAliveTimeout()
|
|
129110
|
+
|
|
129111
|
+
> **keepAliveTimeout**(`timeout`): `this`
|
|
129112
|
+
|
|
129113
|
+
Defined in: [lib/undici/request.ts:87](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L87)
|
|
129114
|
+
|
|
129115
|
+
设置空闲连接允许复用的最长时间
|
|
129116
|
+
|
|
129117
|
+
#### Parameters
|
|
129118
|
+
|
|
129119
|
+
##### timeout
|
|
129120
|
+
|
|
129121
|
+
`number`
|
|
129122
|
+
|
|
129123
|
+
秒数;非正数或无效值按未设置处理;默认无服务端提示时为 4 秒,有提示时采用提示值减 2 秒且最多 600 秒
|
|
129124
|
+
|
|
129125
|
+
#### Returns
|
|
129126
|
+
|
|
129127
|
+
`this`
|
|
129128
|
+
|
|
129129
|
+
***
|
|
129130
|
+
|
|
129039
129131
|
### local()
|
|
129040
129132
|
|
|
129041
129133
|
> **local**(`addr`): `this`
|
|
129042
129134
|
|
|
129043
|
-
Defined in: [lib/undici/request.ts:
|
|
129135
|
+
Defined in: [lib/undici/request.ts:141](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L141)
|
|
129044
129136
|
|
|
129045
129137
|
设置使用的本地网卡 IP
|
|
129046
129138
|
|
|
@@ -129094,7 +129186,7 @@ method post 方法别名
|
|
|
129094
129186
|
|
|
129095
129187
|
> **request**(`cookie?`): `Promise`\<[`Response`](../../response/classes/Response.md)\>
|
|
129096
129188
|
|
|
129097
|
-
Defined in: [lib/undici/request.ts:
|
|
129189
|
+
Defined in: [lib/undici/request.ts:170](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L170)
|
|
129098
129190
|
|
|
129099
129191
|
发起请求
|
|
129100
129192
|
|
|
@@ -129114,7 +129206,7 @@ Defined in: [lib/undici/request.ts:152](https://github.com/maiyunnet/kebab/blob/
|
|
|
129114
129206
|
|
|
129115
129207
|
> **retry**(`retry?`): `this`
|
|
129116
129208
|
|
|
129117
|
-
Defined in: [lib/undici/request.ts:
|
|
129209
|
+
Defined in: [lib/undici/request.ts:105](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L105)
|
|
129118
129210
|
|
|
129119
129211
|
设置网络异常后的重试次数
|
|
129120
129212
|
|
|
@@ -129132,11 +129224,33 @@ Defined in: [lib/undici/request.ts:87](https://github.com/maiyunnet/kebab/blob/m
|
|
|
129132
129224
|
|
|
129133
129225
|
***
|
|
129134
129226
|
|
|
129227
|
+
### reuseTimeout()
|
|
129228
|
+
|
|
129229
|
+
> **reuseTimeout**(`timeout`): `this`
|
|
129230
|
+
|
|
129231
|
+
Defined in: [lib/undici/request.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L96)
|
|
129232
|
+
|
|
129233
|
+
设置连接建立后允许承接新请求的最长时间
|
|
129234
|
+
|
|
129235
|
+
#### Parameters
|
|
129236
|
+
|
|
129237
|
+
##### timeout
|
|
129238
|
+
|
|
129239
|
+
`number`
|
|
129240
|
+
|
|
129241
|
+
秒数;非正数或无效值按未设置处理;达到后不再复用但不会中断在途请求,默认不限制
|
|
129242
|
+
|
|
129243
|
+
#### Returns
|
|
129244
|
+
|
|
129245
|
+
`this`
|
|
129246
|
+
|
|
129247
|
+
***
|
|
129248
|
+
|
|
129135
129249
|
### save()
|
|
129136
129250
|
|
|
129137
129251
|
> **save**(`save`): `this`
|
|
129138
129252
|
|
|
129139
|
-
Defined in: [lib/undici/request.ts:
|
|
129253
|
+
Defined in: [lib/undici/request.ts:132](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L132)
|
|
129140
129254
|
|
|
129141
129255
|
设置后将直接保存到本地文件,不会返回,save 为本地实体路径
|
|
129142
129256
|
|
|
@@ -129156,7 +129270,7 @@ Defined in: [lib/undici/request.ts:114](https://github.com/maiyunnet/kebab/blob/
|
|
|
129156
129270
|
|
|
129157
129271
|
> **setHeader**(`name`, `val`): `this`
|
|
129158
129272
|
|
|
129159
|
-
Defined in: [lib/undici/request.ts:
|
|
129273
|
+
Defined in: [lib/undici/request.ts:160](https://github.com/maiyunnet/kebab/blob/master/lib/undici/request.ts#L160)
|
|
129160
129274
|
|
|
129161
129275
|
设置单条 header
|
|
129162
129276
|
|
|
@@ -129400,7 +129514,7 @@ lib/undici/type-aliases/THttpHeaders.md
|
|
|
129400
129514
|
|
|
129401
129515
|
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
129402
129516
|
|
|
129403
|
-
Defined in: [lib/undici.ts:
|
|
129517
|
+
Defined in: [lib/undici.ts:994](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L994)
|
|
129404
129518
|
|
|
129405
129519
|
http headers
|
|
129406
129520
|
|
|
@@ -132384,7 +132498,7 @@ sys/ctr/classes/Ctr.md
|
|
|
132384
132498
|
|
|
132385
132499
|
# Class: Ctr
|
|
132386
132500
|
|
|
132387
|
-
Defined in: [sys/ctr.ts:
|
|
132501
|
+
Defined in: [sys/ctr.ts:123](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L123)
|
|
132388
132502
|
|
|
132389
132503
|
## Constructors
|
|
132390
132504
|
|
|
@@ -132392,7 +132506,7 @@ Defined in: [sys/ctr.ts:98](https://github.com/maiyunnet/kebab/blob/master/sys/c
|
|
|
132392
132506
|
|
|
132393
132507
|
> **new Ctr**(`config`, `req`, `res?`): `Ctr`
|
|
132394
132508
|
|
|
132395
|
-
Defined in: [sys/ctr.ts:
|
|
132509
|
+
Defined in: [sys/ctr.ts:185](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L185)
|
|
132396
132510
|
|
|
132397
132511
|
#### Parameters
|
|
132398
132512
|
|
|
@@ -132418,7 +132532,7 @@ Defined in: [sys/ctr.ts:160](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132418
132532
|
|
|
132419
132533
|
> `protected` **\_action**: `string` = `''`
|
|
132420
132534
|
|
|
132421
|
-
Defined in: [sys/ctr.ts:
|
|
132535
|
+
Defined in: [sys/ctr.ts:129](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L129)
|
|
132422
132536
|
|
|
132423
132537
|
当前的 action 名
|
|
132424
132538
|
|
|
@@ -132428,7 +132542,7 @@ Defined in: [sys/ctr.ts:104](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132428
132542
|
|
|
132429
132543
|
> `protected` **\_cacheTTL**: `number`
|
|
132430
132544
|
|
|
132431
|
-
Defined in: [sys/ctr.ts:
|
|
132545
|
+
Defined in: [sys/ctr.ts:159](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L159)
|
|
132432
132546
|
|
|
132433
132547
|
页面浏览器客户端缓存(单位:秒)
|
|
132434
132548
|
|
|
@@ -132438,7 +132552,7 @@ Defined in: [sys/ctr.ts:134](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132438
132552
|
|
|
132439
132553
|
> `protected` `readonly` **\_config**: [`IConfig`](../../../index/interfaces/IConfig.md)
|
|
132440
132554
|
|
|
132441
|
-
Defined in: [sys/ctr.ts:
|
|
132555
|
+
Defined in: [sys/ctr.ts:171](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L171)
|
|
132442
132556
|
|
|
132443
132557
|
vhost 的 kebab.json 以及全局常量
|
|
132444
132558
|
|
|
@@ -132448,7 +132562,7 @@ vhost 的 kebab.json 以及全局常量
|
|
|
132448
132562
|
|
|
132449
132563
|
> `protected` **\_cookie**: `Record`\<`string`, `string`\> = `{}`
|
|
132450
132564
|
|
|
132451
|
-
Defined in: [sys/ctr.ts:
|
|
132565
|
+
Defined in: [sys/ctr.ts:150](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L150)
|
|
132452
132566
|
|
|
132453
132567
|
Cookie 数组
|
|
132454
132568
|
|
|
@@ -132458,7 +132572,7 @@ Cookie 数组
|
|
|
132458
132572
|
|
|
132459
132573
|
> `protected` **\_files**: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\> = `{}`
|
|
132460
132574
|
|
|
132461
|
-
Defined in: [sys/ctr.ts:
|
|
132575
|
+
Defined in: [sys/ctr.ts:147](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L147)
|
|
132462
132576
|
|
|
132463
132577
|
上传的文件列表
|
|
132464
132578
|
|
|
@@ -132468,7 +132582,7 @@ Defined in: [sys/ctr.ts:122](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132468
132582
|
|
|
132469
132583
|
> `protected` **\_get**: `Record`\<`string`, `string`\>
|
|
132470
132584
|
|
|
132471
|
-
Defined in: [sys/ctr.ts:
|
|
132585
|
+
Defined in: [sys/ctr.ts:135](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L135)
|
|
132472
132586
|
|
|
132473
132587
|
GET 数据
|
|
132474
132588
|
|
|
@@ -132478,7 +132592,7 @@ GET 数据
|
|
|
132478
132592
|
|
|
132479
132593
|
> `protected` **\_headers**: `IncomingHttpHeaders` = `{}`
|
|
132480
132594
|
|
|
132481
|
-
Defined in: [sys/ctr.ts:
|
|
132595
|
+
Defined in: [sys/ctr.ts:132](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L132)
|
|
132482
132596
|
|
|
132483
132597
|
请求的 header 列表,key 均为小写
|
|
132484
132598
|
|
|
@@ -132488,7 +132602,7 @@ Defined in: [sys/ctr.ts:107](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132488
132602
|
|
|
132489
132603
|
> `protected` **\_httpCode**: `number` = `0`
|
|
132490
132604
|
|
|
132491
|
-
Defined in: [sys/ctr.ts:
|
|
132605
|
+
Defined in: [sys/ctr.ts:165](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L165)
|
|
132492
132606
|
|
|
132493
132607
|
自定义 http code
|
|
132494
132608
|
|
|
@@ -132498,7 +132612,7 @@ Defined in: [sys/ctr.ts:140](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132498
132612
|
|
|
132499
132613
|
> `protected` **\_input**: `string` = `''`
|
|
132500
132614
|
|
|
132501
|
-
Defined in: [sys/ctr.ts:
|
|
132615
|
+
Defined in: [sys/ctr.ts:144](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L144)
|
|
132502
132616
|
|
|
132503
132617
|
原始 input 字符串
|
|
132504
132618
|
|
|
@@ -132508,7 +132622,7 @@ Defined in: [sys/ctr.ts:119](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132508
132622
|
|
|
132509
132623
|
> `protected` **\_locale**: `string` = `'en'`
|
|
132510
132624
|
|
|
132511
|
-
Defined in: [sys/ctr.ts:
|
|
132625
|
+
Defined in: [sys/ctr.ts:168](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L168)
|
|
132512
132626
|
|
|
132513
132627
|
当前语言名
|
|
132514
132628
|
|
|
@@ -132518,7 +132632,7 @@ Defined in: [sys/ctr.ts:143](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132518
132632
|
|
|
132519
132633
|
> `protected` **\_localeData**: `Record`\<`string`, `Record`\<`string`, `string`\>\> = `{}`
|
|
132520
132634
|
|
|
132521
|
-
Defined in: [sys/ctr.ts:
|
|
132635
|
+
Defined in: [sys/ctr.ts:183](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L183)
|
|
132522
132636
|
|
|
132523
132637
|
本 ctr 的 locale data
|
|
132524
132638
|
|
|
@@ -132528,7 +132642,7 @@ Defined in: [sys/ctr.ts:158](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132528
132642
|
|
|
132529
132643
|
> `protected` **\_localeFiles**: `string`[] = `[]`
|
|
132530
132644
|
|
|
132531
|
-
Defined in: [sys/ctr.ts:
|
|
132645
|
+
Defined in: [sys/ctr.ts:180](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L180)
|
|
132532
132646
|
|
|
132533
132647
|
本 ctr 已加载的语言文件列表
|
|
132534
132648
|
|
|
@@ -132538,7 +132652,7 @@ Defined in: [sys/ctr.ts:155](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132538
132652
|
|
|
132539
132653
|
> `protected` **\_param**: `string`[] = `[]`
|
|
132540
132654
|
|
|
132541
|
-
Defined in: [sys/ctr.ts:
|
|
132655
|
+
Defined in: [sys/ctr.ts:126](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L126)
|
|
132542
132656
|
|
|
132543
132657
|
路由参数序列数组
|
|
132544
132658
|
|
|
@@ -132548,7 +132662,7 @@ Defined in: [sys/ctr.ts:101](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132548
132662
|
|
|
132549
132663
|
> `protected` **\_post**: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\> = `{}`
|
|
132550
132664
|
|
|
132551
|
-
Defined in: [sys/ctr.ts:
|
|
132665
|
+
Defined in: [sys/ctr.ts:141](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L141)
|
|
132552
132666
|
|
|
132553
132667
|
POST 数据
|
|
132554
132668
|
|
|
@@ -132558,7 +132672,7 @@ POST 数据
|
|
|
132558
132672
|
|
|
132559
132673
|
> `protected` **\_rawPost**: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\> = `{}`
|
|
132560
132674
|
|
|
132561
|
-
Defined in: [sys/ctr.ts:
|
|
132675
|
+
Defined in: [sys/ctr.ts:138](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L138)
|
|
132562
132676
|
|
|
132563
132677
|
原始 POST 数据
|
|
132564
132678
|
|
|
@@ -132568,7 +132682,7 @@ Defined in: [sys/ctr.ts:113](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132568
132682
|
|
|
132569
132683
|
> `protected` `readonly` **\_req**: `IncomingMessage` \| `Http2ServerRequest`
|
|
132570
132684
|
|
|
132571
|
-
Defined in: [sys/ctr.ts:
|
|
132685
|
+
Defined in: [sys/ctr.ts:173](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L173)
|
|
132572
132686
|
|
|
132573
132687
|
***
|
|
132574
132688
|
|
|
@@ -132576,7 +132690,7 @@ Defined in: [sys/ctr.ts:148](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132576
132690
|
|
|
132577
132691
|
> `protected` `readonly` **\_res**: `Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
132578
132692
|
|
|
132579
|
-
Defined in: [sys/ctr.ts:
|
|
132693
|
+
Defined in: [sys/ctr.ts:175](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L175)
|
|
132580
132694
|
|
|
132581
132695
|
***
|
|
132582
132696
|
|
|
@@ -132584,7 +132698,7 @@ Defined in: [sys/ctr.ts:150](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132584
132698
|
|
|
132585
132699
|
> `protected` **\_sess**: [`Session`](../../../lib/session/classes/Session.md) \| `null` = `null`
|
|
132586
132700
|
|
|
132587
|
-
Defined in: [sys/ctr.ts:
|
|
132701
|
+
Defined in: [sys/ctr.ts:156](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L156)
|
|
132588
132702
|
|
|
132589
132703
|
Session --- 对象
|
|
132590
132704
|
|
|
@@ -132594,7 +132708,7 @@ Session --- 对象
|
|
|
132594
132708
|
|
|
132595
132709
|
> `protected` **\_session**: `Record`\<`string`, `any`\> = `{}`
|
|
132596
132710
|
|
|
132597
|
-
Defined in: [sys/ctr.ts:
|
|
132711
|
+
Defined in: [sys/ctr.ts:153](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L153)
|
|
132598
132712
|
|
|
132599
132713
|
Session 数组
|
|
132600
132714
|
|
|
@@ -132604,7 +132718,7 @@ Session 数组
|
|
|
132604
132718
|
|
|
132605
132719
|
> `protected` `readonly` **\_socket**: [`Socket`](../../../lib/ws/classes/Socket.md)
|
|
132606
132720
|
|
|
132607
|
-
Defined in: [sys/ctr.ts:
|
|
132721
|
+
Defined in: [sys/ctr.ts:177](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L177)
|
|
132608
132722
|
|
|
132609
132723
|
***
|
|
132610
132724
|
|
|
@@ -132612,7 +132726,7 @@ Defined in: [sys/ctr.ts:152](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132612
132726
|
|
|
132613
132727
|
> `protected` `optional` **\_timer?**: `object`
|
|
132614
132728
|
|
|
132615
|
-
Defined in: [sys/ctr.ts:
|
|
132729
|
+
Defined in: [sys/ctr.ts:210](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L210)
|
|
132616
132730
|
|
|
132617
132731
|
timeout 的 timer
|
|
132618
132732
|
|
|
@@ -132638,7 +132752,7 @@ timeout 的 timer
|
|
|
132638
132752
|
|
|
132639
132753
|
> `protected` **\_xsrf**: `string` = `''`
|
|
132640
132754
|
|
|
132641
|
-
Defined in: [sys/ctr.ts:
|
|
132755
|
+
Defined in: [sys/ctr.ts:162](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L162)
|
|
132642
132756
|
|
|
132643
132757
|
XSRF TOKEN 值
|
|
132644
132758
|
|
|
@@ -132650,7 +132764,7 @@ XSRF TOKEN 值
|
|
|
132650
132764
|
|
|
132651
132765
|
> **get** `protected` **\_isAvail**(): `boolean`
|
|
132652
132766
|
|
|
132653
|
-
Defined in: [sys/ctr.ts:
|
|
132767
|
+
Defined in: [sys/ctr.ts:199](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L199)
|
|
132654
132768
|
|
|
132655
132769
|
当前用户连接是否还在连接中
|
|
132656
132770
|
|
|
@@ -132666,7 +132780,7 @@ Defined in: [sys/ctr.ts:174](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132666
132780
|
|
|
132667
132781
|
> **get** **timeout**(): `number`
|
|
132668
132782
|
|
|
132669
|
-
Defined in: [sys/ctr.ts:
|
|
132783
|
+
Defined in: [sys/ctr.ts:217](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L217)
|
|
132670
132784
|
|
|
132671
132785
|
获取当前过期时间(毫秒)
|
|
132672
132786
|
|
|
@@ -132678,7 +132792,7 @@ Defined in: [sys/ctr.ts:186](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132678
132792
|
|
|
132679
132793
|
> **set** **timeout**(`num`): `void`
|
|
132680
132794
|
|
|
132681
|
-
Defined in: [sys/ctr.ts:
|
|
132795
|
+
Defined in: [sys/ctr.ts:224](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L224)
|
|
132682
132796
|
|
|
132683
132797
|
设置当前过期时间(毫秒)
|
|
132684
132798
|
|
|
@@ -132698,7 +132812,7 @@ Defined in: [sys/ctr.ts:193](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132698
132812
|
|
|
132699
132813
|
> `protected` **\_asyncTask**(`func`): `void`
|
|
132700
132814
|
|
|
132701
|
-
Defined in: [sys/ctr.ts:
|
|
132815
|
+
Defined in: [sys/ctr.ts:258](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L258)
|
|
132702
132816
|
|
|
132703
132817
|
执行一段跳出堆栈的异步代码,代码执行完成前,热更新不会杀死当面进程 且 ftmp 临时文件不会被清除
|
|
132704
132818
|
|
|
@@ -132720,7 +132834,7 @@ Defined in: [sys/ctr.ts:227](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132720
132834
|
|
|
132721
132835
|
> `protected` **\_checkInput**(`input`, `rule`, `rtn`): `boolean`
|
|
132722
132836
|
|
|
132723
|
-
Defined in: [sys/ctr.ts:
|
|
132837
|
+
Defined in: [sys/ctr.ts:799](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L799)
|
|
132724
132838
|
|
|
132725
132839
|
检测提交的数据类型
|
|
132726
132840
|
|
|
@@ -132754,7 +132868,7 @@ Defined in: [sys/ctr.ts:768](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132754
132868
|
|
|
132755
132869
|
> `protected` **\_checkXInput**(`input`, `rule`, `rtn`, `ignore?`): `boolean`
|
|
132756
132870
|
|
|
132757
|
-
Defined in: [sys/ctr.ts:
|
|
132871
|
+
Defined in: [sys/ctr.ts:978](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L978)
|
|
132758
132872
|
|
|
132759
132873
|
检测提交的数据类型(会检测 XSRF)
|
|
132760
132874
|
|
|
@@ -132794,7 +132908,7 @@ Defined in: [sys/ctr.ts:947](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132794
132908
|
|
|
132795
132909
|
> `protected` **\_cross**(`opt?`): `boolean`
|
|
132796
132910
|
|
|
132797
|
-
Defined in: [sys/ctr.ts:
|
|
132911
|
+
Defined in: [sys/ctr.ts:1213](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1213)
|
|
132798
132912
|
|
|
132799
132913
|
开启跨域请求
|
|
132800
132914
|
|
|
@@ -132839,7 +132953,7 @@ Defined in: [sys/ctr.ts:1182](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
132839
132953
|
|
|
132840
132954
|
> `protected` **\_device**(): `"unknown"` \| `"android"` \| `"linux"` \| `"windows"` \| `"macintosh"` \| `"ipad"`
|
|
132841
132955
|
|
|
132842
|
-
Defined in: [sys/ctr.ts:
|
|
132956
|
+
Defined in: [sys/ctr.ts:1023](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1023)
|
|
132843
132957
|
|
|
132844
132958
|
根据用户 ua 获取当前用户的设备类型
|
|
132845
132959
|
|
|
@@ -132853,7 +132967,7 @@ Defined in: [sys/ctr.ts:992](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132853
132967
|
|
|
132854
132968
|
> `protected` **\_enabledXsrf**(`opt?`): `void`
|
|
132855
132969
|
|
|
132856
|
-
Defined in: [sys/ctr.ts:
|
|
132970
|
+
Defined in: [sys/ctr.ts:992](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L992)
|
|
132857
132971
|
|
|
132858
132972
|
当前页面开启 XSRF 支持(主要检测 cookie 是否存在)
|
|
132859
132973
|
如果当前页面有 CDN,请不要使用
|
|
@@ -132876,7 +132990,7 @@ Defined in: [sys/ctr.ts:961](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132876
132990
|
|
|
132877
132991
|
> `protected` **\_end**(`code?`, `reason?`): `void`
|
|
132878
132992
|
|
|
132879
|
-
Defined in: [sys/ctr.ts:
|
|
132993
|
+
Defined in: [sys/ctr.ts:1323](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1323)
|
|
132880
132994
|
|
|
132881
132995
|
主动关闭当前 socket 连接
|
|
132882
132996
|
|
|
@@ -132904,7 +133018,7 @@ WebSocket 关闭码
|
|
|
132904
133018
|
|
|
132905
133019
|
> `protected` **\_getBasicAuth**(`user`, `pwd`): `string`
|
|
132906
133020
|
|
|
132907
|
-
Defined in: [sys/ctr.ts:
|
|
133021
|
+
Defined in: [sys/ctr.ts:1016](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1016)
|
|
132908
133022
|
|
|
132909
133023
|
获取 Auth 字符串,用于客户端提交
|
|
132910
133024
|
|
|
@@ -132932,7 +133046,7 @@ Defined in: [sys/ctr.ts:985](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132932
133046
|
|
|
132933
133047
|
> `protected` **\_getLocale**(): `string`
|
|
132934
133048
|
|
|
132935
|
-
Defined in: [sys/ctr.ts:
|
|
133049
|
+
Defined in: [sys/ctr.ts:1204](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1204)
|
|
132936
133050
|
|
|
132937
133051
|
获取当前语言名
|
|
132938
133052
|
|
|
@@ -132946,7 +133060,7 @@ Defined in: [sys/ctr.ts:1173](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
132946
133060
|
|
|
132947
133061
|
> `protected` **\_getLocaleJsonString**(): `string`
|
|
132948
133062
|
|
|
132949
|
-
Defined in: [sys/ctr.ts:
|
|
133063
|
+
Defined in: [sys/ctr.ts:1192](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1192)
|
|
132950
133064
|
|
|
132951
133065
|
根据当前后台语言包设置情况获取 JSON 字符串传输到前台
|
|
132952
133066
|
|
|
@@ -132962,7 +133076,7 @@ string
|
|
|
132962
133076
|
|
|
132963
133077
|
> `protected` **\_getMemoryUsage**(): `number`
|
|
132964
133078
|
|
|
132965
|
-
Defined in: [sys/ctr.ts:
|
|
133079
|
+
Defined in: [sys/ctr.ts:408](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L408)
|
|
132966
133080
|
|
|
132967
133081
|
获取截止当前内存的使用情况
|
|
132968
133082
|
|
|
@@ -132976,7 +133090,7 @@ Defined in: [sys/ctr.ts:377](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132976
133090
|
|
|
132977
133091
|
> `protected` **\_getRunTime**(`ms?`): `number`
|
|
132978
133092
|
|
|
132979
|
-
Defined in: [sys/ctr.ts:
|
|
133093
|
+
Defined in: [sys/ctr.ts:400](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L400)
|
|
132980
133094
|
|
|
132981
133095
|
获取截止当前时间的总运行时间
|
|
132982
133096
|
|
|
@@ -132998,7 +133112,7 @@ Defined in: [sys/ctr.ts:369](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
132998
133112
|
|
|
132999
133113
|
> `protected` **\_handleFormData**(`events?`, `limits?`): `Promise`\<`boolean`\>
|
|
133000
133114
|
|
|
133001
|
-
Defined in: [sys/ctr.ts:
|
|
133115
|
+
Defined in: [sys/ctr.ts:1332](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1332)
|
|
133002
133116
|
|
|
133003
133117
|
获取 formdata 的信息
|
|
133004
133118
|
|
|
@@ -133076,7 +133190,7 @@ multipart 字段与文件总数量,默认 1000
|
|
|
133076
133190
|
|
|
133077
133191
|
> **\_l**(`key`, `data?`): `string`
|
|
133078
133192
|
|
|
133079
|
-
Defined in: [sys/ctr.ts:
|
|
133193
|
+
Defined in: [sys/ctr.ts:1256](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1256)
|
|
133080
133194
|
|
|
133081
133195
|
获取语言包值
|
|
133082
133196
|
|
|
@@ -133102,7 +133216,7 @@ Defined in: [sys/ctr.ts:1225](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133102
133216
|
|
|
133103
133217
|
> `protected` **\_loadData**\<`T`\>(`path`): `Promise`\<`false` \| `T` \| `null`\>
|
|
133104
133218
|
|
|
133105
|
-
Defined in: [sys/ctr.ts:
|
|
133219
|
+
Defined in: [sys/ctr.ts:1092](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1092)
|
|
133106
133220
|
|
|
133107
133221
|
获取 data JSON 数据
|
|
133108
133222
|
|
|
@@ -133130,7 +133244,7 @@ Defined in: [sys/ctr.ts:1061](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133130
133244
|
|
|
133131
133245
|
> `protected` **\_loadLocale**(`loc`, `pkg?`): `Promise`\<`boolean`\>
|
|
133132
133246
|
|
|
133133
|
-
Defined in: [sys/ctr.ts:
|
|
133247
|
+
Defined in: [sys/ctr.ts:1143](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1143)
|
|
133134
133248
|
|
|
133135
133249
|
设定语言并加载语言包
|
|
133136
133250
|
|
|
@@ -133158,7 +133272,7 @@ Defined in: [sys/ctr.ts:1112](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133158
133272
|
|
|
133159
133273
|
> `protected` **\_loadReactPage**(`path`, `props?`, `opt?`): `Promise`\<`string`\>
|
|
133160
133274
|
|
|
133161
|
-
Defined in: [sys/ctr.ts:
|
|
133275
|
+
Defined in: [sys/ctr.ts:444](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L444)
|
|
133162
133276
|
|
|
133163
133277
|
加载 React 全页面进行 SSR 渲染,组件需渲染完整 HTML 文档(含 html/head/body),无需 EJS
|
|
133164
133278
|
框架自动注入 props:_urlBase/_urlFull/_urlStc/_staticVer/_staticPath/_staticPathFull
|
|
@@ -133227,7 +133341,7 @@ BrowserRouter 的 basename,相对于 urlBase,默认空字符串
|
|
|
133227
133341
|
|
|
133228
133342
|
> `protected` **\_loadView**(`path`, `data?`): `Promise`\<`string`\>
|
|
133229
133343
|
|
|
133230
|
-
Defined in: [sys/ctr.ts:
|
|
133344
|
+
Defined in: [sys/ctr.ts:417](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L417)
|
|
133231
133345
|
|
|
133232
133346
|
加载视图
|
|
133233
133347
|
|
|
@@ -133251,7 +133365,7 @@ Defined in: [sys/ctr.ts:386](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133251
133365
|
|
|
133252
133366
|
> `protected` **\_location**(`location`): `false`
|
|
133253
133367
|
|
|
133254
|
-
Defined in: [sys/ctr.ts:
|
|
133368
|
+
Defined in: [sys/ctr.ts:1113](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1113)
|
|
133255
133369
|
|
|
133256
133370
|
跳转(302临时跳转),支持相对本项目根路径的路径或绝对路径
|
|
133257
133371
|
|
|
@@ -133273,7 +133387,7 @@ Defined in: [sys/ctr.ts:1082](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133273
133387
|
|
|
133274
133388
|
> `protected` **\_ping**(`data?`): `boolean`
|
|
133275
133389
|
|
|
133276
|
-
Defined in: [sys/ctr.ts:
|
|
133390
|
+
Defined in: [sys/ctr.ts:1306](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1306)
|
|
133277
133391
|
|
|
133278
133392
|
发送 socket ping
|
|
133279
133393
|
|
|
@@ -133295,7 +133409,7 @@ Defined in: [sys/ctr.ts:1275](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133295
133409
|
|
|
133296
133410
|
> `protected` **\_pong**(`data?`): `boolean`
|
|
133297
133411
|
|
|
133298
|
-
Defined in: [sys/ctr.ts:
|
|
133412
|
+
Defined in: [sys/ctr.ts:1314](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1314)
|
|
133299
133413
|
|
|
133300
133414
|
发送 socket pong
|
|
133301
133415
|
|
|
@@ -133317,7 +133431,7 @@ Defined in: [sys/ctr.ts:1283](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133317
133431
|
|
|
133318
133432
|
> `protected` **\_startSession**(`link`, `auth?`, `opt?`): `Promise`\<`boolean`\>
|
|
133319
133433
|
|
|
133320
|
-
Defined in: [sys/ctr.ts:
|
|
133434
|
+
Defined in: [sys/ctr.ts:1127](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1127)
|
|
133321
133435
|
|
|
133322
133436
|
开启 Session
|
|
133323
133437
|
|
|
@@ -133351,7 +133465,7 @@ Kv 或 Db 实例
|
|
|
133351
133465
|
|
|
133352
133466
|
> `protected` **\_valibot**\<`TSchema`\>(`schema`, `input`, `options?`): [`TValibotResult`](../type-aliases/TValibotResult.md)\<`TSchema`\>
|
|
133353
133467
|
|
|
133354
|
-
Defined in: [sys/ctr.ts:
|
|
133468
|
+
Defined in: [sys/ctr.ts:718](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L718)
|
|
133355
133469
|
|
|
133356
133470
|
使用 Valibot schema 校验并解析输入,成功后 output 会自动推导类型
|
|
133357
133471
|
|
|
@@ -133393,7 +133507,7 @@ Valibot 配置和自定义客户端返回值
|
|
|
133393
133507
|
|
|
133394
133508
|
> `protected` **\_valibotx**\<`TSchema`\>(`schema`, `input`, `options?`): [`TValibotResult`](../type-aliases/TValibotResult.md)\<`TSchema`, [`IValibotXsrfIssue`](../interfaces/IValibotXsrfIssue.md) \| [`InferIssue`](../../../lib/core/namespaces/v/type-aliases/InferIssue.md)\<`TSchema`\>\>
|
|
133395
133509
|
|
|
133396
|
-
Defined in: [sys/ctr.ts:
|
|
133510
|
+
Defined in: [sys/ctr.ts:742](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L742)
|
|
133397
133511
|
|
|
133398
133512
|
使用 Valibot schema 校验并解析输入,同时检测 XSRF
|
|
133399
133513
|
|
|
@@ -133435,7 +133549,7 @@ Valibot 配置、自定义客户端返回值和 XSRF 选项
|
|
|
133435
133549
|
|
|
133436
133550
|
> `protected` **\_writeBinary**(`data`): `boolean`
|
|
133437
133551
|
|
|
133438
|
-
Defined in: [sys/ctr.ts:
|
|
133552
|
+
Defined in: [sys/ctr.ts:1298](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1298)
|
|
133439
133553
|
|
|
133440
133554
|
发送 socket 二进制
|
|
133441
133555
|
|
|
@@ -133457,7 +133571,7 @@ Defined in: [sys/ctr.ts:1267](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133457
133571
|
|
|
133458
133572
|
> `protected` **\_writeResult**(`data`): `boolean`
|
|
133459
133573
|
|
|
133460
|
-
Defined in: [sys/ctr.ts:
|
|
133574
|
+
Defined in: [sys/ctr.ts:1290](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1290)
|
|
133461
133575
|
|
|
133462
133576
|
发送结果对象文本
|
|
133463
133577
|
|
|
@@ -133479,7 +133593,7 @@ Defined in: [sys/ctr.ts:1259](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133479
133593
|
|
|
133480
133594
|
> `protected` **\_writeText**(`data`): `boolean`
|
|
133481
133595
|
|
|
133482
|
-
Defined in: [sys/ctr.ts:
|
|
133596
|
+
Defined in: [sys/ctr.ts:1282](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1282)
|
|
133483
133597
|
|
|
133484
133598
|
发送 socket 文本
|
|
133485
133599
|
|
|
@@ -133501,7 +133615,7 @@ Defined in: [sys/ctr.ts:1251](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133501
133615
|
|
|
133502
133616
|
> **getAuthorization**(): `false` \| \{ `pwd`: `string`; `type`: `"basic"`; `user`: `string`; \} \| \{ `token`: `string`; `type`: `"bearer"`; \}
|
|
133503
133617
|
|
|
133504
|
-
Defined in: [sys/ctr.ts:
|
|
133618
|
+
Defined in: [sys/ctr.ts:1044](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1044)
|
|
133505
133619
|
|
|
133506
133620
|
通过 header 或 _auth 获取鉴权信息,支持 Basic Auth 和 Bearer Token
|
|
133507
133621
|
|
|
@@ -133517,7 +133631,7 @@ Defined in: [sys/ctr.ts:1013](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
133517
133631
|
|
|
133518
133632
|
> **getPrototype**(`name`): [`IConfig`](../../../index/interfaces/IConfig.md)
|
|
133519
133633
|
|
|
133520
|
-
Defined in: [sys/ctr.ts:
|
|
133634
|
+
Defined in: [sys/ctr.ts:282](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L282)
|
|
133521
133635
|
|
|
133522
133636
|
获取类内部的 prototype
|
|
133523
133637
|
|
|
@@ -133535,7 +133649,7 @@ Defined in: [sys/ctr.ts:251](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133535
133649
|
|
|
133536
133650
|
> **getPrototype**(`name`): [`Session`](../../../lib/session/classes/Session.md) \| `null`
|
|
133537
133651
|
|
|
133538
|
-
Defined in: [sys/ctr.ts:
|
|
133652
|
+
Defined in: [sys/ctr.ts:283](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L283)
|
|
133539
133653
|
|
|
133540
133654
|
获取类内部的 prototype
|
|
133541
133655
|
|
|
@@ -133553,7 +133667,7 @@ Defined in: [sys/ctr.ts:252](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133553
133667
|
|
|
133554
133668
|
> **getPrototype**(`name`): `IncomingHttpHeaders`
|
|
133555
133669
|
|
|
133556
|
-
Defined in: [sys/ctr.ts:
|
|
133670
|
+
Defined in: [sys/ctr.ts:284](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L284)
|
|
133557
133671
|
|
|
133558
133672
|
获取类内部的 prototype
|
|
133559
133673
|
|
|
@@ -133571,7 +133685,7 @@ Defined in: [sys/ctr.ts:253](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133571
133685
|
|
|
133572
133686
|
> **getPrototype**(`name`): `IncomingMessage` \| `Http2ServerRequest`
|
|
133573
133687
|
|
|
133574
|
-
Defined in: [sys/ctr.ts:
|
|
133688
|
+
Defined in: [sys/ctr.ts:285](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L285)
|
|
133575
133689
|
|
|
133576
133690
|
获取类内部的 prototype
|
|
133577
133691
|
|
|
@@ -133589,7 +133703,7 @@ Defined in: [sys/ctr.ts:254](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133589
133703
|
|
|
133590
133704
|
> **getPrototype**(`name`): `Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
133591
133705
|
|
|
133592
|
-
Defined in: [sys/ctr.ts:
|
|
133706
|
+
Defined in: [sys/ctr.ts:286](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L286)
|
|
133593
133707
|
|
|
133594
133708
|
获取类内部的 prototype
|
|
133595
133709
|
|
|
@@ -133607,7 +133721,7 @@ Defined in: [sys/ctr.ts:255](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133607
133721
|
|
|
133608
133722
|
> **getPrototype**(`name`): [`Socket`](../../../lib/ws/classes/Socket.md)
|
|
133609
133723
|
|
|
133610
|
-
Defined in: [sys/ctr.ts:
|
|
133724
|
+
Defined in: [sys/ctr.ts:287](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L287)
|
|
133611
133725
|
|
|
133612
133726
|
获取类内部的 prototype
|
|
133613
133727
|
|
|
@@ -133625,7 +133739,7 @@ Defined in: [sys/ctr.ts:256](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133625
133739
|
|
|
133626
133740
|
> **getPrototype**(`name`): `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>
|
|
133627
133741
|
|
|
133628
|
-
Defined in: [sys/ctr.ts:
|
|
133742
|
+
Defined in: [sys/ctr.ts:288](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L288)
|
|
133629
133743
|
|
|
133630
133744
|
获取类内部的 prototype
|
|
133631
133745
|
|
|
@@ -133643,7 +133757,7 @@ Defined in: [sys/ctr.ts:257](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133643
133757
|
|
|
133644
133758
|
> **getPrototype**(`name`): `string`
|
|
133645
133759
|
|
|
133646
|
-
Defined in: [sys/ctr.ts:
|
|
133760
|
+
Defined in: [sys/ctr.ts:289](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L289)
|
|
133647
133761
|
|
|
133648
133762
|
获取类内部的 prototype
|
|
133649
133763
|
|
|
@@ -133661,7 +133775,7 @@ Defined in: [sys/ctr.ts:258](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133661
133775
|
|
|
133662
133776
|
> **getPrototype**(`name`): `any`
|
|
133663
133777
|
|
|
133664
|
-
Defined in: [sys/ctr.ts:
|
|
133778
|
+
Defined in: [sys/ctr.ts:290](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L290)
|
|
133665
133779
|
|
|
133666
133780
|
获取类内部的 prototype
|
|
133667
133781
|
|
|
@@ -133681,7 +133795,7 @@ Defined in: [sys/ctr.ts:259](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133681
133795
|
|
|
133682
133796
|
> **onClose**(): `void` \| `Promise`\<`void`\>
|
|
133683
133797
|
|
|
133684
|
-
Defined in: [sys/ctr.ts:
|
|
133798
|
+
Defined in: [sys/ctr.ts:384](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L384)
|
|
133685
133799
|
|
|
133686
133800
|
WebSocket 下连接被终止后会自动被调用的事件,可重写此方法
|
|
133687
133801
|
|
|
@@ -133695,7 +133809,7 @@ WebSocket 下连接被终止后会自动被调用的事件,可重写此方法
|
|
|
133695
133809
|
|
|
133696
133810
|
> **onData**(`data`, `opcode`): `any`
|
|
133697
133811
|
|
|
133698
|
-
Defined in: [sys/ctr.ts:
|
|
133812
|
+
Defined in: [sys/ctr.ts:349](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L349)
|
|
133699
133813
|
|
|
133700
133814
|
WebSocket 下当收到数据时会自动被调用的事件,即只文本和二进制数据,返回内容会被发送给 socket
|
|
133701
133815
|
|
|
@@ -133725,7 +133839,7 @@ WebSocket 下当收到数据时会自动被调用的事件,即只文本和二
|
|
|
133725
133839
|
|
|
133726
133840
|
> **onDrain**(): `void` \| `Promise`\<`void`\>
|
|
133727
133841
|
|
|
133728
|
-
Defined in: [sys/ctr.ts:
|
|
133842
|
+
Defined in: [sys/ctr.ts:370](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L370)
|
|
133729
133843
|
|
|
133730
133844
|
WebSocket 下连接恢复可写入状态后会调用此事件,可重写此方法
|
|
133731
133845
|
|
|
@@ -133739,7 +133853,7 @@ WebSocket 下连接恢复可写入状态后会调用此事件,可重写此方
|
|
|
133739
133853
|
|
|
133740
133854
|
> **onEnd**(): `void` \| `Promise`\<`void`\>
|
|
133741
133855
|
|
|
133742
|
-
Defined in: [sys/ctr.ts:
|
|
133856
|
+
Defined in: [sys/ctr.ts:377](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L377)
|
|
133743
133857
|
|
|
133744
133858
|
WebSocket 下连接被 end 后会自动被调用的事件,可重写此方法
|
|
133745
133859
|
|
|
@@ -133753,7 +133867,7 @@ WebSocket 下连接被 end 后会自动被调用的事件,可重写此方法
|
|
|
133753
133867
|
|
|
133754
133868
|
> **onLoad**(): `string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[] \| `Promise`\<`string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[]\>
|
|
133755
133869
|
|
|
133756
|
-
Defined in: [sys/ctr.ts:
|
|
133870
|
+
Defined in: [sys/ctr.ts:308](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L308)
|
|
133757
133871
|
|
|
133758
133872
|
实例化后会执行的方法,可重写此方法
|
|
133759
133873
|
|
|
@@ -133769,7 +133883,7 @@ Defined in: [sys/ctr.ts:277](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133769
133883
|
|
|
133770
133884
|
> **onMessage**(`data`, `opcode`): `boolean` \| `Promise`\<`boolean` \| `undefined`\> \| `undefined`
|
|
133771
133885
|
|
|
133772
|
-
Defined in: [sys/ctr.ts:
|
|
133886
|
+
Defined in: [sys/ctr.ts:361](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L361)
|
|
133773
133887
|
|
|
133774
133888
|
包含所有 opcode 的消息,若要发送数据需自行调用 write 方法,data 恒定为原始 buffer
|
|
133775
133889
|
返回 false 则不会执行默认方法,一般请什么都不要返回
|
|
@@ -133799,7 +133913,7 @@ opcode
|
|
|
133799
133913
|
|
|
133800
133914
|
> **onReady**(): `string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[] \| `Promise`\<`string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[]\>
|
|
133801
133915
|
|
|
133802
|
-
Defined in: [sys/ctr.ts:
|
|
133916
|
+
Defined in: [sys/ctr.ts:317](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L317)
|
|
133803
133917
|
|
|
133804
133918
|
onLoad 执行后会执行的方法,可重写此方法
|
|
133805
133919
|
|
|
@@ -133815,7 +133929,7 @@ onLoad 执行后会执行的方法,可重写此方法
|
|
|
133815
133929
|
|
|
133816
133930
|
> **onReqStart**(): `number` \| `Promise`\<`number`\>
|
|
133817
133931
|
|
|
133818
|
-
Defined in: [sys/ctr.ts:
|
|
133932
|
+
Defined in: [sys/ctr.ts:392](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L392)
|
|
133819
133933
|
|
|
133820
133934
|
请求发送开始时调用(仅会在 middle 内触发)
|
|
133821
133935
|
|
|
@@ -133831,7 +133945,7 @@ Defined in: [sys/ctr.ts:361](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133831
133945
|
|
|
133832
133946
|
> **onUnload**(`rtn`): `string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[] \| `Promise`\<`string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[]\>
|
|
133833
133947
|
|
|
133834
|
-
Defined in: [sys/ctr.ts:
|
|
133948
|
+
Defined in: [sys/ctr.ts:327](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L327)
|
|
133835
133949
|
|
|
133836
133950
|
整个结束前会执行本方法,可重写此方法对输出结果再处理一次(Websocket 模式无效)
|
|
133837
133951
|
|
|
@@ -133855,7 +133969,7 @@ Defined in: [sys/ctr.ts:296](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
133855
133969
|
|
|
133856
133970
|
> **onUpgrade**(): `object`
|
|
133857
133971
|
|
|
133858
|
-
Defined in: [sys/ctr.ts:
|
|
133972
|
+
Defined in: [sys/ctr.ts:336](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L336)
|
|
133859
133973
|
|
|
133860
133974
|
WebSocket 下在建立 Server 连接之前可对 WebSocket 的信息进行配置
|
|
133861
133975
|
|
|
@@ -133879,7 +133993,7 @@ WebSocket 配置参数,包含自定义 header 和超时时间
|
|
|
133879
133993
|
|
|
133880
133994
|
> **setPrototype**(`name`, `val`): `void`
|
|
133881
133995
|
|
|
133882
|
-
Defined in: [sys/ctr.ts:
|
|
133996
|
+
Defined in: [sys/ctr.ts:296](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L296)
|
|
133883
133997
|
|
|
133884
133998
|
设置类内部的 prototype
|
|
133885
133999
|
|
|
@@ -133918,6 +134032,43 @@ Defined in: [sys/ctr.ts:39](https://github.com/maiyunnet/kebab/blob/master/sys/c
|
|
|
133918
134032
|
|
|
133919
134033
|
`void`
|
|
133920
134034
|
|
|
134035
|
+
sys/ctr/functions/isHttpRequestAvailable.md
|
|
134036
|
+
---
|
|
134037
|
+
|
|
134038
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
134039
|
+
|
|
134040
|
+
***
|
|
134041
|
+
|
|
134042
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [sys/ctr](../index.md) / isHttpRequestAvailable
|
|
134043
|
+
|
|
134044
|
+
# Function: isHttpRequestAvailable()
|
|
134045
|
+
|
|
134046
|
+
> **isHttpRequestAvailable**(`req`, `res`): `boolean`
|
|
134047
|
+
|
|
134048
|
+
Defined in: [sys/ctr.ts:104](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L104)
|
|
134049
|
+
|
|
134050
|
+
判断当前 HTTP 请求是否仍可响应
|
|
134051
|
+
|
|
134052
|
+
## Parameters
|
|
134053
|
+
|
|
134054
|
+
### req
|
|
134055
|
+
|
|
134056
|
+
`IncomingMessage` \| `Http2ServerRequest`
|
|
134057
|
+
|
|
134058
|
+
请求对象
|
|
134059
|
+
|
|
134060
|
+
### res
|
|
134061
|
+
|
|
134062
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
134063
|
+
|
|
134064
|
+
响应对象
|
|
134065
|
+
|
|
134066
|
+
## Returns
|
|
134067
|
+
|
|
134068
|
+
`boolean`
|
|
134069
|
+
|
|
134070
|
+
客户端对应的请求流仍可响应时返回 true
|
|
134071
|
+
|
|
133921
134072
|
sys/ctr/index.md
|
|
133922
134073
|
---
|
|
133923
134074
|
|
|
@@ -133948,6 +134099,7 @@ sys/ctr/index.md
|
|
|
133948
134099
|
## Functions
|
|
133949
134100
|
|
|
133950
134101
|
- [clearLocaleData](functions/clearLocaleData.md)
|
|
134102
|
+
- [isHttpRequestAvailable](functions/isHttpRequestAvailable.md)
|
|
133951
134103
|
|
|
133952
134104
|
sys/ctr/interfaces/IValibotOptions.md
|
|
133953
134105
|
---
|
|
@@ -137044,7 +137196,7 @@ sys/route/functions/getFormData.md
|
|
|
137044
137196
|
|
|
137045
137197
|
> **getFormData**(`req`, `events?`, `limits?`): `Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|
|
137046
137198
|
|
|
137047
|
-
Defined in: [sys/route.ts:
|
|
137199
|
+
Defined in: [sys/route.ts:1037](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L1037)
|
|
137048
137200
|
|
|
137049
137201
|
获取 formdata 的 post
|
|
137050
137202
|
|
|
@@ -137139,9 +137291,9 @@ sys/route/functions/getPost.md
|
|
|
137139
137291
|
|
|
137140
137292
|
# Function: getPost()
|
|
137141
137293
|
|
|
137142
|
-
> **getPost**(`req`): `Promise
|
|
137294
|
+
> **getPost**(`req`): `Promise`\<`false` \| \{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
|
|
137143
137295
|
|
|
137144
|
-
Defined in: [sys/route.ts:
|
|
137296
|
+
Defined in: [sys/route.ts:912](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L912)
|
|
137145
137297
|
|
|
137146
137298
|
获取 post 对象(通常已自动获取),如果是文件上传(formdata)的情况则不获取
|
|
137147
137299
|
|
|
@@ -137155,7 +137307,9 @@ Defined in: [sys/route.ts:907](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
137155
137307
|
|
|
137156
137308
|
## Returns
|
|
137157
137309
|
|
|
137158
|
-
`Promise
|
|
137310
|
+
`Promise`\<`false` \| \{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
|
|
137311
|
+
|
|
137312
|
+
解析后的 POST 数据,请求传输中断时返回 false
|
|
137159
137313
|
|
|
137160
137314
|
sys/route/functions/run.md
|
|
137161
137315
|
---
|
|
@@ -137257,7 +137411,7 @@ sys/route/functions/unlinkUploadFiles.md
|
|
|
137257
137411
|
|
|
137258
137412
|
> **unlinkUploadFiles**(`cctr`): `Promise`\<`void`\>
|
|
137259
137413
|
|
|
137260
|
-
Defined in: [sys/route.ts:
|
|
137414
|
+
Defined in: [sys/route.ts:870](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L870)
|
|
137261
137415
|
|
|
137262
137416
|
删除本次请求所有已上传的临时文件
|
|
137263
137417
|
|
|
@@ -137286,7 +137440,7 @@ sys/route/functions/waitCtr.md
|
|
|
137286
137440
|
|
|
137287
137441
|
> **waitCtr**(`cctr`): `Promise`\<`void`\>
|
|
137288
137442
|
|
|
137289
|
-
Defined in: [sys/route.ts:
|
|
137443
|
+
Defined in: [sys/route.ts:890](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L890)
|
|
137290
137444
|
|
|
137291
137445
|
等待异步任务结束,并删除临时文件,如果结束后还有事务没关闭,则会在本函数中打印控制台并且写入 log 文件
|
|
137292
137446
|
此时其实已经给客户端返回了,此处等待不消耗客户端的等待时间
|