@maiyunnet/kebab 9.14.3 → 9.15.1
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 +364 -560
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/core.js +19 -6
- package/lib/crypto.js +1 -1
- package/lib/fs.js +6 -4
- package/lib/kv.d.ts +5 -0
- package/lib/kv.js +21 -1
- package/lib/net/formdata.d.ts +2 -81
- package/lib/net/formdata.js +2 -164
- package/lib/net.js +16 -2
- package/lib/ratelimit.js +6 -6
- package/lib/scan.js +18 -5
- package/lib/session.js +2 -0
- package/lib/text.d.ts +6 -0
- package/lib/text.js +39 -6
- package/lib/undici/response.js +0 -2
- package/lib/undici.js +17 -2
- package/package.json +1 -1
- package/sys/child.js +0 -8
- package/sys/ctr.d.ts +6 -0
- package/sys/master.js +158 -48
- package/sys/route.d.ts +6 -0
- package/sys/route.js +87 -25
- package/www/example/ctr/test.js +5 -3
- package/www/example/stc/view/hello.page.js +1 -1
- package/www/example/stc/view/hello.page.tsx +2 -2
- package/www/example/stc/view/react-router.page.js +4 -4
- package/www/example/stc/view/react-router.page.tsx +15 -16
- package/www/example/stc/view/react.page.js +7 -7
- package/www/example/stc/view/react.page.tsx +27 -22
package/doc/kebab-rag.md
CHANGED
|
@@ -1360,7 +1360,7 @@ index/variables/VER.md
|
|
|
1360
1360
|
|
|
1361
1361
|
# Variable: VER
|
|
1362
1362
|
|
|
1363
|
-
> `const` **VER**: `"9.
|
|
1363
|
+
> `const` **VER**: `"9.15.1"` = `'9.15.1'`
|
|
1364
1364
|
|
|
1365
1365
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1366
1366
|
|
|
@@ -3274,7 +3274,7 @@ lib/core/functions/checkSchema.md
|
|
|
3274
3274
|
|
|
3275
3275
|
> **checkSchema**(`val`, `schema`): `string`
|
|
3276
3276
|
|
|
3277
|
-
Defined in: [lib/core.ts:
|
|
3277
|
+
Defined in: [lib/core.ts:302](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L302)
|
|
3278
3278
|
|
|
3279
3279
|
判断一个对象是否符合 JSON Schema
|
|
3280
3280
|
|
|
@@ -3309,7 +3309,7 @@ lib/core/functions/checkType.md
|
|
|
3309
3309
|
|
|
3310
3310
|
> **checkType**(`val`, `type`, `tree?`): `string`
|
|
3311
3311
|
|
|
3312
|
-
Defined in: [lib/core.ts:
|
|
3312
|
+
Defined in: [lib/core.ts:214](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L214)
|
|
3313
3313
|
|
|
3314
3314
|
判断一个对象是否符合示例组,返回空字符串代表校验通过,返回:应该的类型:位置:传入的类型
|
|
3315
3315
|
|
|
@@ -3350,7 +3350,7 @@ lib/core/functions/clone.md
|
|
|
3350
3350
|
|
|
3351
3351
|
> **clone**\<`T`\>(`obj`): `T`
|
|
3352
3352
|
|
|
3353
|
-
Defined in: [lib/core.ts:
|
|
3353
|
+
Defined in: [lib/core.ts:1336](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1336)
|
|
3354
3354
|
|
|
3355
3355
|
完整的克隆一份数组/对象
|
|
3356
3356
|
|
|
@@ -3385,7 +3385,7 @@ lib/core/functions/convert62.md
|
|
|
3385
3385
|
|
|
3386
3386
|
> **convert62**(`n`): `string`
|
|
3387
3387
|
|
|
3388
|
-
Defined in: [lib/core.ts:
|
|
3388
|
+
Defined in: [lib/core.ts:155](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L155)
|
|
3389
3389
|
|
|
3390
3390
|
将 10 进制转换为 62 进制
|
|
3391
3391
|
|
|
@@ -3414,7 +3414,7 @@ lib/core/functions/debug.md
|
|
|
3414
3414
|
|
|
3415
3415
|
> **debug**(`message?`, ...`optionalParams`): `void`
|
|
3416
3416
|
|
|
3417
|
-
Defined in: [lib/core.ts:
|
|
3417
|
+
Defined in: [lib/core.ts:1382](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1382)
|
|
3418
3418
|
|
|
3419
3419
|
打印调试信息,线上环境不会打印
|
|
3420
3420
|
|
|
@@ -3449,7 +3449,7 @@ lib/core/functions/display.md
|
|
|
3449
3449
|
|
|
3450
3450
|
> **display**(`message?`, ...`optionalParams`): `void`
|
|
3451
3451
|
|
|
3452
|
-
Defined in: [lib/core.ts:
|
|
3452
|
+
Defined in: [lib/core.ts:1395](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1395)
|
|
3453
3453
|
|
|
3454
3454
|
向控制台直接显示内容,一般情况下禁止使用
|
|
3455
3455
|
|
|
@@ -3484,7 +3484,7 @@ lib/core/functions/emptyObject.md
|
|
|
3484
3484
|
|
|
3485
3485
|
> **emptyObject**(`obj`, `deep?`): `void`
|
|
3486
3486
|
|
|
3487
|
-
Defined in: [lib/core.ts:
|
|
3487
|
+
Defined in: [lib/core.ts:618](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L618)
|
|
3488
3488
|
|
|
3489
3489
|
将对象的所有属性清除包括键,不会破坏引用关系,对象变量依然保证是引用状态
|
|
3490
3490
|
|
|
@@ -3519,7 +3519,7 @@ lib/core/functions/exec.md
|
|
|
3519
3519
|
|
|
3520
3520
|
> **exec**(`command`, `options?`): `Promise`\<`string` \| `false`\>
|
|
3521
3521
|
|
|
3522
|
-
Defined in: [lib/core.ts:
|
|
3522
|
+
Defined in: [lib/core.ts:680](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L680)
|
|
3523
3523
|
|
|
3524
3524
|
执行命令行
|
|
3525
3525
|
|
|
@@ -3554,7 +3554,7 @@ lib/core/functions/getLog.md
|
|
|
3554
3554
|
|
|
3555
3555
|
> **getLog**(`opt`): `Promise`\<`false` \| \{ `list`: `any`[] \| `string`[][]; `total`: `number`; \}\>
|
|
3556
3556
|
|
|
3557
|
-
Defined in: [lib/core.ts:
|
|
3557
|
+
Defined in: [lib/core.ts:1248](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1248)
|
|
3558
3558
|
|
|
3559
3559
|
获取日志内容为一个数组
|
|
3560
3560
|
|
|
@@ -3623,7 +3623,7 @@ lib/core/functions/ipLimit.md
|
|
|
3623
3623
|
|
|
3624
3624
|
> **ipLimit**(`ip`, `mask?`): `string`
|
|
3625
3625
|
|
|
3626
|
-
Defined in: [lib/core.ts:
|
|
3626
|
+
Defined in: [lib/core.ts:446](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L446)
|
|
3627
3627
|
|
|
3628
3628
|
截取 IP 的限速段
|
|
3629
3629
|
IPv4 原样返回;IPv6 截取前 mask 位(默认 /64),防止同一人使用大量 IPv6 地址绕过限速
|
|
@@ -3661,7 +3661,7 @@ lib/core/functions/ip.md
|
|
|
3661
3661
|
|
|
3662
3662
|
> **ip**(`ctr`, `req?`): `string`
|
|
3663
3663
|
|
|
3664
|
-
Defined in: [lib/core.ts:
|
|
3664
|
+
Defined in: [lib/core.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L359)
|
|
3665
3665
|
|
|
3666
3666
|
获取 IP(非安全 IP)
|
|
3667
3667
|
|
|
@@ -3692,7 +3692,7 @@ lib/core/functions/ips.md
|
|
|
3692
3692
|
|
|
3693
3693
|
> **ips**(`ctr`): `object`
|
|
3694
3694
|
|
|
3695
|
-
Defined in: [lib/core.ts:
|
|
3695
|
+
Defined in: [lib/core.ts:385](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L385)
|
|
3696
3696
|
|
|
3697
3697
|
获取 CF 和 X 的 IP
|
|
3698
3698
|
|
|
@@ -3727,7 +3727,7 @@ lib/core/functions/loadEnv.md
|
|
|
3727
3727
|
|
|
3728
3728
|
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3729
3729
|
|
|
3730
|
-
Defined in: [lib/core.ts:
|
|
3730
|
+
Defined in: [lib/core.ts:1447](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1447)
|
|
3731
3731
|
|
|
3732
3732
|
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3733
3733
|
|
|
@@ -3756,7 +3756,7 @@ lib/core/functions/log.md
|
|
|
3756
3756
|
|
|
3757
3757
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3758
3758
|
|
|
3759
|
-
Defined in: [lib/core.ts:
|
|
3759
|
+
Defined in: [lib/core.ts:1135](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1135)
|
|
3760
3760
|
|
|
3761
3761
|
写入文件日志
|
|
3762
3762
|
|
|
@@ -3797,7 +3797,7 @@ lib/core/functions/ls.md
|
|
|
3797
3797
|
|
|
3798
3798
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3799
3799
|
|
|
3800
|
-
Defined in: [lib/core.ts:
|
|
3800
|
+
Defined in: [lib/core.ts:1297](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1297)
|
|
3801
3801
|
|
|
3802
3802
|
获取目录内文件/文件夹列表
|
|
3803
3803
|
|
|
@@ -3840,7 +3840,7 @@ lib/core/functions/muid.md
|
|
|
3840
3840
|
|
|
3841
3841
|
> **muid**(`ctr`, `opt?`): `string`
|
|
3842
3842
|
|
|
3843
|
-
Defined in: [lib/core.ts:
|
|
3843
|
+
Defined in: [lib/core.ts:319](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L319)
|
|
3844
3844
|
|
|
3845
3845
|
获取 MUID
|
|
3846
3846
|
|
|
@@ -3903,7 +3903,7 @@ lib/core/functions/objectSort.md
|
|
|
3903
3903
|
|
|
3904
3904
|
> **objectSort**\<`T`\>(`o`): `T`
|
|
3905
3905
|
|
|
3906
|
-
Defined in: [lib/core.ts:
|
|
3906
|
+
Defined in: [lib/core.ts:599](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L599)
|
|
3907
3907
|
|
|
3908
3908
|
将对象进行升序排列
|
|
3909
3909
|
|
|
@@ -3938,7 +3938,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3938
3938
|
|
|
3939
3939
|
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3940
3940
|
|
|
3941
|
-
Defined in: [lib/core.ts:
|
|
3941
|
+
Defined in: [lib/core.ts:637](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L637)
|
|
3942
3942
|
|
|
3943
3943
|
调用前自行创建 passThrough,并且调用 pipe 绑定到应该绑定的对象,然后再调用本函数
|
|
3944
3944
|
|
|
@@ -3979,7 +3979,7 @@ lib/core/functions/purify.md
|
|
|
3979
3979
|
|
|
3980
3980
|
> **purify**(`text`): `string`
|
|
3981
3981
|
|
|
3982
|
-
Defined in: [lib/core.ts:
|
|
3982
|
+
Defined in: [lib/core.ts:184](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L184)
|
|
3983
3983
|
|
|
3984
3984
|
去除 html 的空白符、换行以及注释
|
|
3985
3985
|
|
|
@@ -4008,7 +4008,7 @@ lib/core/functions/rand.md
|
|
|
4008
4008
|
|
|
4009
4009
|
> **rand**(`min`, `max`, `prec?`): `number`
|
|
4010
4010
|
|
|
4011
|
-
Defined in: [lib/core.ts:
|
|
4011
|
+
Defined in: [lib/core.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L92)
|
|
4012
4012
|
|
|
4013
4013
|
生成基础的范围随机数
|
|
4014
4014
|
|
|
@@ -4049,7 +4049,7 @@ lib/core/functions/random.md
|
|
|
4049
4049
|
|
|
4050
4050
|
> **random**(`length?`, `source?`, `block?`): `string`
|
|
4051
4051
|
|
|
4052
|
-
Defined in: [lib/core.ts:
|
|
4052
|
+
Defined in: [lib/core.ts:130](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L130)
|
|
4053
4053
|
|
|
4054
4054
|
生成随机字符串
|
|
4055
4055
|
|
|
@@ -4090,7 +4090,7 @@ lib/core/functions/realIPLimit.md
|
|
|
4090
4090
|
|
|
4091
4091
|
> **realIPLimit**(`ctr`, `name?`, `mask?`): `string`
|
|
4092
4092
|
|
|
4093
|
-
Defined in: [lib/core.ts:
|
|
4093
|
+
Defined in: [lib/core.ts:466](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L466)
|
|
4094
4094
|
|
|
4095
4095
|
获取安全 IP 的限速段(用于 ratelimit 库的 key)
|
|
4096
4096
|
IPv4 原样返回;IPv6 截取前 mask 位(默认 /64)
|
|
@@ -4134,7 +4134,7 @@ lib/core/functions/realIP.md
|
|
|
4134
4134
|
|
|
4135
4135
|
> **realIP**(`ctr`, `name?`): `string`
|
|
4136
4136
|
|
|
4137
|
-
Defined in: [lib/core.ts:
|
|
4137
|
+
Defined in: [lib/core.ts:427](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L427)
|
|
4138
4138
|
|
|
4139
4139
|
获取直连 IP(安全 IP)
|
|
4140
4140
|
|
|
@@ -4167,7 +4167,7 @@ lib/core/functions/removeGlobal.md
|
|
|
4167
4167
|
|
|
4168
4168
|
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4169
4169
|
|
|
4170
|
-
Defined in: [lib/core.ts:
|
|
4170
|
+
Defined in: [lib/core.ts:952](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L952)
|
|
4171
4171
|
|
|
4172
4172
|
移除某个跨线程/跨内网服务器全局变量
|
|
4173
4173
|
|
|
@@ -4202,7 +4202,7 @@ lib/core/functions/resolveEnvVars.md
|
|
|
4202
4202
|
|
|
4203
4203
|
> **resolveEnvVars**(`obj`): `void`
|
|
4204
4204
|
|
|
4205
|
-
Defined in: [lib/core.ts:
|
|
4205
|
+
Defined in: [lib/core.ts:1477](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1477)
|
|
4206
4206
|
|
|
4207
4207
|
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
4208
4208
|
|
|
@@ -4231,7 +4231,7 @@ lib/core/functions/sendNpm.md
|
|
|
4231
4231
|
|
|
4232
4232
|
> **sendNpm**(`path`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4233
4233
|
|
|
4234
|
-
Defined in: [lib/core.ts:
|
|
4234
|
+
Defined in: [lib/core.ts:851](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L851)
|
|
4235
4235
|
|
|
4236
4236
|
向本机或局域网 RPC 发送 npm install 操作
|
|
4237
4237
|
|
|
@@ -4266,7 +4266,7 @@ lib/core/functions/sendPackage.md
|
|
|
4266
4266
|
|
|
4267
4267
|
> **sendPackage**(`content`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4268
4268
|
|
|
4269
|
-
Defined in: [lib/core.ts:
|
|
4269
|
+
Defined in: [lib/core.ts:1075](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1075)
|
|
4270
4270
|
|
|
4271
4271
|
向本机或局域网 RPC 发送 package.json 更新操作
|
|
4272
4272
|
|
|
@@ -4301,7 +4301,7 @@ lib/core/functions/sendPm2.md
|
|
|
4301
4301
|
|
|
4302
4302
|
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4303
4303
|
|
|
4304
|
-
Defined in: [lib/core.ts:
|
|
4304
|
+
Defined in: [lib/core.ts:803](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L803)
|
|
4305
4305
|
|
|
4306
4306
|
向本机或局域网 RPC 发送 PM2 操作
|
|
4307
4307
|
|
|
@@ -4342,7 +4342,7 @@ lib/core/functions/sendProject.md
|
|
|
4342
4342
|
|
|
4343
4343
|
> **sendProject**(`path`, `key`, `value`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4344
4344
|
|
|
4345
|
-
Defined in: [lib/core.ts:
|
|
4345
|
+
Defined in: [lib/core.ts:1027](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1027)
|
|
4346
4346
|
|
|
4347
4347
|
向本机或局域网 RPC 发送项目配置更新操作
|
|
4348
4348
|
|
|
@@ -4389,7 +4389,7 @@ lib/core/functions/sendReload.md
|
|
|
4389
4389
|
|
|
4390
4390
|
> **sendReload**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4391
4391
|
|
|
4392
|
-
Defined in: [lib/core.ts:
|
|
4392
|
+
Defined in: [lib/core.ts:700](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L700)
|
|
4393
4393
|
|
|
4394
4394
|
向主进程(或局域网同代码机子)发送广播将进行 reload 操作,等待回传
|
|
4395
4395
|
主要作用除代码热更新以外的其他情况
|
|
@@ -4417,7 +4417,7 @@ lib/core/functions/sendRestart.md
|
|
|
4417
4417
|
|
|
4418
4418
|
> **sendRestart**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4419
4419
|
|
|
4420
|
-
Defined in: [lib/core.ts:
|
|
4420
|
+
Defined in: [lib/core.ts:749](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L749)
|
|
4421
4421
|
|
|
4422
4422
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
4423
4423
|
主要用作不间断的代码热更新
|
|
@@ -4445,7 +4445,7 @@ lib/core/functions/setCookie.md
|
|
|
4445
4445
|
|
|
4446
4446
|
> **setCookie**(`ctr`, `name`, `value`, `opt?`): `void`
|
|
4447
4447
|
|
|
4448
|
-
Defined in: [lib/core.ts:
|
|
4448
|
+
Defined in: [lib/core.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L63)
|
|
4449
4449
|
|
|
4450
4450
|
设置 cookie
|
|
4451
4451
|
|
|
@@ -4492,7 +4492,7 @@ lib/core/functions/setGlobal.md
|
|
|
4492
4492
|
|
|
4493
4493
|
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4494
4494
|
|
|
4495
|
-
Defined in: [lib/core.ts:
|
|
4495
|
+
Defined in: [lib/core.ts:902](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L902)
|
|
4496
4496
|
|
|
4497
4497
|
设置跨线程/指定的局域网主机的全局变量
|
|
4498
4498
|
|
|
@@ -4533,7 +4533,7 @@ lib/core/functions/sleep.md
|
|
|
4533
4533
|
|
|
4534
4534
|
> **sleep**(`ms`): `Promise`\<`void`\>
|
|
4535
4535
|
|
|
4536
|
-
Defined in: [lib/core.ts:
|
|
4536
|
+
Defined in: [lib/core.ts:587](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L587)
|
|
4537
4537
|
|
|
4538
4538
|
间隔一段时间
|
|
4539
4539
|
|
|
@@ -4562,7 +4562,7 @@ lib/core/functions/unconvert62.md
|
|
|
4562
4562
|
|
|
4563
4563
|
> **unconvert62**(`n`): `bigint`
|
|
4564
4564
|
|
|
4565
|
-
Defined in: [lib/core.ts:
|
|
4565
|
+
Defined in: [lib/core.ts:171](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L171)
|
|
4566
4566
|
|
|
4567
4567
|
将 62 进制转换为 10 进制
|
|
4568
4568
|
|
|
@@ -4591,7 +4591,7 @@ lib/core/functions/updateCode.md
|
|
|
4591
4591
|
|
|
4592
4592
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4593
4593
|
|
|
4594
|
-
Defined in: [lib/core.ts:
|
|
4594
|
+
Defined in: [lib/core.ts:967](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L967)
|
|
4595
4595
|
|
|
4596
4596
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
4597
4597
|
|
|
@@ -4644,7 +4644,7 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4644
4644
|
|
|
4645
4645
|
> **writeEventStreamHead**(`res`): `void`
|
|
4646
4646
|
|
|
4647
|
-
Defined in: [lib/core.ts:
|
|
4647
|
+
Defined in: [lib/core.ts:1417](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1417)
|
|
4648
4648
|
|
|
4649
4649
|
## Parameters
|
|
4650
4650
|
|
|
@@ -4669,7 +4669,7 @@ lib/core/functions/writeHead.md
|
|
|
4669
4669
|
|
|
4670
4670
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4671
4671
|
|
|
4672
|
-
Defined in: [lib/core.ts:
|
|
4672
|
+
Defined in: [lib/core.ts:1406](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1406)
|
|
4673
4673
|
|
|
4674
4674
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4675
4675
|
|
|
@@ -4710,7 +4710,7 @@ lib/core/functions/write.md
|
|
|
4710
4710
|
|
|
4711
4711
|
> **write**(`res`, `data`): `void`
|
|
4712
4712
|
|
|
4713
|
-
Defined in: [lib/core.ts:
|
|
4713
|
+
Defined in: [lib/core.ts:1429](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1429)
|
|
4714
4714
|
|
|
4715
4715
|
向 res 发送数据
|
|
4716
4716
|
|
|
@@ -4822,7 +4822,7 @@ lib/core/interfaces/ICookieOptions.md
|
|
|
4822
4822
|
|
|
4823
4823
|
# Interface: ICookieOptions
|
|
4824
4824
|
|
|
4825
|
-
Defined in: [lib/core.ts:
|
|
4825
|
+
Defined in: [lib/core.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L47)
|
|
4826
4826
|
|
|
4827
4827
|
Cookie 设置的选项
|
|
4828
4828
|
|
|
@@ -4832,7 +4832,7 @@ Cookie 设置的选项
|
|
|
4832
4832
|
|
|
4833
4833
|
> `optional` **domain?**: `string`
|
|
4834
4834
|
|
|
4835
|
-
Defined in: [lib/core.ts:
|
|
4835
|
+
Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L50)
|
|
4836
4836
|
|
|
4837
4837
|
***
|
|
4838
4838
|
|
|
@@ -4840,7 +4840,7 @@ Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4840
4840
|
|
|
4841
4841
|
> `optional` **httponly?**: `boolean`
|
|
4842
4842
|
|
|
4843
|
-
Defined in: [lib/core.ts:
|
|
4843
|
+
Defined in: [lib/core.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L52)
|
|
4844
4844
|
|
|
4845
4845
|
***
|
|
4846
4846
|
|
|
@@ -4848,7 +4848,7 @@ Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4848
4848
|
|
|
4849
4849
|
> `optional` **path?**: `string`
|
|
4850
4850
|
|
|
4851
|
-
Defined in: [lib/core.ts:
|
|
4851
|
+
Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L49)
|
|
4852
4852
|
|
|
4853
4853
|
***
|
|
4854
4854
|
|
|
@@ -4856,7 +4856,7 @@ Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4856
4856
|
|
|
4857
4857
|
> `optional` **samesite?**: `"Strict"` \| `"Lax"` \| `"None"`
|
|
4858
4858
|
|
|
4859
|
-
Defined in: [lib/core.ts:
|
|
4859
|
+
Defined in: [lib/core.ts:53](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L53)
|
|
4860
4860
|
|
|
4861
4861
|
***
|
|
4862
4862
|
|
|
@@ -4864,7 +4864,7 @@ Defined in: [lib/core.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4864
4864
|
|
|
4865
4865
|
> `optional` **ssl?**: `boolean`
|
|
4866
4866
|
|
|
4867
|
-
Defined in: [lib/core.ts:
|
|
4867
|
+
Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L51)
|
|
4868
4868
|
|
|
4869
4869
|
***
|
|
4870
4870
|
|
|
@@ -4872,7 +4872,7 @@ Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4872
4872
|
|
|
4873
4873
|
> `optional` **ttl?**: `number`
|
|
4874
4874
|
|
|
4875
|
-
Defined in: [lib/core.ts:
|
|
4875
|
+
Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L48)
|
|
4876
4876
|
|
|
4877
4877
|
lib/core/interfaces/ILogOptions.md
|
|
4878
4878
|
---
|
|
@@ -4885,7 +4885,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4885
4885
|
|
|
4886
4886
|
# Interface: ILogOptions
|
|
4887
4887
|
|
|
4888
|
-
Defined in: [lib/core.ts:
|
|
4888
|
+
Defined in: [lib/core.ts:1118](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1118)
|
|
4889
4889
|
|
|
4890
4890
|
log 设置的选项
|
|
4891
4891
|
|
|
@@ -4895,7 +4895,7 @@ log 设置的选项
|
|
|
4895
4895
|
|
|
4896
4896
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4897
4897
|
|
|
4898
|
-
Defined in: [lib/core.ts:
|
|
4898
|
+
Defined in: [lib/core.ts:1124](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1124)
|
|
4899
4899
|
|
|
4900
4900
|
***
|
|
4901
4901
|
|
|
@@ -4903,7 +4903,7 @@ Defined in: [lib/core.ts:1123](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4903
4903
|
|
|
4904
4904
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4905
4905
|
|
|
4906
|
-
Defined in: [lib/core.ts:
|
|
4906
|
+
Defined in: [lib/core.ts:1123](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1123)
|
|
4907
4907
|
|
|
4908
4908
|
***
|
|
4909
4909
|
|
|
@@ -4911,7 +4911,7 @@ Defined in: [lib/core.ts:1122](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4911
4911
|
|
|
4912
4912
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4913
4913
|
|
|
4914
|
-
Defined in: [lib/core.ts:
|
|
4914
|
+
Defined in: [lib/core.ts:1126](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1126)
|
|
4915
4915
|
|
|
4916
4916
|
***
|
|
4917
4917
|
|
|
@@ -4919,7 +4919,7 @@ Defined in: [lib/core.ts:1125](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4919
4919
|
|
|
4920
4920
|
> `optional` **hostname?**: `string`
|
|
4921
4921
|
|
|
4922
|
-
Defined in: [lib/core.ts:
|
|
4922
|
+
Defined in: [lib/core.ts:1121](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1121)
|
|
4923
4923
|
|
|
4924
4924
|
***
|
|
4925
4925
|
|
|
@@ -4927,7 +4927,7 @@ Defined in: [lib/core.ts:1120](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4927
4927
|
|
|
4928
4928
|
> `optional` **path?**: `string`
|
|
4929
4929
|
|
|
4930
|
-
Defined in: [lib/core.ts:
|
|
4930
|
+
Defined in: [lib/core.ts:1119](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1119)
|
|
4931
4931
|
|
|
4932
4932
|
***
|
|
4933
4933
|
|
|
@@ -4935,7 +4935,7 @@ Defined in: [lib/core.ts:1118](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4935
4935
|
|
|
4936
4936
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4937
4937
|
|
|
4938
|
-
Defined in: [lib/core.ts:
|
|
4938
|
+
Defined in: [lib/core.ts:1122](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1122)
|
|
4939
4939
|
|
|
4940
4940
|
***
|
|
4941
4941
|
|
|
@@ -4943,7 +4943,7 @@ Defined in: [lib/core.ts:1121](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4943
4943
|
|
|
4944
4944
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4945
4945
|
|
|
4946
|
-
Defined in: [lib/core.ts:
|
|
4946
|
+
Defined in: [lib/core.ts:1125](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1125)
|
|
4947
4947
|
|
|
4948
4948
|
***
|
|
4949
4949
|
|
|
@@ -4951,7 +4951,7 @@ Defined in: [lib/core.ts:1124](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4951
4951
|
|
|
4952
4952
|
> `optional` **urlFull?**: `string`
|
|
4953
4953
|
|
|
4954
|
-
Defined in: [lib/core.ts:
|
|
4954
|
+
Defined in: [lib/core.ts:1120](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1120)
|
|
4955
4955
|
|
|
4956
4956
|
lib/core/type-aliases/TPm2Action.md
|
|
4957
4957
|
---
|
|
@@ -4966,7 +4966,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4966
4966
|
|
|
4967
4967
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4968
4968
|
|
|
4969
|
-
Defined in: [lib/core.ts:
|
|
4969
|
+
Defined in: [lib/core.ts:795](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L795)
|
|
4970
4970
|
|
|
4971
4971
|
PM2 操作类型
|
|
4972
4972
|
|
|
@@ -4983,7 +4983,7 @@ lib/core/variables/globalConfig.md
|
|
|
4983
4983
|
|
|
4984
4984
|
> `const` **globalConfig**: [`IConfig`](../../../index/interfaces/IConfig.md) & `object`
|
|
4985
4985
|
|
|
4986
|
-
Defined in: [lib/core.ts:
|
|
4986
|
+
Defined in: [lib/core.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L26)
|
|
4987
4987
|
|
|
4988
4988
|
全局参数
|
|
4989
4989
|
|
|
@@ -5040,7 +5040,7 @@ lib/core/variables/global.md
|
|
|
5040
5040
|
|
|
5041
5041
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
5042
5042
|
|
|
5043
|
-
Defined in: [lib/core.ts:
|
|
5043
|
+
Defined in: [lib/core.ts:894](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L894)
|
|
5044
5044
|
|
|
5045
5045
|
跨进程全局变量
|
|
5046
5046
|
|
|
@@ -5057,7 +5057,7 @@ lib/core/variables/RANDOM_L.md
|
|
|
5057
5057
|
|
|
5058
5058
|
> `const` **RANDOM\_L**: `"abcdefghijklmnopqrstuvwxyz"` = `'abcdefghijklmnopqrstuvwxyz'`
|
|
5059
5059
|
|
|
5060
|
-
Defined in: [lib/core.ts:
|
|
5060
|
+
Defined in: [lib/core.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L109)
|
|
5061
5061
|
|
|
5062
5062
|
小写字母字符集
|
|
5063
5063
|
|
|
@@ -5074,7 +5074,7 @@ lib/core/variables/RANDOM_LN.md
|
|
|
5074
5074
|
|
|
5075
5075
|
> `const` **RANDOM\_LN**: `string`
|
|
5076
5076
|
|
|
5077
|
-
Defined in: [lib/core.ts:
|
|
5077
|
+
Defined in: [lib/core.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L114)
|
|
5078
5078
|
|
|
5079
5079
|
小写字母 + 数字字符集
|
|
5080
5080
|
|
|
@@ -5091,7 +5091,7 @@ lib/core/variables/RANDOM_LU.md
|
|
|
5091
5091
|
|
|
5092
5092
|
> `const` **RANDOM\_LU**: `string`
|
|
5093
5093
|
|
|
5094
|
-
Defined in: [lib/core.ts:
|
|
5094
|
+
Defined in: [lib/core.ts:116](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L116)
|
|
5095
5095
|
|
|
5096
5096
|
小写字母 + 大写字母字符集
|
|
5097
5097
|
|
|
@@ -5108,7 +5108,7 @@ lib/core/variables/RANDOM_LUN.md
|
|
|
5108
5108
|
|
|
5109
5109
|
> `const` **RANDOM\_LUN**: `string`
|
|
5110
5110
|
|
|
5111
|
-
Defined in: [lib/core.ts:
|
|
5111
|
+
Defined in: [lib/core.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L118)
|
|
5112
5112
|
|
|
5113
5113
|
小写字母 + 大写字母 + 数字字符集
|
|
5114
5114
|
|
|
@@ -5125,7 +5125,7 @@ lib/core/variables/RANDOM_LUNS.md
|
|
|
5125
5125
|
|
|
5126
5126
|
> `const` **RANDOM\_LUNS**: `string`
|
|
5127
5127
|
|
|
5128
|
-
Defined in: [lib/core.ts:
|
|
5128
|
+
Defined in: [lib/core.ts:122](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L122)
|
|
5129
5129
|
|
|
5130
5130
|
小写字母 + 大写字母 + 数字字符集 + 特殊字符字符集
|
|
5131
5131
|
|
|
@@ -5142,7 +5142,7 @@ lib/core/variables/RANDOM_N.md
|
|
|
5142
5142
|
|
|
5143
5143
|
> `const` **RANDOM\_N**: `"0123456789"` = `'0123456789'`
|
|
5144
5144
|
|
|
5145
|
-
Defined in: [lib/core.ts:
|
|
5145
|
+
Defined in: [lib/core.ts:105](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L105)
|
|
5146
5146
|
|
|
5147
5147
|
数字字符集
|
|
5148
5148
|
|
|
@@ -5159,7 +5159,7 @@ lib/core/variables/RANDOM_U.md
|
|
|
5159
5159
|
|
|
5160
5160
|
> `const` **RANDOM\_U**: `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"` = `'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`
|
|
5161
5161
|
|
|
5162
|
-
Defined in: [lib/core.ts:
|
|
5162
|
+
Defined in: [lib/core.ts:107](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L107)
|
|
5163
5163
|
|
|
5164
5164
|
大写字母字符集
|
|
5165
5165
|
|
|
@@ -5176,7 +5176,7 @@ lib/core/variables/RANDOM_UN.md
|
|
|
5176
5176
|
|
|
5177
5177
|
> `const` **RANDOM\_UN**: `string`
|
|
5178
5178
|
|
|
5179
|
-
Defined in: [lib/core.ts:
|
|
5179
|
+
Defined in: [lib/core.ts:112](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L112)
|
|
5180
5180
|
|
|
5181
5181
|
大写字母 + 数字字符集
|
|
5182
5182
|
|
|
@@ -5193,7 +5193,7 @@ lib/core/variables/RANDOM_V.md
|
|
|
5193
5193
|
|
|
5194
5194
|
> `const` **RANDOM\_V**: `"ACEFGHJKLMNPRSTWXY34567"` = `'ACEFGHJKLMNPRSTWXY34567'`
|
|
5195
5195
|
|
|
5196
|
-
Defined in: [lib/core.ts:
|
|
5196
|
+
Defined in: [lib/core.ts:120](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L120)
|
|
5197
5197
|
|
|
5198
5198
|
验证码字符集
|
|
5199
5199
|
|
|
@@ -5210,7 +5210,7 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
5210
5210
|
|
|
5211
5211
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
5212
5212
|
|
|
5213
|
-
Defined in: [lib/core.ts:
|
|
5213
|
+
Defined in: [lib/core.ts:401](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L401)
|
|
5214
5214
|
|
|
5215
5215
|
使用的是 Cloudflare
|
|
5216
5216
|
|
|
@@ -5227,7 +5227,7 @@ lib/core/variables/REAL_IP_EO.md
|
|
|
5227
5227
|
|
|
5228
5228
|
> `const` **REAL\_IP\_EO**: `"eo-connecting-ip"` = `'eo-connecting-ip'`
|
|
5229
5229
|
|
|
5230
|
-
Defined in: [lib/core.ts:
|
|
5230
|
+
Defined in: [lib/core.ts:403](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L403)
|
|
5231
5231
|
|
|
5232
5232
|
使用的是 EO
|
|
5233
5233
|
|
|
@@ -5244,7 +5244,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
5244
5244
|
|
|
5245
5245
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
5246
5246
|
|
|
5247
|
-
Defined in: [lib/core.ts:
|
|
5247
|
+
Defined in: [lib/core.ts:399](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L399)
|
|
5248
5248
|
|
|
5249
5249
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
5250
5250
|
|
|
@@ -8542,7 +8542,7 @@ lib/fs/functions/chmod.md
|
|
|
8542
8542
|
|
|
8543
8543
|
> **chmod**(`path`, `mod`): `Promise`\<`boolean`\>
|
|
8544
8544
|
|
|
8545
|
-
Defined in: [lib/fs.ts:
|
|
8545
|
+
Defined in: [lib/fs.ts:277](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L277)
|
|
8546
8546
|
|
|
8547
8547
|
修改权限
|
|
8548
8548
|
|
|
@@ -8577,7 +8577,7 @@ lib/fs/functions/copyFile.md
|
|
|
8577
8577
|
|
|
8578
8578
|
> **copyFile**(`src`, `dest`): `Promise`\<`boolean`\>
|
|
8579
8579
|
|
|
8580
|
-
Defined in: [lib/fs.ts:
|
|
8580
|
+
Defined in: [lib/fs.ts:385](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L385)
|
|
8581
8581
|
|
|
8582
8582
|
复制文件
|
|
8583
8583
|
|
|
@@ -8612,7 +8612,7 @@ lib/fs/functions/copyFolder.md
|
|
|
8612
8612
|
|
|
8613
8613
|
> **copyFolder**(`from`, `to`, `ignore?`): `Promise`\<`number`\>
|
|
8614
8614
|
|
|
8615
|
-
Defined in: [lib/fs.ts:
|
|
8615
|
+
Defined in: [lib/fs.ts:340](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L340)
|
|
8616
8616
|
|
|
8617
8617
|
复制文件夹里的内容到另一个地方,失败不会回滚
|
|
8618
8618
|
|
|
@@ -8653,7 +8653,7 @@ lib/fs/functions/createReadStream.md
|
|
|
8653
8653
|
|
|
8654
8654
|
> **createReadStream**(`path`, `options?`): `ReadStream`
|
|
8655
8655
|
|
|
8656
|
-
Defined in: [lib/fs.ts:
|
|
8656
|
+
Defined in: [lib/fs.ts:400](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L400)
|
|
8657
8657
|
|
|
8658
8658
|
创建读取文件的流
|
|
8659
8659
|
|
|
@@ -8688,7 +8688,7 @@ lib/fs/functions/createWriteStream.md
|
|
|
8688
8688
|
|
|
8689
8689
|
> **createWriteStream**(`path`, `options?`): `WriteStream`
|
|
8690
8690
|
|
|
8691
|
-
Defined in: [lib/fs.ts:
|
|
8691
|
+
Defined in: [lib/fs.ts:447](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L447)
|
|
8692
8692
|
|
|
8693
8693
|
创建写入文件的流
|
|
8694
8694
|
|
|
@@ -8794,7 +8794,7 @@ lib/fs/functions/isDir.md
|
|
|
8794
8794
|
|
|
8795
8795
|
> **isDir**(`path`): `Promise`\<`false` \| `Stats`\>
|
|
8796
8796
|
|
|
8797
|
-
Defined in: [lib/fs.ts:
|
|
8797
|
+
Defined in: [lib/fs.ts:181](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L181)
|
|
8798
8798
|
|
|
8799
8799
|
判断是否是目录或目录是否存在,是的话返回 stats
|
|
8800
8800
|
|
|
@@ -8823,7 +8823,7 @@ lib/fs/functions/isFile.md
|
|
|
8823
8823
|
|
|
8824
8824
|
> **isFile**(`path`): `Promise`\<`false` \| `Stats`\>
|
|
8825
8825
|
|
|
8826
|
-
Defined in: [lib/fs.ts:
|
|
8826
|
+
Defined in: [lib/fs.ts:193](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L193)
|
|
8827
8827
|
|
|
8828
8828
|
判断是否是文件或文件是否存在,是的话返回 stats
|
|
8829
8829
|
|
|
@@ -8852,7 +8852,7 @@ lib/fs/functions/mkdir.md
|
|
|
8852
8852
|
|
|
8853
8853
|
> **mkdir**(`path`, `mode?`): `Promise`\<`boolean`\>
|
|
8854
8854
|
|
|
8855
|
-
Defined in: [lib/fs.ts:
|
|
8855
|
+
Defined in: [lib/fs.ts:206](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L206)
|
|
8856
8856
|
|
|
8857
8857
|
深度创建目录,如果最末目录存在,则自动创建成功
|
|
8858
8858
|
|
|
@@ -8887,7 +8887,7 @@ lib/fs/functions/pipe.md
|
|
|
8887
8887
|
|
|
8888
8888
|
> **pipe**(`path`, `destination`, `options?`): `Promise`\<`boolean`\>
|
|
8889
8889
|
|
|
8890
|
-
Defined in: [lib/fs.ts:
|
|
8890
|
+
Defined in: [lib/fs.ts:430](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L430)
|
|
8891
8891
|
|
|
8892
8892
|
读取文件写入到流,并等待写入完成
|
|
8893
8893
|
|
|
@@ -8930,7 +8930,7 @@ lib/fs/functions/putContent.md
|
|
|
8930
8930
|
|
|
8931
8931
|
> **putContent**(`path`, `data`, `options?`): `Promise`\<`boolean`\>
|
|
8932
8932
|
|
|
8933
|
-
Defined in: [lib/fs.ts:
|
|
8933
|
+
Defined in: [lib/fs.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L92)
|
|
8934
8934
|
|
|
8935
8935
|
写入文件内容
|
|
8936
8936
|
|
|
@@ -8981,7 +8981,7 @@ lib/fs/functions/readDir.md
|
|
|
8981
8981
|
|
|
8982
8982
|
> **readDir**(`path`, `encoding?`): `Promise`\<`Dirent`\<`string`\>[]\>
|
|
8983
8983
|
|
|
8984
|
-
Defined in: [lib/fs.ts:
|
|
8984
|
+
Defined in: [lib/fs.ts:306](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L306)
|
|
8985
8985
|
|
|
8986
8986
|
获取文件夹下文件列表
|
|
8987
8987
|
|
|
@@ -9014,7 +9014,7 @@ lib/fs/functions/readLink.md
|
|
|
9014
9014
|
|
|
9015
9015
|
> **readLink**(`path`, `encoding?`): `Promise`\<`string` \| `null`\>
|
|
9016
9016
|
|
|
9017
|
-
Defined in: [lib/fs.ts:
|
|
9017
|
+
Defined in: [lib/fs.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L114)
|
|
9018
9018
|
|
|
9019
9019
|
读取链接的 target
|
|
9020
9020
|
|
|
@@ -9049,7 +9049,7 @@ lib/fs/functions/readToResponse.md
|
|
|
9049
9049
|
|
|
9050
9050
|
> **readToResponse**(`path`, `req`, `res`, `stat?`): `Promise`\<`void`\>
|
|
9051
9051
|
|
|
9052
|
-
Defined in: [lib/fs.ts:
|
|
9052
|
+
Defined in: [lib/fs.ts:478](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L478)
|
|
9053
9053
|
|
|
9054
9054
|
读取文件并输出到 http 的 response
|
|
9055
9055
|
|
|
@@ -9096,7 +9096,7 @@ lib/fs/functions/rename.md
|
|
|
9096
9096
|
|
|
9097
9097
|
> **rename**(`oldPath`, `newPath`): `Promise`\<`boolean`\>
|
|
9098
9098
|
|
|
9099
|
-
Defined in: [lib/fs.ts:
|
|
9099
|
+
Defined in: [lib/fs.ts:292](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L292)
|
|
9100
9100
|
|
|
9101
9101
|
重命名/移动文件文件夹
|
|
9102
9102
|
|
|
@@ -9131,7 +9131,7 @@ lib/fs/functions/rmdirDeep.md
|
|
|
9131
9131
|
|
|
9132
9132
|
> **rmdirDeep**(`path`): `Promise`\<`boolean`\>
|
|
9133
9133
|
|
|
9134
|
-
Defined in: [lib/fs.ts:
|
|
9134
|
+
Defined in: [lib/fs.ts:245](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L245)
|
|
9135
9135
|
|
|
9136
9136
|
Danger 危险:危险函数,尽量不要使用
|
|
9137
9137
|
This is a danger function, please don't use it
|
|
@@ -9160,7 +9160,7 @@ lib/fs/functions/rmdir.md
|
|
|
9160
9160
|
|
|
9161
9161
|
> **rmdir**(`path`): `Promise`\<`boolean`\>
|
|
9162
9162
|
|
|
9163
|
-
Defined in: [lib/fs.ts:
|
|
9163
|
+
Defined in: [lib/fs.ts:227](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L227)
|
|
9164
9164
|
|
|
9165
9165
|
删除空目录
|
|
9166
9166
|
|
|
@@ -9189,7 +9189,7 @@ lib/fs/functions/stats.md
|
|
|
9189
9189
|
|
|
9190
9190
|
> **stats**(`path`): `Promise`\<`Stats` \| `null`\>
|
|
9191
9191
|
|
|
9192
|
-
Defined in: [lib/fs.ts:
|
|
9192
|
+
Defined in: [lib/fs.ts:168](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L168)
|
|
9193
9193
|
|
|
9194
9194
|
获取对象是否存在,存在则返回 stats 对象,否则返回 null
|
|
9195
9195
|
|
|
@@ -9218,7 +9218,7 @@ lib/fs/functions/symlink.md
|
|
|
9218
9218
|
|
|
9219
9219
|
> **symlink**(`filePath`, `linkPath`, `type?`): `Promise`\<`boolean`\>
|
|
9220
9220
|
|
|
9221
|
-
Defined in: [lib/fs.ts:
|
|
9221
|
+
Defined in: [lib/fs.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L131)
|
|
9222
9222
|
|
|
9223
9223
|
把源文件创建一个 link
|
|
9224
9224
|
|
|
@@ -9259,7 +9259,7 @@ lib/fs/functions/unlink.md
|
|
|
9259
9259
|
|
|
9260
9260
|
> **unlink**(`path`): `Promise`\<`boolean`\>
|
|
9261
9261
|
|
|
9262
|
-
Defined in: [lib/fs.ts:
|
|
9262
|
+
Defined in: [lib/fs.ts:145](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L145)
|
|
9263
9263
|
|
|
9264
9264
|
删除一个文件
|
|
9265
9265
|
|
|
@@ -9416,7 +9416,7 @@ Defined in: [lib/kv.ts:142](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9416
9416
|
|
|
9417
9417
|
> **bLMove**(`sourceKey`, `destKey`, `soo`, `deo`, `timeout`): `Promise`\<`string` \| `false` \| `null`\>
|
|
9418
9418
|
|
|
9419
|
-
Defined in: [lib/kv.ts:
|
|
9419
|
+
Defined in: [lib/kv.ts:762](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L762)
|
|
9420
9420
|
|
|
9421
9421
|
#### Parameters
|
|
9422
9422
|
|
|
@@ -9450,7 +9450,7 @@ Defined in: [lib/kv.ts:741](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9450
9450
|
|
|
9451
9451
|
> **bRPop**(`key`, `timeout`): `Promise`\<`false` \| `Record`\<`string`, `string`\>\>
|
|
9452
9452
|
|
|
9453
|
-
Defined in: [lib/kv.ts:
|
|
9453
|
+
Defined in: [lib/kv.ts:801](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L801)
|
|
9454
9454
|
|
|
9455
9455
|
#### Parameters
|
|
9456
9456
|
|
|
@@ -9472,7 +9472,7 @@ Defined in: [lib/kv.ts:780](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9472
9472
|
|
|
9473
9473
|
> **decr**(`key`, `num?`): `Promise`\<`number` \| `false`\>
|
|
9474
9474
|
|
|
9475
|
-
Defined in: [lib/kv.ts:
|
|
9475
|
+
Defined in: [lib/kv.ts:408](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L408)
|
|
9476
9476
|
|
|
9477
9477
|
自减
|
|
9478
9478
|
|
|
@@ -9498,7 +9498,7 @@ Defined in: [lib/kv.ts:387](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9498
9498
|
|
|
9499
9499
|
> **del**(`keys`): `Promise`\<`boolean`\>
|
|
9500
9500
|
|
|
9501
|
-
Defined in: [lib/kv.ts:
|
|
9501
|
+
Defined in: [lib/kv.ts:356](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L356)
|
|
9502
9502
|
|
|
9503
9503
|
删除已存在的值
|
|
9504
9504
|
|
|
@@ -9540,7 +9540,7 @@ Defined in: [lib/kv.ts:194](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9540
9540
|
|
|
9541
9541
|
> **expire**(`key`, `ttl`): `Promise`\<`boolean`\>
|
|
9542
9542
|
|
|
9543
|
-
Defined in: [lib/kv.ts:
|
|
9543
|
+
Defined in: [lib/kv.ts:436](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L436)
|
|
9544
9544
|
|
|
9545
9545
|
仅修改过期时间不修改值
|
|
9546
9546
|
|
|
@@ -9564,7 +9564,7 @@ Defined in: [lib/kv.ts:415](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9564
9564
|
|
|
9565
9565
|
> **flushDb**(): `Promise`\<`boolean`\>
|
|
9566
9566
|
|
|
9567
|
-
Defined in: [lib/kv.ts:
|
|
9567
|
+
Defined in: [lib/kv.ts:503](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L503)
|
|
9568
9568
|
|
|
9569
9569
|
清除当前所选数据库的所有内容
|
|
9570
9570
|
|
|
@@ -9596,6 +9596,28 @@ Defined in: [lib/kv.ts:218](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9596
9596
|
|
|
9597
9597
|
***
|
|
9598
9598
|
|
|
9599
|
+
### getDelJson()
|
|
9600
|
+
|
|
9601
|
+
> **getDelJson**(`key`): `Promise`\<`any`\>
|
|
9602
|
+
|
|
9603
|
+
Defined in: [lib/kv.ts:335](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L335)
|
|
9604
|
+
|
|
9605
|
+
原子获取并删除 JSON 对象
|
|
9606
|
+
|
|
9607
|
+
#### Parameters
|
|
9608
|
+
|
|
9609
|
+
##### key
|
|
9610
|
+
|
|
9611
|
+
`string`
|
|
9612
|
+
|
|
9613
|
+
键
|
|
9614
|
+
|
|
9615
|
+
#### Returns
|
|
9616
|
+
|
|
9617
|
+
`Promise`\<`any`\>
|
|
9618
|
+
|
|
9619
|
+
***
|
|
9620
|
+
|
|
9599
9621
|
### getJson()
|
|
9600
9622
|
|
|
9601
9623
|
> **getJson**(`key`): `Promise`\<`any`\>
|
|
@@ -9620,7 +9642,7 @@ Defined in: [lib/kv.ts:322](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9620
9642
|
|
|
9621
9643
|
> **hDel**(`key`, `fields`): `Promise`\<`number` \| `false`\>
|
|
9622
9644
|
|
|
9623
|
-
Defined in: [lib/kv.ts:
|
|
9645
|
+
Defined in: [lib/kv.ts:664](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L664)
|
|
9624
9646
|
|
|
9625
9647
|
删除哈希键
|
|
9626
9648
|
|
|
@@ -9646,7 +9668,7 @@ Defined in: [lib/kv.ts:643](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9646
9668
|
|
|
9647
9669
|
> **hExists**(`key`, `field`): `Promise`\<`boolean`\>
|
|
9648
9670
|
|
|
9649
|
-
Defined in: [lib/kv.ts:
|
|
9671
|
+
Defined in: [lib/kv.ts:682](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L682)
|
|
9650
9672
|
|
|
9651
9673
|
判断哈希字段是否存在
|
|
9652
9674
|
|
|
@@ -9670,7 +9692,7 @@ Defined in: [lib/kv.ts:661](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9670
9692
|
|
|
9671
9693
|
> **hGet**(`key`, `field`): `Promise`\<`string` \| `false` \| `null`\>
|
|
9672
9694
|
|
|
9673
|
-
Defined in: [lib/kv.ts:
|
|
9695
|
+
Defined in: [lib/kv.ts:594](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L594)
|
|
9674
9696
|
|
|
9675
9697
|
获取哈希值
|
|
9676
9698
|
|
|
@@ -9694,7 +9716,7 @@ Defined in: [lib/kv.ts:573](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9694
9716
|
|
|
9695
9717
|
> **hGetAll**(`key`): `Promise`\<`false` \| `Record`\<`string`, `string` \| `null`\>\>
|
|
9696
9718
|
|
|
9697
|
-
Defined in: [lib/kv.ts:
|
|
9719
|
+
Defined in: [lib/kv.ts:646](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L646)
|
|
9698
9720
|
|
|
9699
9721
|
批量获取哈希键值对
|
|
9700
9722
|
|
|
@@ -9714,7 +9736,7 @@ Defined in: [lib/kv.ts:625](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9714
9736
|
|
|
9715
9737
|
> **hGetJson**(`key`, `field`): `Promise`\<`any`\>
|
|
9716
9738
|
|
|
9717
|
-
Defined in: [lib/kv.ts:
|
|
9739
|
+
Defined in: [lib/kv.ts:612](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L612)
|
|
9718
9740
|
|
|
9719
9741
|
获取哈希 json 对象
|
|
9720
9742
|
|
|
@@ -9738,7 +9760,7 @@ Defined in: [lib/kv.ts:591](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9738
9760
|
|
|
9739
9761
|
> **hIncr**(`key`, `field`, `increment`): `Promise`\<`number` \| `false`\>
|
|
9740
9762
|
|
|
9741
|
-
Defined in: [lib/kv.ts:
|
|
9763
|
+
Defined in: [lib/kv.ts:701](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L701)
|
|
9742
9764
|
|
|
9743
9765
|
设置哈希自增自减
|
|
9744
9766
|
|
|
@@ -9772,7 +9794,7 @@ key
|
|
|
9772
9794
|
|
|
9773
9795
|
> **hKeys**(`key`): `Promise`\<`false` \| `string`[]\>
|
|
9774
9796
|
|
|
9775
|
-
Defined in: [lib/kv.ts:
|
|
9797
|
+
Defined in: [lib/kv.ts:723](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L723)
|
|
9776
9798
|
|
|
9777
9799
|
获取哈希所有字段
|
|
9778
9800
|
|
|
@@ -9792,7 +9814,7 @@ Defined in: [lib/kv.ts:702](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9792
9814
|
|
|
9793
9815
|
> **hMGet**(`key`, `fields`): `Promise`\<`false` \| `Record`\<`string`, `string` \| `null`\>\>
|
|
9794
9816
|
|
|
9795
|
-
Defined in: [lib/kv.ts:
|
|
9817
|
+
Defined in: [lib/kv.ts:629](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L629)
|
|
9796
9818
|
|
|
9797
9819
|
批量获取哈希值
|
|
9798
9820
|
|
|
@@ -9816,7 +9838,7 @@ Defined in: [lib/kv.ts:608](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9816
9838
|
|
|
9817
9839
|
> **hMSet**(`key`, `rows`): `Promise`\<`boolean`\>
|
|
9818
9840
|
|
|
9819
|
-
Defined in: [lib/kv.ts:
|
|
9841
|
+
Defined in: [lib/kv.ts:566](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L566)
|
|
9820
9842
|
|
|
9821
9843
|
批量设置哈希值
|
|
9822
9844
|
|
|
@@ -9844,7 +9866,7 @@ key / val 数组
|
|
|
9844
9866
|
|
|
9845
9867
|
> **hSet**(`key`, `field`, `val`, `mod?`): `Promise`\<`boolean`\>
|
|
9846
9868
|
|
|
9847
|
-
Defined in: [lib/kv.ts:
|
|
9869
|
+
Defined in: [lib/kv.ts:540](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L540)
|
|
9848
9870
|
|
|
9849
9871
|
设置哈希表值
|
|
9850
9872
|
|
|
@@ -9884,7 +9906,7 @@ key 名
|
|
|
9884
9906
|
|
|
9885
9907
|
> **incr**(`key`, `num?`): `Promise`\<`number` \| `false`\>
|
|
9886
9908
|
|
|
9887
|
-
Defined in: [lib/kv.ts:
|
|
9909
|
+
Defined in: [lib/kv.ts:380](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L380)
|
|
9888
9910
|
|
|
9889
9911
|
自增
|
|
9890
9912
|
|
|
@@ -9910,7 +9932,7 @@ Defined in: [lib/kv.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9910
9932
|
|
|
9911
9933
|
> **keys**(`pattern`): `Promise`\<`false` \| `string`[]\>
|
|
9912
9934
|
|
|
9913
|
-
Defined in: [lib/kv.ts:
|
|
9935
|
+
Defined in: [lib/kv.ts:453](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L453)
|
|
9914
9936
|
|
|
9915
9937
|
获取服务器上的所有 key 列表
|
|
9916
9938
|
|
|
@@ -9930,7 +9952,7 @@ Defined in: [lib/kv.ts:432](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9930
9952
|
|
|
9931
9953
|
> **lLen**(`key`): `Promise`\<`number` \| `false`\>
|
|
9932
9954
|
|
|
9933
|
-
Defined in: [lib/kv.ts:
|
|
9955
|
+
Defined in: [lib/kv.ts:830](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L830)
|
|
9934
9956
|
|
|
9935
9957
|
#### Parameters
|
|
9936
9958
|
|
|
@@ -9948,7 +9970,7 @@ Defined in: [lib/kv.ts:809](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9948
9970
|
|
|
9949
9971
|
> **lPop**(`key`): `Promise`\<`string` \| `false` \| `null`\>
|
|
9950
9972
|
|
|
9951
|
-
Defined in: [lib/kv.ts:
|
|
9973
|
+
Defined in: [lib/kv.ts:775](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L775)
|
|
9952
9974
|
|
|
9953
9975
|
#### Parameters
|
|
9954
9976
|
|
|
@@ -9966,7 +9988,7 @@ Defined in: [lib/kv.ts:754](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9966
9988
|
|
|
9967
9989
|
> **lPush**(`key`, `values`): `Promise`\<`number` \| `false`\>
|
|
9968
9990
|
|
|
9969
|
-
Defined in: [lib/kv.ts:
|
|
9991
|
+
Defined in: [lib/kv.ts:736](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L736)
|
|
9970
9992
|
|
|
9971
9993
|
#### Parameters
|
|
9972
9994
|
|
|
@@ -9988,7 +10010,7 @@ Defined in: [lib/kv.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9988
10010
|
|
|
9989
10011
|
> **lRange**(`key`, `start`, `stop`): `Promise`\<`false` \| `string`[]\>
|
|
9990
10012
|
|
|
9991
|
-
Defined in: [lib/kv.ts:
|
|
10013
|
+
Defined in: [lib/kv.ts:817](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L817)
|
|
9992
10014
|
|
|
9993
10015
|
#### Parameters
|
|
9994
10016
|
|
|
@@ -10058,7 +10080,7 @@ key / val 数组
|
|
|
10058
10080
|
|
|
10059
10081
|
> **ping**(): `Promise`\<`string` \| `false`\>
|
|
10060
10082
|
|
|
10061
|
-
Defined in: [lib/kv.ts:
|
|
10083
|
+
Defined in: [lib/kv.ts:520](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L520)
|
|
10062
10084
|
|
|
10063
10085
|
发送 ping
|
|
10064
10086
|
|
|
@@ -10166,7 +10188,7 @@ Defined in: [lib/kv.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10166
10188
|
|
|
10167
10189
|
> **rPop**(`key`): `Promise`\<`string` \| `false` \| `null`\>
|
|
10168
10190
|
|
|
10169
|
-
Defined in: [lib/kv.ts:
|
|
10191
|
+
Defined in: [lib/kv.ts:788](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L788)
|
|
10170
10192
|
|
|
10171
10193
|
#### Parameters
|
|
10172
10194
|
|
|
@@ -10184,7 +10206,7 @@ Defined in: [lib/kv.ts:767](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10184
10206
|
|
|
10185
10207
|
> **rPush**(`key`, `values`): `Promise`\<`number` \| `false`\>
|
|
10186
10208
|
|
|
10187
|
-
Defined in: [lib/kv.ts:
|
|
10209
|
+
Defined in: [lib/kv.ts:749](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L749)
|
|
10188
10210
|
|
|
10189
10211
|
#### Parameters
|
|
10190
10212
|
|
|
@@ -10206,7 +10228,7 @@ Defined in: [lib/kv.ts:728](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10206
10228
|
|
|
10207
10229
|
> **scan**(`cursor?`, `pattern?`, `count?`): `Promise`\<`false` \| `IScanResult`\<`string`\>\>
|
|
10208
10230
|
|
|
10209
|
-
Defined in: [lib/kv.ts:
|
|
10231
|
+
Defined in: [lib/kv.ts:479](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L479)
|
|
10210
10232
|
|
|
10211
10233
|
根据条件获取服务器上的 keys
|
|
10212
10234
|
|
|
@@ -10298,7 +10320,7 @@ Defined in: [lib/kv.ts:235](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10298
10320
|
|
|
10299
10321
|
> **zAdd**(`key`, `score`, `member`): `Promise`\<`boolean`\>
|
|
10300
10322
|
|
|
10301
|
-
Defined in: [lib/kv.ts:
|
|
10323
|
+
Defined in: [lib/kv.ts:849](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L849)
|
|
10302
10324
|
|
|
10303
10325
|
添加有序集合元素(单个元素)
|
|
10304
10326
|
|
|
@@ -10330,7 +10352,7 @@ key 名
|
|
|
10330
10352
|
|
|
10331
10353
|
> **zAdd**(`key`, `elements`, `options`): `Promise`\<`number` \| `false`\>
|
|
10332
10354
|
|
|
10333
|
-
Defined in: [lib/kv.ts:
|
|
10355
|
+
Defined in: [lib/kv.ts:856](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L856)
|
|
10334
10356
|
|
|
10335
10357
|
添加有序集合元素(多个元素,含 INCR 选项)
|
|
10336
10358
|
|
|
@@ -10362,7 +10384,7 @@ key 名
|
|
|
10362
10384
|
|
|
10363
10385
|
> **zAdd**(`key`, `elements`, `options`): `Promise`\<`number` \| `false` \| `null`\>
|
|
10364
10386
|
|
|
10365
|
-
Defined in: [lib/kv.ts:
|
|
10387
|
+
Defined in: [lib/kv.ts:863](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L863)
|
|
10366
10388
|
|
|
10367
10389
|
添加有序集合元素(多个元素,含 INCR 选项,可空)
|
|
10368
10390
|
|
|
@@ -10394,7 +10416,7 @@ key 名
|
|
|
10394
10416
|
|
|
10395
10417
|
> **zAdd**(`key`, `elements`, `options?`): `Promise`\<`number` \| `false`\>
|
|
10396
10418
|
|
|
10397
|
-
Defined in: [lib/kv.ts:
|
|
10419
|
+
Defined in: [lib/kv.ts:870](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L870)
|
|
10398
10420
|
|
|
10399
10421
|
添加有序集合元素(多个元素)
|
|
10400
10422
|
|
|
@@ -10428,7 +10450,7 @@ key 名
|
|
|
10428
10450
|
|
|
10429
10451
|
> **zRangeWithScores**(`key`, `start`, `stop`, `options?`): `Promise`\<`false` \| `object`[]\>
|
|
10430
10452
|
|
|
10431
|
-
Defined in: [lib/kv.ts:
|
|
10453
|
+
Defined in: [lib/kv.ts:891](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L891)
|
|
10432
10454
|
|
|
10433
10455
|
#### Parameters
|
|
10434
10456
|
|
|
@@ -10458,7 +10480,7 @@ Defined in: [lib/kv.ts:870](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10458
10480
|
|
|
10459
10481
|
> **zRem**(`key`, `members`): `Promise`\<`number` \| `false`\>
|
|
10460
10482
|
|
|
10461
|
-
Defined in: [lib/kv.ts:
|
|
10483
|
+
Defined in: [lib/kv.ts:916](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L916)
|
|
10462
10484
|
|
|
10463
10485
|
#### Parameters
|
|
10464
10486
|
|
|
@@ -10487,7 +10509,7 @@ lib/kv/functions/get.md
|
|
|
10487
10509
|
|
|
10488
10510
|
> **get**(`ctrEtc`, `oetc?`): [`Kv`](../classes/Kv.md)
|
|
10489
10511
|
|
|
10490
|
-
Defined in: [lib/kv.ts:
|
|
10512
|
+
Defined in: [lib/kv.ts:977](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L977)
|
|
10491
10513
|
|
|
10492
10514
|
获取 Kv 对象
|
|
10493
10515
|
|
|
@@ -10554,7 +10576,7 @@ lib/kv/interfaces/IConnectionInfo.md
|
|
|
10554
10576
|
|
|
10555
10577
|
# Interface: IConnectionInfo
|
|
10556
10578
|
|
|
10557
|
-
Defined in: [lib/kv.ts:
|
|
10579
|
+
Defined in: [lib/kv.ts:993](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L993)
|
|
10558
10580
|
|
|
10559
10581
|
连接信息
|
|
10560
10582
|
|
|
@@ -10564,7 +10586,7 @@ Defined in: [lib/kv.ts:972](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10564
10586
|
|
|
10565
10587
|
> **conn**: `ICommandClient`
|
|
10566
10588
|
|
|
10567
|
-
Defined in: [lib/kv.ts:
|
|
10589
|
+
Defined in: [lib/kv.ts:997](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L997)
|
|
10568
10590
|
|
|
10569
10591
|
***
|
|
10570
10592
|
|
|
@@ -10572,7 +10594,7 @@ Defined in: [lib/kv.ts:976](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10572
10594
|
|
|
10573
10595
|
> **host**: `string`
|
|
10574
10596
|
|
|
10575
|
-
Defined in: [lib/kv.ts:
|
|
10597
|
+
Defined in: [lib/kv.ts:994](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L994)
|
|
10576
10598
|
|
|
10577
10599
|
***
|
|
10578
10600
|
|
|
@@ -10580,7 +10602,7 @@ Defined in: [lib/kv.ts:973](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10580
10602
|
|
|
10581
10603
|
> **index**: `number`
|
|
10582
10604
|
|
|
10583
|
-
Defined in: [lib/kv.ts:
|
|
10605
|
+
Defined in: [lib/kv.ts:996](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L996)
|
|
10584
10606
|
|
|
10585
10607
|
***
|
|
10586
10608
|
|
|
@@ -10588,7 +10610,7 @@ Defined in: [lib/kv.ts:975](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10588
10610
|
|
|
10589
10611
|
> **port**: `number`
|
|
10590
10612
|
|
|
10591
|
-
Defined in: [lib/kv.ts:
|
|
10613
|
+
Defined in: [lib/kv.ts:995](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L995)
|
|
10592
10614
|
|
|
10593
10615
|
lib/kv/interfaces/IZRangeOptions.md
|
|
10594
10616
|
---
|
|
@@ -10803,201 +10825,6 @@ lib/lan/index.md
|
|
|
10803
10825
|
- [card](functions/card.md)
|
|
10804
10826
|
- [scan](functions/scan.md)
|
|
10805
10827
|
|
|
10806
|
-
lib/net/formdata/classes/FormData.md
|
|
10807
|
-
---
|
|
10808
|
-
|
|
10809
|
-
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
10810
|
-
|
|
10811
|
-
***
|
|
10812
|
-
|
|
10813
|
-
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/formdata](../index.md) / FormData
|
|
10814
|
-
|
|
10815
|
-
# Class: FormData
|
|
10816
|
-
|
|
10817
|
-
Defined in: [lib/net/formdata.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L37)
|
|
10818
|
-
|
|
10819
|
-
## Extends
|
|
10820
|
-
|
|
10821
|
-
- `Readable`
|
|
10822
|
-
|
|
10823
|
-
## Constructors
|
|
10824
|
-
|
|
10825
|
-
### Constructor
|
|
10826
|
-
|
|
10827
|
-
> **new FormData**(`options?`): `FormData`
|
|
10828
|
-
|
|
10829
|
-
Defined in: node\_modules/@types/node/stream.d.ts:81
|
|
10830
|
-
|
|
10831
|
-
#### Parameters
|
|
10832
|
-
|
|
10833
|
-
##### options?
|
|
10834
|
-
|
|
10835
|
-
`ReadableOptions`\<`Readable`\>
|
|
10836
|
-
|
|
10837
|
-
#### Returns
|
|
10838
|
-
|
|
10839
|
-
`FormData`
|
|
10840
|
-
|
|
10841
|
-
#### Inherited from
|
|
10842
|
-
|
|
10843
|
-
`stream.Readable.constructor`
|
|
10844
|
-
|
|
10845
|
-
## Methods
|
|
10846
|
-
|
|
10847
|
-
### \_read()
|
|
10848
|
-
|
|
10849
|
-
> **\_read**(): `void`
|
|
10850
|
-
|
|
10851
|
-
Defined in: [lib/net/formdata.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L146)
|
|
10852
|
-
|
|
10853
|
-
间隔读取(on data 或 pipe 触发)
|
|
10854
|
-
|
|
10855
|
-
#### Returns
|
|
10856
|
-
|
|
10857
|
-
`void`
|
|
10858
|
-
|
|
10859
|
-
#### Overrides
|
|
10860
|
-
|
|
10861
|
-
`stream.Readable._read`
|
|
10862
|
-
|
|
10863
|
-
***
|
|
10864
|
-
|
|
10865
|
-
### getBoundary()
|
|
10866
|
-
|
|
10867
|
-
> **getBoundary**(): `string`
|
|
10868
|
-
|
|
10869
|
-
Defined in: [lib/net/formdata.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L124)
|
|
10870
|
-
|
|
10871
|
-
获取 boundary
|
|
10872
|
-
|
|
10873
|
-
#### Returns
|
|
10874
|
-
|
|
10875
|
-
`string`
|
|
10876
|
-
|
|
10877
|
-
***
|
|
10878
|
-
|
|
10879
|
-
### getLength()
|
|
10880
|
-
|
|
10881
|
-
> **getLength**(): `number`
|
|
10882
|
-
|
|
10883
|
-
Defined in: [lib/net/formdata.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L131)
|
|
10884
|
-
|
|
10885
|
-
获取总字节长度
|
|
10886
|
-
|
|
10887
|
-
#### Returns
|
|
10888
|
-
|
|
10889
|
-
`number`
|
|
10890
|
-
|
|
10891
|
-
***
|
|
10892
|
-
|
|
10893
|
-
### getSent()
|
|
10894
|
-
|
|
10895
|
-
> **getSent**(): `number`
|
|
10896
|
-
|
|
10897
|
-
Defined in: [lib/net/formdata.ts:138](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L138)
|
|
10898
|
-
|
|
10899
|
-
获取已发送的字节长度
|
|
10900
|
-
|
|
10901
|
-
#### Returns
|
|
10902
|
-
|
|
10903
|
-
`number`
|
|
10904
|
-
|
|
10905
|
-
***
|
|
10906
|
-
|
|
10907
|
-
### putBuffer()
|
|
10908
|
-
|
|
10909
|
-
> **putBuffer**(`key`, `buffer`, `fname`): `void`
|
|
10910
|
-
|
|
10911
|
-
Defined in: [lib/net/formdata.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L109)
|
|
10912
|
-
|
|
10913
|
-
添加 Buffer 数据
|
|
10914
|
-
|
|
10915
|
-
#### Parameters
|
|
10916
|
-
|
|
10917
|
-
##### key
|
|
10918
|
-
|
|
10919
|
-
`string`
|
|
10920
|
-
|
|
10921
|
-
键
|
|
10922
|
-
|
|
10923
|
-
##### buffer
|
|
10924
|
-
|
|
10925
|
-
`Buffer`
|
|
10926
|
-
|
|
10927
|
-
Buffer 数据
|
|
10928
|
-
|
|
10929
|
-
##### fname
|
|
10930
|
-
|
|
10931
|
-
`string`
|
|
10932
|
-
|
|
10933
|
-
文件名
|
|
10934
|
-
|
|
10935
|
-
#### Returns
|
|
10936
|
-
|
|
10937
|
-
`void`
|
|
10938
|
-
|
|
10939
|
-
***
|
|
10940
|
-
|
|
10941
|
-
### putFile()
|
|
10942
|
-
|
|
10943
|
-
> **putFile**(`key`, `path`, `fname?`): `Promise`\<`boolean`\>
|
|
10944
|
-
|
|
10945
|
-
Defined in: [lib/net/formdata.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L81)
|
|
10946
|
-
|
|
10947
|
-
添加文件
|
|
10948
|
-
|
|
10949
|
-
#### Parameters
|
|
10950
|
-
|
|
10951
|
-
##### key
|
|
10952
|
-
|
|
10953
|
-
`string`
|
|
10954
|
-
|
|
10955
|
-
键
|
|
10956
|
-
|
|
10957
|
-
##### path
|
|
10958
|
-
|
|
10959
|
-
`string`
|
|
10960
|
-
|
|
10961
|
-
路径
|
|
10962
|
-
|
|
10963
|
-
##### fname?
|
|
10964
|
-
|
|
10965
|
-
`string`
|
|
10966
|
-
|
|
10967
|
-
可选,文件名
|
|
10968
|
-
|
|
10969
|
-
#### Returns
|
|
10970
|
-
|
|
10971
|
-
`Promise`\<`boolean`\>
|
|
10972
|
-
|
|
10973
|
-
***
|
|
10974
|
-
|
|
10975
|
-
### putString()
|
|
10976
|
-
|
|
10977
|
-
> **putString**(`key`, `val`): `void`
|
|
10978
|
-
|
|
10979
|
-
Defined in: [lib/net/formdata.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L65)
|
|
10980
|
-
|
|
10981
|
-
添加字符串
|
|
10982
|
-
|
|
10983
|
-
#### Parameters
|
|
10984
|
-
|
|
10985
|
-
##### key
|
|
10986
|
-
|
|
10987
|
-
`string`
|
|
10988
|
-
|
|
10989
|
-
键
|
|
10990
|
-
|
|
10991
|
-
##### val
|
|
10992
|
-
|
|
10993
|
-
`string`
|
|
10994
|
-
|
|
10995
|
-
值
|
|
10996
|
-
|
|
10997
|
-
#### Returns
|
|
10998
|
-
|
|
10999
|
-
`void`
|
|
11000
|
-
|
|
11001
10828
|
lib/net/formdata/index.md
|
|
11002
10829
|
---
|
|
11003
10830
|
|
|
@@ -11009,112 +10836,17 @@ lib/net/formdata/index.md
|
|
|
11009
10836
|
|
|
11010
10837
|
# lib/net/formdata
|
|
11011
10838
|
|
|
11012
|
-
##
|
|
11013
|
-
|
|
11014
|
-
- [FormData](classes/FormData.md)
|
|
11015
|
-
|
|
11016
|
-
## Type Aliases
|
|
11017
|
-
|
|
11018
|
-
- [IItem](type-aliases/IItem.md)
|
|
11019
|
-
|
|
11020
|
-
lib/net/formdata/type-aliases/IItem.md
|
|
11021
|
-
---
|
|
11022
|
-
|
|
11023
|
-
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
11024
|
-
|
|
11025
|
-
***
|
|
11026
|
-
|
|
11027
|
-
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/formdata](../index.md) / IItem
|
|
11028
|
-
|
|
11029
|
-
# Type Alias: IItem
|
|
11030
|
-
|
|
11031
|
-
> **IItem** = \{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \} \| \{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \} \| \{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
11032
|
-
|
|
11033
|
-
Defined in: [lib/net/formdata.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L12)
|
|
11034
|
-
|
|
11035
|
-
Item 对象
|
|
11036
|
-
|
|
11037
|
-
## Union Members
|
|
11038
|
-
|
|
11039
|
-
### Type Literal
|
|
11040
|
-
|
|
11041
|
-
\{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \}
|
|
11042
|
-
|
|
11043
|
-
#### key
|
|
11044
|
-
|
|
11045
|
-
> **key**: `string`
|
|
11046
|
-
|
|
11047
|
-
key 键
|
|
11048
|
-
|
|
11049
|
-
#### path
|
|
11050
|
-
|
|
11051
|
-
> **path**: `""`
|
|
11052
|
-
|
|
11053
|
-
#### type
|
|
11054
|
-
|
|
11055
|
-
> **type**: `"string"`
|
|
11056
|
-
|
|
11057
|
-
#### value
|
|
11058
|
-
|
|
11059
|
-
> **value**: `string`
|
|
11060
|
-
|
|
11061
|
-
字符串值
|
|
11062
|
-
|
|
11063
|
-
***
|
|
11064
|
-
|
|
11065
|
-
### Type Literal
|
|
11066
|
-
|
|
11067
|
-
\{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \}
|
|
11068
|
-
|
|
11069
|
-
#### key
|
|
11070
|
-
|
|
11071
|
-
> **key**: `string`
|
|
11072
|
-
|
|
11073
|
-
key 键
|
|
11074
|
-
|
|
11075
|
-
#### path
|
|
11076
|
-
|
|
11077
|
-
> **path**: `string`
|
|
11078
|
-
|
|
11079
|
-
文件路径
|
|
11080
|
-
|
|
11081
|
-
#### type
|
|
11082
|
-
|
|
11083
|
-
> **type**: `"file"`
|
|
11084
|
-
|
|
11085
|
-
#### value
|
|
10839
|
+
## References
|
|
11086
10840
|
|
|
11087
|
-
|
|
10841
|
+
### FormData
|
|
11088
10842
|
|
|
11089
|
-
|
|
10843
|
+
Re-exports [FormData](../../undici/formdata/classes/FormData.md)
|
|
11090
10844
|
|
|
11091
10845
|
***
|
|
11092
10846
|
|
|
11093
|
-
###
|
|
11094
|
-
|
|
11095
|
-
\{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
11096
|
-
|
|
11097
|
-
#### key
|
|
11098
|
-
|
|
11099
|
-
> **key**: `string`
|
|
11100
|
-
|
|
11101
|
-
key 键
|
|
11102
|
-
|
|
11103
|
-
#### path
|
|
11104
|
-
|
|
11105
|
-
> **path**: `Buffer`
|
|
11106
|
-
|
|
11107
|
-
Buffer 数据
|
|
11108
|
-
|
|
11109
|
-
#### type
|
|
11110
|
-
|
|
11111
|
-
> **type**: `"buffer"`
|
|
11112
|
-
|
|
11113
|
-
#### value
|
|
11114
|
-
|
|
11115
|
-
> **value**: `string`
|
|
10847
|
+
### IItem
|
|
11116
10848
|
|
|
11117
|
-
|
|
10849
|
+
Re-exports [IItem](../../undici/formdata/type-aliases/IItem.md)
|
|
11118
10850
|
|
|
11119
10851
|
lib/net/functions/fetch.md
|
|
11120
10852
|
---
|
|
@@ -11164,7 +10896,7 @@ lib/net/functions/filterHeaders.md
|
|
|
11164
10896
|
|
|
11165
10897
|
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
11166
10898
|
|
|
11167
|
-
Defined in: [lib/net.ts:
|
|
10899
|
+
Defined in: [lib/net.ts:547](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L547)
|
|
11168
10900
|
|
|
11169
10901
|
剔除不代理的 header,返回新的 header
|
|
11170
10902
|
|
|
@@ -11224,15 +10956,15 @@ lib/net/functions/getFormData.md
|
|
|
11224
10956
|
|
|
11225
10957
|
# Function: getFormData()
|
|
11226
10958
|
|
|
11227
|
-
> **getFormData**(): [`FormData`](
|
|
10959
|
+
> **getFormData**(): [`FormData`](../../undici/formdata/classes/FormData.md)
|
|
11228
10960
|
|
|
11229
|
-
Defined in: [lib/net.ts:
|
|
10961
|
+
Defined in: [lib/net.ts:531](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L531)
|
|
11230
10962
|
|
|
11231
10963
|
创建 FormData 对象
|
|
11232
10964
|
|
|
11233
10965
|
## Returns
|
|
11234
10966
|
|
|
11235
|
-
[`FormData`](
|
|
10967
|
+
[`FormData`](../../undici/formdata/classes/FormData.md)
|
|
11236
10968
|
|
|
11237
10969
|
lib/net/functions/get.md
|
|
11238
10970
|
---
|
|
@@ -11319,7 +11051,7 @@ lib/net/functions/mproxyData.md
|
|
|
11319
11051
|
|
|
11320
11052
|
> **mproxyData**(`ctr`): `any`
|
|
11321
11053
|
|
|
11322
|
-
Defined in: [lib/net.ts:
|
|
11054
|
+
Defined in: [lib/net.ts:635](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L635)
|
|
11323
11055
|
|
|
11324
11056
|
获取 mproxy 的附加数据
|
|
11325
11057
|
|
|
@@ -11348,7 +11080,7 @@ lib/net/functions/mproxy.md
|
|
|
11348
11080
|
|
|
11349
11081
|
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
11350
11082
|
|
|
11351
|
-
Defined in: [lib/net.ts:
|
|
11083
|
+
Defined in: [lib/net.ts:583](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L583)
|
|
11352
11084
|
|
|
11353
11085
|
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
11354
11086
|
get: url, auth
|
|
@@ -11622,7 +11354,7 @@ lib/net/functions/rproxy.md
|
|
|
11622
11354
|
|
|
11623
11355
|
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
11624
11356
|
|
|
11625
|
-
Defined in: [lib/net.ts:
|
|
11357
|
+
Defined in: [lib/net.ts:653](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L653)
|
|
11626
11358
|
|
|
11627
11359
|
反向代理,注意提前处理不要自动处理 post 数据,将本服务器的某个路由反代到其他网址
|
|
11628
11360
|
|
|
@@ -11700,7 +11432,7 @@ lib/net/interfaces/IMproxyOptions.md
|
|
|
11700
11432
|
|
|
11701
11433
|
# Interface: IMproxyOptions
|
|
11702
11434
|
|
|
11703
|
-
Defined in: [lib/net.ts:
|
|
11435
|
+
Defined in: [lib/net.ts:737](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L737)
|
|
11704
11436
|
|
|
11705
11437
|
正向代理请求的传入参数选项
|
|
11706
11438
|
|
|
@@ -11710,7 +11442,7 @@ Defined in: [lib/net.ts:723](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11710
11442
|
|
|
11711
11443
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
11712
11444
|
|
|
11713
|
-
Defined in: [lib/net.ts:
|
|
11445
|
+
Defined in: [lib/net.ts:746](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L746)
|
|
11714
11446
|
|
|
11715
11447
|
过滤 header,返回 true 则留下
|
|
11716
11448
|
|
|
@@ -11730,7 +11462,7 @@ Defined in: [lib/net.ts:732](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11730
11462
|
|
|
11731
11463
|
> `optional` **follow?**: `number`
|
|
11732
11464
|
|
|
11733
|
-
Defined in: [lib/net.ts:
|
|
11465
|
+
Defined in: [lib/net.ts:740](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L740)
|
|
11734
11466
|
|
|
11735
11467
|
***
|
|
11736
11468
|
|
|
@@ -11738,7 +11470,7 @@ Defined in: [lib/net.ts:726](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11738
11470
|
|
|
11739
11471
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11740
11472
|
|
|
11741
|
-
Defined in: [lib/net.ts:
|
|
11473
|
+
Defined in: [lib/net.ts:744](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L744)
|
|
11742
11474
|
|
|
11743
11475
|
***
|
|
11744
11476
|
|
|
@@ -11746,7 +11478,7 @@ Defined in: [lib/net.ts:730](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11746
11478
|
|
|
11747
11479
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11748
11480
|
|
|
11749
|
-
Defined in: [lib/net.ts:
|
|
11481
|
+
Defined in: [lib/net.ts:742](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L742)
|
|
11750
11482
|
|
|
11751
11483
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11752
11484
|
|
|
@@ -11756,7 +11488,7 @@ Defined in: [lib/net.ts:728](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11756
11488
|
|
|
11757
11489
|
> `optional` **local?**: `string`
|
|
11758
11490
|
|
|
11759
|
-
Defined in: [lib/net.ts:
|
|
11491
|
+
Defined in: [lib/net.ts:743](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L743)
|
|
11760
11492
|
|
|
11761
11493
|
***
|
|
11762
11494
|
|
|
@@ -11764,7 +11496,7 @@ Defined in: [lib/net.ts:729](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11764
11496
|
|
|
11765
11497
|
> `optional` **reuse?**: `string`
|
|
11766
11498
|
|
|
11767
|
-
Defined in: [lib/net.ts:
|
|
11499
|
+
Defined in: [lib/net.ts:748](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L748)
|
|
11768
11500
|
|
|
11769
11501
|
默认为 default
|
|
11770
11502
|
|
|
@@ -11774,7 +11506,7 @@ Defined in: [lib/net.ts:734](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11774
11506
|
|
|
11775
11507
|
> `optional` **timeout?**: `number`
|
|
11776
11508
|
|
|
11777
|
-
Defined in: [lib/net.ts:
|
|
11509
|
+
Defined in: [lib/net.ts:739](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L739)
|
|
11778
11510
|
|
|
11779
11511
|
秒数
|
|
11780
11512
|
|
|
@@ -11789,7 +11521,7 @@ lib/net/interfaces/IRequestOptions.md
|
|
|
11789
11521
|
|
|
11790
11522
|
# Interface: IRequestOptions
|
|
11791
11523
|
|
|
11792
|
-
Defined in: [lib/net.ts:
|
|
11524
|
+
Defined in: [lib/net.ts:706](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L706)
|
|
11793
11525
|
|
|
11794
11526
|
请求的传入参数选项
|
|
11795
11527
|
|
|
@@ -11799,7 +11531,7 @@ Defined in: [lib/net.ts:692](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11799
11531
|
|
|
11800
11532
|
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
11801
11533
|
|
|
11802
|
-
Defined in: [lib/net.ts:
|
|
11534
|
+
Defined in: [lib/net.ts:731](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L731)
|
|
11803
11535
|
|
|
11804
11536
|
cookie 托管对象
|
|
11805
11537
|
|
|
@@ -11809,7 +11541,7 @@ cookie 托管对象
|
|
|
11809
11541
|
|
|
11810
11542
|
> `optional` **follow?**: `number`
|
|
11811
11543
|
|
|
11812
|
-
Defined in: [lib/net.ts:
|
|
11544
|
+
Defined in: [lib/net.ts:712](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L712)
|
|
11813
11545
|
|
|
11814
11546
|
追踪 location 次数,0 为不追踪,默认为 0
|
|
11815
11547
|
|
|
@@ -11819,7 +11551,7 @@ Defined in: [lib/net.ts:698](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11819
11551
|
|
|
11820
11552
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11821
11553
|
|
|
11822
|
-
Defined in: [lib/net.ts:
|
|
11554
|
+
Defined in: [lib/net.ts:717](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L717)
|
|
11823
11555
|
|
|
11824
11556
|
***
|
|
11825
11557
|
|
|
@@ -11827,7 +11559,7 @@ Defined in: [lib/net.ts:703](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11827
11559
|
|
|
11828
11560
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11829
11561
|
|
|
11830
|
-
Defined in: [lib/net.ts:
|
|
11562
|
+
Defined in: [lib/net.ts:714](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L714)
|
|
11831
11563
|
|
|
11832
11564
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11833
11565
|
|
|
@@ -11837,7 +11569,7 @@ Defined in: [lib/net.ts:700](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11837
11569
|
|
|
11838
11570
|
> `optional` **keep?**: `boolean`
|
|
11839
11571
|
|
|
11840
|
-
Defined in: [lib/net.ts:
|
|
11572
|
+
Defined in: [lib/net.ts:727](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L727)
|
|
11841
11573
|
|
|
11842
11574
|
连接是否保持长连接(即是否允许复用),默认为 true
|
|
11843
11575
|
|
|
@@ -11847,7 +11579,7 @@ Defined in: [lib/net.ts:713](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11847
11579
|
|
|
11848
11580
|
> `optional` **local?**: `string`
|
|
11849
11581
|
|
|
11850
|
-
Defined in: [lib/net.ts:
|
|
11582
|
+
Defined in: [lib/net.ts:716](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L716)
|
|
11851
11583
|
|
|
11852
11584
|
***
|
|
11853
11585
|
|
|
@@ -11855,7 +11587,7 @@ Defined in: [lib/net.ts:702](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11855
11587
|
|
|
11856
11588
|
> `optional` **log?**: `boolean`
|
|
11857
11589
|
|
|
11858
|
-
Defined in: [lib/net.ts:
|
|
11590
|
+
Defined in: [lib/net.ts:733](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L733)
|
|
11859
11591
|
|
|
11860
11592
|
若有异常写入文件日志,默认为 true
|
|
11861
11593
|
|
|
@@ -11865,7 +11597,7 @@ Defined in: [lib/net.ts:719](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11865
11597
|
|
|
11866
11598
|
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
11867
11599
|
|
|
11868
|
-
Defined in: [lib/net.ts:
|
|
11600
|
+
Defined in: [lib/net.ts:707](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L707)
|
|
11869
11601
|
|
|
11870
11602
|
***
|
|
11871
11603
|
|
|
@@ -11873,7 +11605,7 @@ Defined in: [lib/net.ts:693](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11873
11605
|
|
|
11874
11606
|
> `optional` **mproxy?**: `object`
|
|
11875
11607
|
|
|
11876
|
-
Defined in: [lib/net.ts:
|
|
11608
|
+
Defined in: [lib/net.ts:719](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L719)
|
|
11877
11609
|
|
|
11878
11610
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
11879
11611
|
|
|
@@ -11901,7 +11633,7 @@ Defined in: [lib/net.ts:705](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11901
11633
|
|
|
11902
11634
|
> `optional` **reuse?**: `string`
|
|
11903
11635
|
|
|
11904
|
-
Defined in: [lib/net.ts:
|
|
11636
|
+
Defined in: [lib/net.ts:729](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L729)
|
|
11905
11637
|
|
|
11906
11638
|
复用池名,默认为 default
|
|
11907
11639
|
|
|
@@ -11911,7 +11643,7 @@ Defined in: [lib/net.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11911
11643
|
|
|
11912
11644
|
> `optional` **save?**: `string`
|
|
11913
11645
|
|
|
11914
|
-
Defined in: [lib/net.ts:
|
|
11646
|
+
Defined in: [lib/net.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L715)
|
|
11915
11647
|
|
|
11916
11648
|
***
|
|
11917
11649
|
|
|
@@ -11919,7 +11651,7 @@ Defined in: [lib/net.ts:701](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11919
11651
|
|
|
11920
11652
|
> `optional` **timeout?**: `number`
|
|
11921
11653
|
|
|
11922
|
-
Defined in: [lib/net.ts:
|
|
11654
|
+
Defined in: [lib/net.ts:710](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L710)
|
|
11923
11655
|
|
|
11924
11656
|
秒数,默认 10 秒
|
|
11925
11657
|
|
|
@@ -11929,7 +11661,7 @@ Defined in: [lib/net.ts:696](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11929
11661
|
|
|
11930
11662
|
> `optional` **type?**: `"form"` \| `"json"`
|
|
11931
11663
|
|
|
11932
|
-
Defined in: [lib/net.ts:
|
|
11664
|
+
Defined in: [lib/net.ts:708](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L708)
|
|
11933
11665
|
|
|
11934
11666
|
lib/net/interfaces/IRproxyOptions.md
|
|
11935
11667
|
---
|
|
@@ -11942,7 +11674,7 @@ lib/net/interfaces/IRproxyOptions.md
|
|
|
11942
11674
|
|
|
11943
11675
|
# Interface: IRproxyOptions
|
|
11944
11676
|
|
|
11945
|
-
Defined in: [lib/net.ts:
|
|
11677
|
+
Defined in: [lib/net.ts:752](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L752)
|
|
11946
11678
|
|
|
11947
11679
|
反向代理请求的传入参数选项
|
|
11948
11680
|
|
|
@@ -11952,7 +11684,7 @@ Defined in: [lib/net.ts:738](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11952
11684
|
|
|
11953
11685
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
11954
11686
|
|
|
11955
|
-
Defined in: [lib/net.ts:
|
|
11687
|
+
Defined in: [lib/net.ts:761](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L761)
|
|
11956
11688
|
|
|
11957
11689
|
过滤 header,返回 true 则留下
|
|
11958
11690
|
|
|
@@ -11972,7 +11704,7 @@ Defined in: [lib/net.ts:747](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11972
11704
|
|
|
11973
11705
|
> `optional` **follow?**: `number`
|
|
11974
11706
|
|
|
11975
|
-
Defined in: [lib/net.ts:
|
|
11707
|
+
Defined in: [lib/net.ts:755](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L755)
|
|
11976
11708
|
|
|
11977
11709
|
***
|
|
11978
11710
|
|
|
@@ -11980,7 +11712,7 @@ Defined in: [lib/net.ts:741](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11980
11712
|
|
|
11981
11713
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11982
11714
|
|
|
11983
|
-
Defined in: [lib/net.ts:
|
|
11715
|
+
Defined in: [lib/net.ts:759](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L759)
|
|
11984
11716
|
|
|
11985
11717
|
***
|
|
11986
11718
|
|
|
@@ -11988,7 +11720,7 @@ Defined in: [lib/net.ts:745](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11988
11720
|
|
|
11989
11721
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11990
11722
|
|
|
11991
|
-
Defined in: [lib/net.ts:
|
|
11723
|
+
Defined in: [lib/net.ts:757](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L757)
|
|
11992
11724
|
|
|
11993
11725
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11994
11726
|
|
|
@@ -11998,7 +11730,7 @@ Defined in: [lib/net.ts:743](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11998
11730
|
|
|
11999
11731
|
> `optional` **local?**: `string`
|
|
12000
11732
|
|
|
12001
|
-
Defined in: [lib/net.ts:
|
|
11733
|
+
Defined in: [lib/net.ts:758](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L758)
|
|
12002
11734
|
|
|
12003
11735
|
***
|
|
12004
11736
|
|
|
@@ -12006,7 +11738,7 @@ Defined in: [lib/net.ts:744](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12006
11738
|
|
|
12007
11739
|
> `optional` **mproxy?**: `object`
|
|
12008
11740
|
|
|
12009
|
-
Defined in: [lib/net.ts:
|
|
11741
|
+
Defined in: [lib/net.ts:763](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L763)
|
|
12010
11742
|
|
|
12011
11743
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
12012
11744
|
|
|
@@ -12034,7 +11766,7 @@ Defined in: [lib/net.ts:749](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12034
11766
|
|
|
12035
11767
|
> `optional` **reuse?**: `string`
|
|
12036
11768
|
|
|
12037
|
-
Defined in: [lib/net.ts:
|
|
11769
|
+
Defined in: [lib/net.ts:771](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L771)
|
|
12038
11770
|
|
|
12039
11771
|
默认为 default
|
|
12040
11772
|
|
|
@@ -12044,7 +11776,7 @@ Defined in: [lib/net.ts:757](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12044
11776
|
|
|
12045
11777
|
> `optional` **timeout?**: `number`
|
|
12046
11778
|
|
|
12047
|
-
Defined in: [lib/net.ts:
|
|
11779
|
+
Defined in: [lib/net.ts:754](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L754)
|
|
12048
11780
|
|
|
12049
11781
|
秒数
|
|
12050
11782
|
|
|
@@ -12505,7 +12237,7 @@ lib/net/type-aliases/THttpHeaders.md
|
|
|
12505
12237
|
|
|
12506
12238
|
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
12507
12239
|
|
|
12508
|
-
Defined in: [lib/net.ts:
|
|
12240
|
+
Defined in: [lib/net.ts:776](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L776)
|
|
12509
12241
|
|
|
12510
12242
|
http headers
|
|
12511
12243
|
|
|
@@ -13389,7 +13121,7 @@ Defined in: [lib/scan.ts:58](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13389
13121
|
|
|
13390
13122
|
> **createToken**(): `Promise`\<`boolean`\>
|
|
13391
13123
|
|
|
13392
|
-
Defined in: [lib/scan.ts:
|
|
13124
|
+
Defined in: [lib/scan.ts:171](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L171)
|
|
13393
13125
|
|
|
13394
13126
|
创建 token,直接应用到本类
|
|
13395
13127
|
|
|
@@ -13403,7 +13135,7 @@ Defined in: [lib/scan.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
13403
13135
|
|
|
13404
13136
|
> **getTimeLeft**(): `number` \| `null`
|
|
13405
13137
|
|
|
13406
|
-
Defined in: [lib/scan.ts:
|
|
13138
|
+
Defined in: [lib/scan.ts:238](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L238)
|
|
13407
13139
|
|
|
13408
13140
|
获取当前 token 可扫剩余有效期
|
|
13409
13141
|
|
|
@@ -13417,7 +13149,7 @@ Defined in: [lib/scan.ts:223](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
13417
13149
|
|
|
13418
13150
|
> **getToken**(): `string` \| `null`
|
|
13419
13151
|
|
|
13420
|
-
Defined in: [lib/scan.ts:
|
|
13152
|
+
Defined in: [lib/scan.ts:216](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L216)
|
|
13421
13153
|
|
|
13422
13154
|
获取当前 token
|
|
13423
13155
|
|
|
@@ -13431,7 +13163,7 @@ Defined in: [lib/scan.ts:201](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
13431
13163
|
|
|
13432
13164
|
> **getTTL**(): `number`
|
|
13433
13165
|
|
|
13434
|
-
Defined in: [lib/scan.ts:
|
|
13166
|
+
Defined in: [lib/scan.ts:231](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L231)
|
|
13435
13167
|
|
|
13436
13168
|
获取设置的有效期
|
|
13437
13169
|
|
|
@@ -13461,7 +13193,7 @@ Defined in: [lib/scan.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13461
13193
|
|
|
13462
13194
|
> **setTTL**(`ttl`): `void`
|
|
13463
13195
|
|
|
13464
|
-
Defined in: [lib/scan.ts:
|
|
13196
|
+
Defined in: [lib/scan.ts:224](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L224)
|
|
13465
13197
|
|
|
13466
13198
|
设置有效期,设置后的新 token 被创建有效
|
|
13467
13199
|
|
|
@@ -13488,7 +13220,7 @@ lib/scan/functions/get.md
|
|
|
13488
13220
|
|
|
13489
13221
|
> **get**(`link`, `token?`, `opt?`): `Promise`\<[`Scan`](../classes/Scan.md)\>
|
|
13490
13222
|
|
|
13491
|
-
Defined in: [lib/scan.ts:
|
|
13223
|
+
Defined in: [lib/scan.ts:266](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L266)
|
|
13492
13224
|
|
|
13493
13225
|
-- 创建 Scan 对象
|
|
13494
13226
|
|
|
@@ -13525,7 +13257,7 @@ lib/scan/functions/scanned.md
|
|
|
13525
13257
|
|
|
13526
13258
|
> **scanned**(`link`, `token`, `opt?`): `Promise`\<`boolean`\>
|
|
13527
13259
|
|
|
13528
|
-
Defined in: [lib/scan.ts:
|
|
13260
|
+
Defined in: [lib/scan.ts:280](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L280)
|
|
13529
13261
|
|
|
13530
13262
|
对 token 执行访问操作,通常用户扫码后展示的网页所调用,代表已扫码
|
|
13531
13263
|
|
|
@@ -13566,7 +13298,7 @@ lib/scan/functions/setData.md
|
|
|
13566
13298
|
|
|
13567
13299
|
> **setData**(`link`, `token`, `data`, `opt?`): `Promise`\<`boolean`\>
|
|
13568
13300
|
|
|
13569
|
-
Defined in: [lib/scan.ts:
|
|
13301
|
+
Defined in: [lib/scan.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L338)
|
|
13570
13302
|
|
|
13571
13303
|
将数据写入 token,通常在客户的逻辑下去写,服务器会 poll 到
|
|
13572
13304
|
|
|
@@ -13733,7 +13465,7 @@ Defined in: [lib/session.ts:51](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
13733
13465
|
|
|
13734
13466
|
> **getName**(): `string`
|
|
13735
13467
|
|
|
13736
|
-
Defined in: [lib/session.ts:
|
|
13468
|
+
Defined in: [lib/session.ts:226](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L226)
|
|
13737
13469
|
|
|
13738
13470
|
获取当前的 cookie 的 name 值
|
|
13739
13471
|
|
|
@@ -13747,7 +13479,7 @@ Defined in: [lib/session.ts:224](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
13747
13479
|
|
|
13748
13480
|
> **getToken**(): `string`
|
|
13749
13481
|
|
|
13750
|
-
Defined in: [lib/session.ts:
|
|
13482
|
+
Defined in: [lib/session.ts:219](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L219)
|
|
13751
13483
|
|
|
13752
13484
|
获取当前的 token 值
|
|
13753
13485
|
|
|
@@ -13803,7 +13535,7 @@ false 表示系统错误
|
|
|
13803
13535
|
|
|
13804
13536
|
> **update**(): `Promise`\<`void`\>
|
|
13805
13537
|
|
|
13806
|
-
Defined in: [lib/session.ts:
|
|
13538
|
+
Defined in: [lib/session.ts:233](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L233)
|
|
13807
13539
|
|
|
13808
13540
|
页面整体结束时,要写入到 Kv 或 数据库
|
|
13809
13541
|
|
|
@@ -16395,7 +16127,7 @@ lib/text/functions/csvescape.md
|
|
|
16395
16127
|
|
|
16396
16128
|
> **csvescape**(`str`): `string`
|
|
16397
16129
|
|
|
16398
|
-
Defined in: [lib/text.ts:
|
|
16130
|
+
Defined in: [lib/text.ts:547](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L547)
|
|
16399
16131
|
|
|
16400
16132
|
CSV 特殊字符转换为实体字符
|
|
16401
16133
|
|
|
@@ -16422,7 +16154,7 @@ lib/text/functions/getFileExt.md
|
|
|
16422
16154
|
|
|
16423
16155
|
> **getFileExt**(`path`): `string`
|
|
16424
16156
|
|
|
16425
|
-
Defined in: [lib/text.ts:
|
|
16157
|
+
Defined in: [lib/text.ts:588](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L588)
|
|
16426
16158
|
|
|
16427
16159
|
获取文件后缀
|
|
16428
16160
|
|
|
@@ -16451,7 +16183,7 @@ lib/text/functions/getFileNameExt.md
|
|
|
16451
16183
|
|
|
16452
16184
|
> **getFileNameExt**(`path`): `object`
|
|
16453
16185
|
|
|
16454
|
-
Defined in: [lib/text.ts:
|
|
16186
|
+
Defined in: [lib/text.ts:601](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L601)
|
|
16455
16187
|
|
|
16456
16188
|
获取文件名和后缀
|
|
16457
16189
|
|
|
@@ -16488,7 +16220,7 @@ lib/text/functions/getFilename.md
|
|
|
16488
16220
|
|
|
16489
16221
|
> **getFilename**(`path`, `ext?`): `string`
|
|
16490
16222
|
|
|
16491
|
-
Defined in: [lib/text.ts:
|
|
16223
|
+
Defined in: [lib/text.ts:568](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L568)
|
|
16492
16224
|
|
|
16493
16225
|
获取文件名
|
|
16494
16226
|
|
|
@@ -16523,7 +16255,7 @@ lib/text/functions/htmlescape.md
|
|
|
16523
16255
|
|
|
16524
16256
|
> **htmlescape**(`html`): `string`
|
|
16525
16257
|
|
|
16526
|
-
Defined in: [lib/text.ts:
|
|
16258
|
+
Defined in: [lib/text.ts:533](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L533)
|
|
16527
16259
|
|
|
16528
16260
|
HTML 特殊字符转换为实体字符
|
|
16529
16261
|
|
|
@@ -16552,7 +16284,7 @@ lib/text/functions/int2str.md
|
|
|
16552
16284
|
|
|
16553
16285
|
> **int2str**(`int`, `digits?`, `decimal?`): `string`
|
|
16554
16286
|
|
|
16555
|
-
Defined in: [lib/text.ts:
|
|
16287
|
+
Defined in: [lib/text.ts:801](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L801)
|
|
16556
16288
|
|
|
16557
16289
|
为解决精度问题,将整数转换为小数字符串
|
|
16558
16290
|
以下几个示例都是当 digits 为 3、decimal 为 2 时
|
|
@@ -16598,7 +16330,7 @@ lib/text/functions/isAscii.md
|
|
|
16598
16330
|
|
|
16599
16331
|
> **isAscii**(`text`): `boolean`
|
|
16600
16332
|
|
|
16601
|
-
Defined in: [lib/text.ts:
|
|
16333
|
+
Defined in: [lib/text.ts:291](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L291)
|
|
16602
16334
|
|
|
16603
16335
|
判断是否在 ascii 字符集内,仅可输入部分
|
|
16604
16336
|
|
|
@@ -16627,7 +16359,7 @@ lib/text/functions/isDomain.md
|
|
|
16627
16359
|
|
|
16628
16360
|
> **isDomain**(`domain`): `boolean`
|
|
16629
16361
|
|
|
16630
|
-
Defined in: [lib/text.ts:
|
|
16362
|
+
Defined in: [lib/text.ts:280](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L280)
|
|
16631
16363
|
|
|
16632
16364
|
判断是否是域名
|
|
16633
16365
|
|
|
@@ -16658,7 +16390,7 @@ lib/text/functions/isEMail.md
|
|
|
16658
16390
|
|
|
16659
16391
|
> **isEMail**(`email`): `boolean`
|
|
16660
16392
|
|
|
16661
|
-
Defined in: [lib/text.ts:
|
|
16393
|
+
Defined in: [lib/text.ts:253](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L253)
|
|
16662
16394
|
|
|
16663
16395
|
是否是邮件地址
|
|
16664
16396
|
|
|
@@ -16685,7 +16417,7 @@ lib/text/functions/isFalsy.md
|
|
|
16685
16417
|
|
|
16686
16418
|
> **isFalsy**(`val`): `val is TFalsy`
|
|
16687
16419
|
|
|
16688
|
-
Defined in: [lib/text.ts:
|
|
16420
|
+
Defined in: [lib/text.ts:752](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L752)
|
|
16689
16421
|
|
|
16690
16422
|
判断一个值是否是虚假的(为 null/undefined/空字符串/false/0)
|
|
16691
16423
|
|
|
@@ -16714,7 +16446,7 @@ lib/text/functions/isIdCardCN.md
|
|
|
16714
16446
|
|
|
16715
16447
|
> **isIdCardCN**(`idcard`): `boolean`
|
|
16716
16448
|
|
|
16717
|
-
Defined in: [lib/text.ts:
|
|
16449
|
+
Defined in: [lib/text.ts:403](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L403)
|
|
16718
16450
|
|
|
16719
16451
|
是否是中国大陆身份证号码
|
|
16720
16452
|
|
|
@@ -16743,7 +16475,7 @@ lib/text/functions/isIPv4.md
|
|
|
16743
16475
|
|
|
16744
16476
|
> **isIPv4**(`ip`): `boolean`
|
|
16745
16477
|
|
|
16746
|
-
Defined in: [lib/text.ts:
|
|
16478
|
+
Defined in: [lib/text.ts:261](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L261)
|
|
16747
16479
|
|
|
16748
16480
|
是否是 IPv4(基于 Node 原生 net.isIP,严格校验)
|
|
16749
16481
|
|
|
@@ -16770,7 +16502,7 @@ lib/text/functions/isIPv6.md
|
|
|
16770
16502
|
|
|
16771
16503
|
> **isIPv6**(`ip`): `boolean`
|
|
16772
16504
|
|
|
16773
|
-
Defined in: [lib/text.ts:
|
|
16505
|
+
Defined in: [lib/text.ts:269](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L269)
|
|
16774
16506
|
|
|
16775
16507
|
是否是 IPv6(基于 Node 原生 net.isIP,严格校验)
|
|
16776
16508
|
|
|
@@ -16797,7 +16529,7 @@ lib/text/functions/isPhoneCN.md
|
|
|
16797
16529
|
|
|
16798
16530
|
> **isPhoneCN**(`p`): `boolean`
|
|
16799
16531
|
|
|
16800
|
-
Defined in: [lib/text.ts:
|
|
16532
|
+
Defined in: [lib/text.ts:395](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L395)
|
|
16801
16533
|
|
|
16802
16534
|
判断手机号是否是 11 位,不做真实性校验
|
|
16803
16535
|
|
|
@@ -16826,7 +16558,7 @@ lib/text/functions/isRealPath.md
|
|
|
16826
16558
|
|
|
16827
16559
|
> **isRealPath**(`path`): `boolean`
|
|
16828
16560
|
|
|
16829
|
-
Defined in: [lib/text.ts:
|
|
16561
|
+
Defined in: [lib/text.ts:555](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L555)
|
|
16830
16562
|
|
|
16831
16563
|
判断是否是绝对路径,是返回 true,相对路径返回 false
|
|
16832
16564
|
|
|
@@ -16842,6 +16574,41 @@ Defined in: [lib/text.ts:519](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16842
16574
|
|
|
16843
16575
|
`boolean`
|
|
16844
16576
|
|
|
16577
|
+
lib/text/functions/isSameOrigin.md
|
|
16578
|
+
---
|
|
16579
|
+
|
|
16580
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
16581
|
+
|
|
16582
|
+
***
|
|
16583
|
+
|
|
16584
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / isSameOrigin
|
|
16585
|
+
|
|
16586
|
+
# Function: isSameOrigin()
|
|
16587
|
+
|
|
16588
|
+
> **isSameOrigin**(`from`, `to`): `boolean`
|
|
16589
|
+
|
|
16590
|
+
Defined in: [lib/text.ts:134](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L134)
|
|
16591
|
+
|
|
16592
|
+
判断两个 URL 是否属于同源地址
|
|
16593
|
+
|
|
16594
|
+
## Parameters
|
|
16595
|
+
|
|
16596
|
+
### from
|
|
16597
|
+
|
|
16598
|
+
`string`
|
|
16599
|
+
|
|
16600
|
+
来源 URL
|
|
16601
|
+
|
|
16602
|
+
### to
|
|
16603
|
+
|
|
16604
|
+
`string`
|
|
16605
|
+
|
|
16606
|
+
目标 URL
|
|
16607
|
+
|
|
16608
|
+
## Returns
|
|
16609
|
+
|
|
16610
|
+
`boolean`
|
|
16611
|
+
|
|
16845
16612
|
lib/text/functions/isTruthy.md
|
|
16846
16613
|
---
|
|
16847
16614
|
|
|
@@ -16855,7 +16622,7 @@ lib/text/functions/isTruthy.md
|
|
|
16855
16622
|
|
|
16856
16623
|
> **isTruthy**\<`T`\>(`val`): `val is Exclude<T, TFalsy>`
|
|
16857
16624
|
|
|
16858
|
-
Defined in: [lib/text.ts:
|
|
16625
|
+
Defined in: [lib/text.ts:760](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L760)
|
|
16859
16626
|
|
|
16860
16627
|
判断一个值是否是真实的(不为 null/undefined/空字符串/false/0)
|
|
16861
16628
|
|
|
@@ -16890,7 +16657,7 @@ lib/text/functions/logicalOr.md
|
|
|
16890
16657
|
|
|
16891
16658
|
> **logicalOr**\<`T`, `T2`\>(`v1`, `v2`): `T` *extends* [`TFalsy`](../type-aliases/TFalsy.md) ? `T2` : `T`
|
|
16892
16659
|
|
|
16893
|
-
Defined in: [lib/text.ts:
|
|
16660
|
+
Defined in: [lib/text.ts:769](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L769)
|
|
16894
16661
|
|
|
16895
16662
|
类似 || 运算符的效果
|
|
16896
16663
|
|
|
@@ -16935,7 +16702,7 @@ lib/text/functions/match.md
|
|
|
16935
16702
|
|
|
16936
16703
|
> **match**(`str`, `regs`): `boolean`
|
|
16937
16704
|
|
|
16938
|
-
Defined in: [lib/text.ts:
|
|
16705
|
+
Defined in: [lib/text.ts:380](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L380)
|
|
16939
16706
|
|
|
16940
16707
|
传入正则进行匹配 str 是否有一项满足
|
|
16941
16708
|
|
|
@@ -16970,7 +16737,7 @@ lib/text/functions/nlReplace.md
|
|
|
16970
16737
|
|
|
16971
16738
|
> **nlReplace**(`str`, `to?`): `string`
|
|
16972
16739
|
|
|
16973
|
-
Defined in: [lib/text.ts:
|
|
16740
|
+
Defined in: [lib/text.ts:300](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L300)
|
|
16974
16741
|
|
|
16975
16742
|
换行替换为别的
|
|
16976
16743
|
|
|
@@ -17005,7 +16772,7 @@ lib/text/functions/parseDomain.md
|
|
|
17005
16772
|
|
|
17006
16773
|
> **parseDomain**(`domain`): `Promise`\<[`IDomain`](../interfaces/IDomain.md)\>
|
|
17007
16774
|
|
|
17008
|
-
Defined in: [lib/text.ts:
|
|
16775
|
+
Defined in: [lib/text.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L323)
|
|
17009
16776
|
|
|
17010
16777
|
解析域名并获取 tld/sld/domain/sub
|
|
17011
16778
|
|
|
@@ -17075,7 +16842,7 @@ lib/text/functions/parseJson.md
|
|
|
17075
16842
|
|
|
17076
16843
|
> **parseJson**\<`T`\>(`str`): `false` \| `T`
|
|
17077
16844
|
|
|
17078
|
-
Defined in: [lib/text.ts:
|
|
16845
|
+
Defined in: [lib/text.ts:663](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L663)
|
|
17079
16846
|
|
|
17080
16847
|
将字符串解析为对象,返回 false 代表解析失败,支持 BigInt
|
|
17081
16848
|
|
|
@@ -17137,7 +16904,7 @@ lib/text/functions/queryParse.md
|
|
|
17137
16904
|
|
|
17138
16905
|
> **queryParse**(`query`): `Record`\<`string`, `string` \| `string`[]\>
|
|
17139
16906
|
|
|
17140
|
-
Defined in: [lib/text.ts:
|
|
16907
|
+
Defined in: [lib/text.ts:480](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L480)
|
|
17141
16908
|
|
|
17142
16909
|
将 query string 转换为对象
|
|
17143
16910
|
|
|
@@ -17168,7 +16935,7 @@ lib/text/functions/queryStringify.md
|
|
|
17168
16935
|
|
|
17169
16936
|
> **queryStringify**(`query`, `encode?`): `string`
|
|
17170
16937
|
|
|
17171
|
-
Defined in: [lib/text.ts:
|
|
16938
|
+
Defined in: [lib/text.ts:431](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L431)
|
|
17172
16939
|
|
|
17173
16940
|
将对象转换为 query string
|
|
17174
16941
|
|
|
@@ -17194,7 +16961,7 @@ Defined in: [lib/text.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17194
16961
|
|
|
17195
16962
|
> **queryStringify**(`query`, `options`): `string`
|
|
17196
16963
|
|
|
17197
|
-
Defined in: [lib/text.ts:
|
|
16964
|
+
Defined in: [lib/text.ts:437](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L437)
|
|
17198
16965
|
|
|
17199
16966
|
将对象转换为 query string
|
|
17200
16967
|
|
|
@@ -17274,7 +17041,7 @@ lib/text/functions/str2int.md
|
|
|
17274
17041
|
|
|
17275
17042
|
> **str2int**(`str`, `digits?`): `number`
|
|
17276
17043
|
|
|
17277
|
-
Defined in: [lib/text.ts:
|
|
17044
|
+
Defined in: [lib/text.ts:783](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L783)
|
|
17278
17045
|
|
|
17279
17046
|
为解决精度问题,将字符串数字转换为整数显示
|
|
17280
17047
|
以下几个示例都是当 digits 为 2 时
|
|
@@ -17314,7 +17081,7 @@ lib/text/functions/stringifyBuffer.md
|
|
|
17314
17081
|
|
|
17315
17082
|
> **stringifyBuffer**(`buf`): `string`
|
|
17316
17083
|
|
|
17317
|
-
Defined in: [lib/text.ts:
|
|
17084
|
+
Defined in: [lib/text.ts:706](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L706)
|
|
17318
17085
|
|
|
17319
17086
|
输出文本格式的 buffer
|
|
17320
17087
|
|
|
@@ -17343,7 +17110,7 @@ lib/text/functions/stringifyJson.md
|
|
|
17343
17110
|
|
|
17344
17111
|
> **stringifyJson**(`obj`, `space?`): `string`
|
|
17345
17112
|
|
|
17346
|
-
Defined in: [lib/text.ts:
|
|
17113
|
+
Defined in: [lib/text.ts:693](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L693)
|
|
17347
17114
|
|
|
17348
17115
|
将对象转换为 json 字符串,返回 false 代表解析失败,支持 BigInt
|
|
17349
17116
|
|
|
@@ -17378,7 +17145,7 @@ lib/text/functions/stringifyResult.md
|
|
|
17378
17145
|
|
|
17379
17146
|
> **stringifyResult**(`rtn`): `string`
|
|
17380
17147
|
|
|
17381
|
-
Defined in: [lib/text.ts:
|
|
17148
|
+
Defined in: [lib/text.ts:623](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L623)
|
|
17382
17149
|
|
|
17383
17150
|
将普通的返回 JSON 对象序列化为字符串
|
|
17384
17151
|
|
|
@@ -17407,7 +17174,7 @@ lib/text/functions/trimJson.md
|
|
|
17407
17174
|
|
|
17408
17175
|
> **trimJson**(`json`): `any`
|
|
17409
17176
|
|
|
17410
|
-
Defined in: [lib/text.ts:
|
|
17177
|
+
Defined in: [lib/text.ts:714](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L714)
|
|
17411
17178
|
|
|
17412
17179
|
递归删除 json 中的字符串首尾空格,会返回一个新的对象
|
|
17413
17180
|
|
|
@@ -17434,7 +17201,7 @@ lib/text/functions/urlAtom.md
|
|
|
17434
17201
|
|
|
17435
17202
|
> **urlAtom**(`url`): `string`
|
|
17436
17203
|
|
|
17437
|
-
Defined in: [lib/text.ts:
|
|
17204
|
+
Defined in: [lib/text.ts:234](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L234)
|
|
17438
17205
|
|
|
17439
17206
|
将路径中的 ../ ./ 都按规范妥善处理
|
|
17440
17207
|
|
|
@@ -17463,7 +17230,7 @@ lib/text/functions/urlResolve.md
|
|
|
17463
17230
|
|
|
17464
17231
|
> **urlResolve**(`from`, `to`, `limit?`): `string`
|
|
17465
17232
|
|
|
17466
|
-
Defined in: [lib/text.ts:
|
|
17233
|
+
Defined in: [lib/text.ts:168](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L168)
|
|
17467
17234
|
|
|
17468
17235
|
将相对路径根据基准路径进行转换
|
|
17469
17236
|
|
|
@@ -17533,6 +17300,7 @@ lib/text/index.md
|
|
|
17533
17300
|
- [isIPv6](functions/isIPv6.md)
|
|
17534
17301
|
- [isPhoneCN](functions/isPhoneCN.md)
|
|
17535
17302
|
- [isRealPath](functions/isRealPath.md)
|
|
17303
|
+
- [isSameOrigin](functions/isSameOrigin.md)
|
|
17536
17304
|
- [isTruthy](functions/isTruthy.md)
|
|
17537
17305
|
- [logicalOr](functions/logicalOr.md)
|
|
17538
17306
|
- [match](functions/match.md)
|
|
@@ -17563,7 +17331,7 @@ lib/text/interfaces/IDomain.md
|
|
|
17563
17331
|
|
|
17564
17332
|
# Interface: IDomain
|
|
17565
17333
|
|
|
17566
|
-
Defined in: [lib/text.ts:
|
|
17334
|
+
Defined in: [lib/text.ts:312](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L312)
|
|
17567
17335
|
|
|
17568
17336
|
解析后的 domain
|
|
17569
17337
|
|
|
@@ -17573,7 +17341,7 @@ Defined in: [lib/text.ts:291](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17573
17341
|
|
|
17574
17342
|
> **domain**: `string` \| `null`
|
|
17575
17343
|
|
|
17576
|
-
Defined in: [lib/text.ts:
|
|
17344
|
+
Defined in: [lib/text.ts:315](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L315)
|
|
17577
17345
|
|
|
17578
17346
|
***
|
|
17579
17347
|
|
|
@@ -17581,7 +17349,7 @@ Defined in: [lib/text.ts:294](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17581
17349
|
|
|
17582
17350
|
> **sld**: `string` \| `null`
|
|
17583
17351
|
|
|
17584
|
-
Defined in: [lib/text.ts:
|
|
17352
|
+
Defined in: [lib/text.ts:314](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L314)
|
|
17585
17353
|
|
|
17586
17354
|
***
|
|
17587
17355
|
|
|
@@ -17589,7 +17357,7 @@ Defined in: [lib/text.ts:293](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17589
17357
|
|
|
17590
17358
|
> **sub**: `string` \| `null`
|
|
17591
17359
|
|
|
17592
|
-
Defined in: [lib/text.ts:
|
|
17360
|
+
Defined in: [lib/text.ts:316](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L316)
|
|
17593
17361
|
|
|
17594
17362
|
***
|
|
17595
17363
|
|
|
@@ -17597,7 +17365,7 @@ Defined in: [lib/text.ts:295](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17597
17365
|
|
|
17598
17366
|
> **tld**: `string` \| `null`
|
|
17599
17367
|
|
|
17600
|
-
Defined in: [lib/text.ts:
|
|
17368
|
+
Defined in: [lib/text.ts:313](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L313)
|
|
17601
17369
|
|
|
17602
17370
|
lib/text/type-aliases/TFalsy.md
|
|
17603
17371
|
---
|
|
@@ -17612,7 +17380,7 @@ lib/text/type-aliases/TFalsy.md
|
|
|
17612
17380
|
|
|
17613
17381
|
> **TFalsy** = `false` \| `""` \| `0` \| `null` \| `undefined` \| *typeof* `NaN`
|
|
17614
17382
|
|
|
17615
|
-
Defined in: [lib/text.ts:
|
|
17383
|
+
Defined in: [lib/text.ts:746](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L746)
|
|
17616
17384
|
|
|
17617
17385
|
虚假值类型
|
|
17618
17386
|
|
|
@@ -17629,7 +17397,7 @@ lib/text/variables/REGEXP_ASCII.md
|
|
|
17629
17397
|
|
|
17630
17398
|
> `const` **REGEXP\_ASCII**: `RegExp`
|
|
17631
17399
|
|
|
17632
|
-
Defined in: [lib/text.ts:
|
|
17400
|
+
Defined in: [lib/text.ts:285](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L285)
|
|
17633
17401
|
|
|
17634
17402
|
可打印的 ascii 字符集
|
|
17635
17403
|
|
|
@@ -17646,7 +17414,7 @@ lib/text/variables/REGEXP_DOMAIN.md
|
|
|
17646
17414
|
|
|
17647
17415
|
> `const` **REGEXP\_DOMAIN**: `RegExp`
|
|
17648
17416
|
|
|
17649
|
-
Defined in: [lib/text.ts:
|
|
17417
|
+
Defined in: [lib/text.ts:273](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L273)
|
|
17650
17418
|
|
|
17651
17419
|
lib/text/variables/REGEXP_EMAIL.md
|
|
17652
17420
|
---
|
|
@@ -17661,7 +17429,7 @@ lib/text/variables/REGEXP_EMAIL.md
|
|
|
17661
17429
|
|
|
17662
17430
|
> `const` **REGEXP\_EMAIL**: `RegExp`
|
|
17663
17431
|
|
|
17664
|
-
Defined in: [lib/text.ts:
|
|
17432
|
+
Defined in: [lib/text.ts:247](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L247)
|
|
17665
17433
|
|
|
17666
17434
|
lib/time/classes/Time.md
|
|
17667
17435
|
---
|
|
@@ -18494,7 +18262,7 @@ lib/undici/functions/filterHeaders.md
|
|
|
18494
18262
|
|
|
18495
18263
|
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
18496
18264
|
|
|
18497
|
-
Defined in: [lib/undici.ts:
|
|
18265
|
+
Defined in: [lib/undici.ts:569](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L569)
|
|
18498
18266
|
|
|
18499
18267
|
剔除不代理的 header,返回新的 header
|
|
18500
18268
|
|
|
@@ -18535,7 +18303,7 @@ lib/undici/functions/getFormData.md
|
|
|
18535
18303
|
|
|
18536
18304
|
> **getFormData**(): [`FormData`](../formdata/classes/FormData.md)
|
|
18537
18305
|
|
|
18538
|
-
Defined in: [lib/undici.ts:
|
|
18306
|
+
Defined in: [lib/undici.ts:553](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L553)
|
|
18539
18307
|
|
|
18540
18308
|
创建 FormData 对象
|
|
18541
18309
|
|
|
@@ -18655,7 +18423,7 @@ lib/undici/functions/mproxyData.md
|
|
|
18655
18423
|
|
|
18656
18424
|
> **mproxyData**(`ctr`): `any`
|
|
18657
18425
|
|
|
18658
|
-
Defined in: [lib/undici.ts:
|
|
18426
|
+
Defined in: [lib/undici.ts:671](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L671)
|
|
18659
18427
|
|
|
18660
18428
|
获取 mproxy 的附加数据
|
|
18661
18429
|
|
|
@@ -18684,7 +18452,7 @@ lib/undici/functions/mproxy.md
|
|
|
18684
18452
|
|
|
18685
18453
|
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
18686
18454
|
|
|
18687
|
-
Defined in: [lib/undici.ts:
|
|
18455
|
+
Defined in: [lib/undici.ts:609](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L609)
|
|
18688
18456
|
|
|
18689
18457
|
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
18690
18458
|
get: url, auth
|
|
@@ -18956,7 +18724,7 @@ lib/undici/functions/rproxy.md
|
|
|
18956
18724
|
|
|
18957
18725
|
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
18958
18726
|
|
|
18959
|
-
Defined in: [lib/undici.ts:
|
|
18727
|
+
Defined in: [lib/undici.ts:701](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L701)
|
|
18960
18728
|
|
|
18961
18729
|
反向代理,将本服务器的某个路由反代到其他网址
|
|
18962
18730
|
|
|
@@ -19045,7 +18813,7 @@ lib/undici/interfaces/IMproxyOptions.md
|
|
|
19045
18813
|
|
|
19046
18814
|
# Interface: IMproxyOptions
|
|
19047
18815
|
|
|
19048
|
-
Defined in: [lib/undici.ts:
|
|
18816
|
+
Defined in: [lib/undici.ts:818](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L818)
|
|
19049
18817
|
|
|
19050
18818
|
正向代理请求的传入参数选项
|
|
19051
18819
|
|
|
@@ -19055,7 +18823,7 @@ Defined in: [lib/undici.ts:803](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19055
18823
|
|
|
19056
18824
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
19057
18825
|
|
|
19058
|
-
Defined in: [lib/undici.ts:
|
|
18826
|
+
Defined in: [lib/undici.ts:827](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L827)
|
|
19059
18827
|
|
|
19060
18828
|
过滤 header,返回 true 则留下
|
|
19061
18829
|
|
|
@@ -19075,7 +18843,7 @@ Defined in: [lib/undici.ts:812](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19075
18843
|
|
|
19076
18844
|
> `optional` **follow?**: `number`
|
|
19077
18845
|
|
|
19078
|
-
Defined in: [lib/undici.ts:
|
|
18846
|
+
Defined in: [lib/undici.ts:821](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L821)
|
|
19079
18847
|
|
|
19080
18848
|
***
|
|
19081
18849
|
|
|
@@ -19083,7 +18851,7 @@ Defined in: [lib/undici.ts:806](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19083
18851
|
|
|
19084
18852
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
19085
18853
|
|
|
19086
|
-
Defined in: [lib/undici.ts:
|
|
18854
|
+
Defined in: [lib/undici.ts:825](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L825)
|
|
19087
18855
|
|
|
19088
18856
|
***
|
|
19089
18857
|
|
|
@@ -19091,7 +18859,7 @@ Defined in: [lib/undici.ts:810](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19091
18859
|
|
|
19092
18860
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
19093
18861
|
|
|
19094
|
-
Defined in: [lib/undici.ts:
|
|
18862
|
+
Defined in: [lib/undici.ts:823](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L823)
|
|
19095
18863
|
|
|
19096
18864
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
19097
18865
|
|
|
@@ -19101,7 +18869,7 @@ Defined in: [lib/undici.ts:808](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19101
18869
|
|
|
19102
18870
|
> `optional` **local?**: `string`
|
|
19103
18871
|
|
|
19104
|
-
Defined in: [lib/undici.ts:
|
|
18872
|
+
Defined in: [lib/undici.ts:824](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L824)
|
|
19105
18873
|
|
|
19106
18874
|
***
|
|
19107
18875
|
|
|
@@ -19109,7 +18877,7 @@ Defined in: [lib/undici.ts:809](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19109
18877
|
|
|
19110
18878
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
19111
18879
|
|
|
19112
|
-
Defined in: [lib/undici.ts:
|
|
18880
|
+
Defined in: [lib/undici.ts:829](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L829)
|
|
19113
18881
|
|
|
19114
18882
|
默认为 default
|
|
19115
18883
|
|
|
@@ -19119,7 +18887,7 @@ Defined in: [lib/undici.ts:814](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19119
18887
|
|
|
19120
18888
|
> `optional` **timeout?**: `number`
|
|
19121
18889
|
|
|
19122
|
-
Defined in: [lib/undici.ts:
|
|
18890
|
+
Defined in: [lib/undici.ts:820](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L820)
|
|
19123
18891
|
|
|
19124
18892
|
秒数,默认 300 秒
|
|
19125
18893
|
|
|
@@ -19134,7 +18902,7 @@ lib/undici/interfaces/IRequestOptions.md
|
|
|
19134
18902
|
|
|
19135
18903
|
# Interface: IRequestOptions
|
|
19136
18904
|
|
|
19137
|
-
Defined in: [lib/undici.ts:
|
|
18905
|
+
Defined in: [lib/undici.ts:785](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L785)
|
|
19138
18906
|
|
|
19139
18907
|
请求的传入参数选项
|
|
19140
18908
|
|
|
@@ -19144,7 +18912,7 @@ Defined in: [lib/undici.ts:770](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19144
18912
|
|
|
19145
18913
|
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
19146
18914
|
|
|
19147
|
-
Defined in: [lib/undici.ts:
|
|
18915
|
+
Defined in: [lib/undici.ts:810](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L810)
|
|
19148
18916
|
|
|
19149
18917
|
cookie 托管对象
|
|
19150
18918
|
|
|
@@ -19154,7 +18922,7 @@ cookie 托管对象
|
|
|
19154
18922
|
|
|
19155
18923
|
> `optional` **follow?**: `number`
|
|
19156
18924
|
|
|
19157
|
-
Defined in: [lib/undici.ts:
|
|
18925
|
+
Defined in: [lib/undici.ts:791](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L791)
|
|
19158
18926
|
|
|
19159
18927
|
追踪 location 次数,0 为不追踪,默认为 0
|
|
19160
18928
|
|
|
@@ -19164,7 +18932,7 @@ Defined in: [lib/undici.ts:776](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19164
18932
|
|
|
19165
18933
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
19166
18934
|
|
|
19167
|
-
Defined in: [lib/undici.ts:
|
|
18935
|
+
Defined in: [lib/undici.ts:796](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L796)
|
|
19168
18936
|
|
|
19169
18937
|
***
|
|
19170
18938
|
|
|
@@ -19172,7 +18940,7 @@ Defined in: [lib/undici.ts:781](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19172
18940
|
|
|
19173
18941
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
19174
18942
|
|
|
19175
|
-
Defined in: [lib/undici.ts:
|
|
18943
|
+
Defined in: [lib/undici.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L793)
|
|
19176
18944
|
|
|
19177
18945
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
19178
18946
|
|
|
@@ -19182,7 +18950,7 @@ Defined in: [lib/undici.ts:778](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19182
18950
|
|
|
19183
18951
|
> `optional` **keep?**: `boolean`
|
|
19184
18952
|
|
|
19185
|
-
Defined in: [lib/undici.ts:
|
|
18953
|
+
Defined in: [lib/undici.ts:806](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L806)
|
|
19186
18954
|
|
|
19187
18955
|
连接是否保持长连接(即是否允许复用),默认为 true
|
|
19188
18956
|
|
|
@@ -19192,7 +18960,7 @@ Defined in: [lib/undici.ts:791](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19192
18960
|
|
|
19193
18961
|
> `optional` **local?**: `string`
|
|
19194
18962
|
|
|
19195
|
-
Defined in: [lib/undici.ts:
|
|
18963
|
+
Defined in: [lib/undici.ts:795](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L795)
|
|
19196
18964
|
|
|
19197
18965
|
***
|
|
19198
18966
|
|
|
@@ -19200,7 +18968,7 @@ Defined in: [lib/undici.ts:780](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19200
18968
|
|
|
19201
18969
|
> `optional` **log?**: `boolean`
|
|
19202
18970
|
|
|
19203
|
-
Defined in: [lib/undici.ts:
|
|
18971
|
+
Defined in: [lib/undici.ts:812](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L812)
|
|
19204
18972
|
|
|
19205
18973
|
若有异常写入文件日志,默认为 true
|
|
19206
18974
|
|
|
@@ -19210,7 +18978,7 @@ Defined in: [lib/undici.ts:797](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19210
18978
|
|
|
19211
18979
|
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
19212
18980
|
|
|
19213
|
-
Defined in: [lib/undici.ts:
|
|
18981
|
+
Defined in: [lib/undici.ts:786](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L786)
|
|
19214
18982
|
|
|
19215
18983
|
***
|
|
19216
18984
|
|
|
@@ -19218,7 +18986,7 @@ Defined in: [lib/undici.ts:771](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19218
18986
|
|
|
19219
18987
|
> `optional` **mproxy?**: `object`
|
|
19220
18988
|
|
|
19221
|
-
Defined in: [lib/undici.ts:
|
|
18989
|
+
Defined in: [lib/undici.ts:798](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L798)
|
|
19222
18990
|
|
|
19223
18991
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
19224
18992
|
|
|
@@ -19246,7 +19014,7 @@ Defined in: [lib/undici.ts:783](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19246
19014
|
|
|
19247
19015
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
19248
19016
|
|
|
19249
|
-
Defined in: [lib/undici.ts:
|
|
19017
|
+
Defined in: [lib/undici.ts:808](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L808)
|
|
19250
19018
|
|
|
19251
19019
|
复用池名/Agent,默认为 default
|
|
19252
19020
|
|
|
@@ -19256,7 +19024,7 @@ Defined in: [lib/undici.ts:793](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19256
19024
|
|
|
19257
19025
|
> `optional` **save?**: `string`
|
|
19258
19026
|
|
|
19259
|
-
Defined in: [lib/undici.ts:
|
|
19027
|
+
Defined in: [lib/undici.ts:794](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L794)
|
|
19260
19028
|
|
|
19261
19029
|
***
|
|
19262
19030
|
|
|
@@ -19264,7 +19032,7 @@ Defined in: [lib/undici.ts:779](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19264
19032
|
|
|
19265
19033
|
> `optional` **signal?**: `AbortSignal`
|
|
19266
19034
|
|
|
19267
|
-
Defined in: [lib/undici.ts:
|
|
19035
|
+
Defined in: [lib/undici.ts:814](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L814)
|
|
19268
19036
|
|
|
19269
19037
|
请求中止信号
|
|
19270
19038
|
|
|
@@ -19274,7 +19042,7 @@ Defined in: [lib/undici.ts:799](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19274
19042
|
|
|
19275
19043
|
> `optional` **timeout?**: `number`
|
|
19276
19044
|
|
|
19277
|
-
Defined in: [lib/undici.ts:
|
|
19045
|
+
Defined in: [lib/undici.ts:789](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L789)
|
|
19278
19046
|
|
|
19279
19047
|
秒数,默认 300 秒
|
|
19280
19048
|
|
|
@@ -19284,7 +19052,7 @@ Defined in: [lib/undici.ts:774](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19284
19052
|
|
|
19285
19053
|
> `optional` **type?**: `"form"` \| `"json"`
|
|
19286
19054
|
|
|
19287
|
-
Defined in: [lib/undici.ts:
|
|
19055
|
+
Defined in: [lib/undici.ts:787](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L787)
|
|
19288
19056
|
|
|
19289
19057
|
lib/undici/interfaces/IRproxyOptions.md
|
|
19290
19058
|
---
|
|
@@ -19297,7 +19065,7 @@ lib/undici/interfaces/IRproxyOptions.md
|
|
|
19297
19065
|
|
|
19298
19066
|
# Interface: IRproxyOptions
|
|
19299
19067
|
|
|
19300
|
-
Defined in: [lib/undici.ts:
|
|
19068
|
+
Defined in: [lib/undici.ts:833](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L833)
|
|
19301
19069
|
|
|
19302
19070
|
反向代理请求的传入参数选项
|
|
19303
19071
|
|
|
@@ -19307,7 +19075,7 @@ Defined in: [lib/undici.ts:818](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19307
19075
|
|
|
19308
19076
|
> `optional` **body?**: `string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
19309
19077
|
|
|
19310
|
-
Defined in: [lib/undici.ts:
|
|
19078
|
+
Defined in: [lib/undici.ts:852](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L852)
|
|
19311
19079
|
|
|
19312
19080
|
手动传入请求体(优先于原始 req 流),用于 req 流已消费后仍需转发 body 的场景
|
|
19313
19081
|
|
|
@@ -19317,7 +19085,7 @@ Defined in: [lib/undici.ts:837](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19317
19085
|
|
|
19318
19086
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
19319
19087
|
|
|
19320
|
-
Defined in: [lib/undici.ts:
|
|
19088
|
+
Defined in: [lib/undici.ts:842](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L842)
|
|
19321
19089
|
|
|
19322
19090
|
过滤 header,返回 true 则留下
|
|
19323
19091
|
|
|
@@ -19337,7 +19105,7 @@ Defined in: [lib/undici.ts:827](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19337
19105
|
|
|
19338
19106
|
> `optional` **follow?**: `number`
|
|
19339
19107
|
|
|
19340
|
-
Defined in: [lib/undici.ts:
|
|
19108
|
+
Defined in: [lib/undici.ts:836](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L836)
|
|
19341
19109
|
|
|
19342
19110
|
***
|
|
19343
19111
|
|
|
@@ -19345,7 +19113,7 @@ Defined in: [lib/undici.ts:821](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19345
19113
|
|
|
19346
19114
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
19347
19115
|
|
|
19348
|
-
Defined in: [lib/undici.ts:
|
|
19116
|
+
Defined in: [lib/undici.ts:840](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L840)
|
|
19349
19117
|
|
|
19350
19118
|
***
|
|
19351
19119
|
|
|
@@ -19353,7 +19121,7 @@ Defined in: [lib/undici.ts:825](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19353
19121
|
|
|
19354
19122
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
19355
19123
|
|
|
19356
|
-
Defined in: [lib/undici.ts:
|
|
19124
|
+
Defined in: [lib/undici.ts:838](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L838)
|
|
19357
19125
|
|
|
19358
19126
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
19359
19127
|
|
|
@@ -19363,7 +19131,7 @@ Defined in: [lib/undici.ts:823](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19363
19131
|
|
|
19364
19132
|
> `optional` **local?**: `string`
|
|
19365
19133
|
|
|
19366
|
-
Defined in: [lib/undici.ts:
|
|
19134
|
+
Defined in: [lib/undici.ts:839](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L839)
|
|
19367
19135
|
|
|
19368
19136
|
***
|
|
19369
19137
|
|
|
@@ -19371,7 +19139,7 @@ Defined in: [lib/undici.ts:824](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19371
19139
|
|
|
19372
19140
|
> `optional` **mproxy?**: `object`
|
|
19373
19141
|
|
|
19374
|
-
Defined in: [lib/undici.ts:
|
|
19142
|
+
Defined in: [lib/undici.ts:844](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L844)
|
|
19375
19143
|
|
|
19376
19144
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
19377
19145
|
|
|
@@ -19399,7 +19167,7 @@ Defined in: [lib/undici.ts:829](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19399
19167
|
|
|
19400
19168
|
> `optional` **querys?**: `Record`\<`string`, `any`\>
|
|
19401
19169
|
|
|
19402
|
-
Defined in: [lib/undici.ts:
|
|
19170
|
+
Defined in: [lib/undici.ts:854](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L854)
|
|
19403
19171
|
|
|
19404
19172
|
自定义 GET 查询参数,传入后直接替换代理目标 URL 的整个 query string
|
|
19405
19173
|
|
|
@@ -19409,7 +19177,7 @@ Defined in: [lib/undici.ts:839](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19409
19177
|
|
|
19410
19178
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
19411
19179
|
|
|
19412
|
-
Defined in: [lib/undici.ts:
|
|
19180
|
+
Defined in: [lib/undici.ts:856](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L856)
|
|
19413
19181
|
|
|
19414
19182
|
默认为 default
|
|
19415
19183
|
|
|
@@ -19419,7 +19187,7 @@ Defined in: [lib/undici.ts:841](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19419
19187
|
|
|
19420
19188
|
> `optional` **timeout?**: `number`
|
|
19421
19189
|
|
|
19422
|
-
Defined in: [lib/undici.ts:
|
|
19190
|
+
Defined in: [lib/undici.ts:835](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L835)
|
|
19423
19191
|
|
|
19424
19192
|
秒数,默认 300 秒
|
|
19425
19193
|
|
|
@@ -19822,7 +19590,7 @@ Defined in: [lib/undici/response.ts:66](https://github.com/maiyunnet/kebab/blob/
|
|
|
19822
19590
|
|
|
19823
19591
|
> **getRawStream**(): `BodyReadable` & `BodyMixin` \| `null`
|
|
19824
19592
|
|
|
19825
|
-
Defined in: [lib/undici/response.ts:
|
|
19593
|
+
Defined in: [lib/undici/response.ts:126](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L126)
|
|
19826
19594
|
|
|
19827
19595
|
获取原生响应读取流对象
|
|
19828
19596
|
|
|
@@ -19836,7 +19604,7 @@ Defined in: [lib/undici/response.ts:128](https://github.com/maiyunnet/kebab/blob
|
|
|
19836
19604
|
|
|
19837
19605
|
> **getStream**(): `BrotliDecompress` \| `Gunzip` \| `Inflate` \| `BodyReadable` & `BodyMixin` \| `null`
|
|
19838
19606
|
|
|
19839
|
-
Defined in: [lib/undici/response.ts:
|
|
19607
|
+
Defined in: [lib/undici/response.ts:91](https://github.com/maiyunnet/kebab/blob/master/lib/undici/response.ts#L91)
|
|
19840
19608
|
|
|
19841
19609
|
获取响应读取流对象
|
|
19842
19610
|
|
|
@@ -19908,7 +19676,7 @@ lib/undici/type-aliases/THttpHeaders.md
|
|
|
19908
19676
|
|
|
19909
19677
|
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
19910
19678
|
|
|
19911
|
-
Defined in: [lib/undici.ts:
|
|
19679
|
+
Defined in: [lib/undici.ts:861](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L861)
|
|
19912
19680
|
|
|
19913
19681
|
http headers
|
|
19914
19682
|
|
|
@@ -23263,6 +23031,24 @@ Defined in: [sys/ctr.ts:1102](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23263
23031
|
|
|
23264
23032
|
单个文件最大字节数
|
|
23265
23033
|
|
|
23034
|
+
###### maxHeaderSize?
|
|
23035
|
+
|
|
23036
|
+
`number`
|
|
23037
|
+
|
|
23038
|
+
单个 multipart 段头部最大字节数,默认 16 KB
|
|
23039
|
+
|
|
23040
|
+
###### maxParts?
|
|
23041
|
+
|
|
23042
|
+
`number`
|
|
23043
|
+
|
|
23044
|
+
multipart 字段与文件总数量,默认 1000
|
|
23045
|
+
|
|
23046
|
+
###### maxTotalSize?
|
|
23047
|
+
|
|
23048
|
+
`number`
|
|
23049
|
+
|
|
23050
|
+
整体请求最大字节数,不设置或设为 0 则不限制
|
|
23051
|
+
|
|
23266
23052
|
###### timeout?
|
|
23267
23053
|
|
|
23268
23054
|
`number`
|
|
@@ -26760,7 +26546,7 @@ sys/route/functions/getFormData.md
|
|
|
26760
26546
|
|
|
26761
26547
|
> **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)\>; \}\>
|
|
26762
26548
|
|
|
26763
|
-
Defined in: [sys/route.ts:
|
|
26549
|
+
Defined in: [sys/route.ts:995](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L995)
|
|
26764
26550
|
|
|
26765
26551
|
获取 formdata 的 post
|
|
26766
26552
|
|
|
@@ -26816,6 +26602,24 @@ Defined in: [sys/route.ts:980](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
26816
26602
|
|
|
26817
26603
|
单个文件最大字节数
|
|
26818
26604
|
|
|
26605
|
+
#### maxHeaderSize?
|
|
26606
|
+
|
|
26607
|
+
`number`
|
|
26608
|
+
|
|
26609
|
+
单个 multipart 段头部最大字节数,默认 16 KB
|
|
26610
|
+
|
|
26611
|
+
#### maxParts?
|
|
26612
|
+
|
|
26613
|
+
`number`
|
|
26614
|
+
|
|
26615
|
+
multipart 字段与文件总数量,默认 1000
|
|
26616
|
+
|
|
26617
|
+
#### maxTotalSize?
|
|
26618
|
+
|
|
26619
|
+
`number`
|
|
26620
|
+
|
|
26621
|
+
整体请求最大字节数,不设置或设为 0 则不限制
|
|
26622
|
+
|
|
26819
26623
|
#### timeout?
|
|
26820
26624
|
|
|
26821
26625
|
`number`
|
|
@@ -26839,7 +26643,7 @@ sys/route/functions/getPost.md
|
|
|
26839
26643
|
|
|
26840
26644
|
> **getPost**(`req`): `Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
|
|
26841
26645
|
|
|
26842
|
-
Defined in: [sys/route.ts:
|
|
26646
|
+
Defined in: [sys/route.ts:909](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L909)
|
|
26843
26647
|
|
|
26844
26648
|
获取 post 对象(通常已自动获取),如果是文件上传(formdata)的情况则不获取
|
|
26845
26649
|
|
|
@@ -26868,7 +26672,7 @@ sys/route/functions/run.md
|
|
|
26868
26672
|
|
|
26869
26673
|
> **run**(`data`): `Promise`\<`boolean`\>
|
|
26870
26674
|
|
|
26871
|
-
Defined in: [sys/route.ts:
|
|
26675
|
+
Defined in: [sys/route.ts:102](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L102)
|
|
26872
26676
|
|
|
26873
26677
|
若为动态路径则执行此函数,此函数不进行判断 kebab.json 是否存在
|
|
26874
26678
|
|
|
@@ -26955,7 +26759,7 @@ sys/route/functions/unlinkUploadFiles.md
|
|
|
26955
26759
|
|
|
26956
26760
|
> **unlinkUploadFiles**(`cctr`): `Promise`\<`void`\>
|
|
26957
26761
|
|
|
26958
|
-
Defined in: [sys/route.ts:
|
|
26762
|
+
Defined in: [sys/route.ts:868](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L868)
|
|
26959
26763
|
|
|
26960
26764
|
删除本次请求所有已上传的临时文件
|
|
26961
26765
|
|
|
@@ -26984,7 +26788,7 @@ sys/route/functions/waitCtr.md
|
|
|
26984
26788
|
|
|
26985
26789
|
> **waitCtr**(`cctr`): `Promise`\<`void`\>
|
|
26986
26790
|
|
|
26987
|
-
Defined in: [sys/route.ts:
|
|
26791
|
+
Defined in: [sys/route.ts:888](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L888)
|
|
26988
26792
|
|
|
26989
26793
|
等待异步任务结束,并删除临时文件,如果结束后还有事务没关闭,则会在本函数中打印控制台并且写入 log 文件
|
|
26990
26794
|
此时其实已经给客户端返回了,此处等待不消耗客户端的等待时间
|