@maiyunnet/kebab 9.14.2 → 9.15.0
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 +381 -559
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/core.d.ts +2 -0
- package/lib/core.js +21 -6
- package/lib/crypto.js +1 -1
- package/lib/fs.js +1 -2
- 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.0"` = `'9.15.0'`
|
|
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
|
|
|
@@ -4766,6 +4766,7 @@ lib/core/index.md
|
|
|
4766
4766
|
- [RANDOM\_UN](variables/RANDOM_UN.md)
|
|
4767
4767
|
- [RANDOM\_V](variables/RANDOM_V.md)
|
|
4768
4768
|
- [REAL\_IP\_CF](variables/REAL_IP_CF.md)
|
|
4769
|
+
- [REAL\_IP\_EO](variables/REAL_IP_EO.md)
|
|
4769
4770
|
- [REAL\_IP\_X](variables/REAL_IP_X.md)
|
|
4770
4771
|
|
|
4771
4772
|
## Functions
|
|
@@ -4821,7 +4822,7 @@ lib/core/interfaces/ICookieOptions.md
|
|
|
4821
4822
|
|
|
4822
4823
|
# Interface: ICookieOptions
|
|
4823
4824
|
|
|
4824
|
-
Defined in: [lib/core.ts:
|
|
4825
|
+
Defined in: [lib/core.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L47)
|
|
4825
4826
|
|
|
4826
4827
|
Cookie 设置的选项
|
|
4827
4828
|
|
|
@@ -4831,7 +4832,7 @@ Cookie 设置的选项
|
|
|
4831
4832
|
|
|
4832
4833
|
> `optional` **domain?**: `string`
|
|
4833
4834
|
|
|
4834
|
-
Defined in: [lib/core.ts:
|
|
4835
|
+
Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L50)
|
|
4835
4836
|
|
|
4836
4837
|
***
|
|
4837
4838
|
|
|
@@ -4839,7 +4840,7 @@ Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4839
4840
|
|
|
4840
4841
|
> `optional` **httponly?**: `boolean`
|
|
4841
4842
|
|
|
4842
|
-
Defined in: [lib/core.ts:
|
|
4843
|
+
Defined in: [lib/core.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L52)
|
|
4843
4844
|
|
|
4844
4845
|
***
|
|
4845
4846
|
|
|
@@ -4847,7 +4848,7 @@ Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4847
4848
|
|
|
4848
4849
|
> `optional` **path?**: `string`
|
|
4849
4850
|
|
|
4850
|
-
Defined in: [lib/core.ts:
|
|
4851
|
+
Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L49)
|
|
4851
4852
|
|
|
4852
4853
|
***
|
|
4853
4854
|
|
|
@@ -4855,7 +4856,7 @@ Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4855
4856
|
|
|
4856
4857
|
> `optional` **samesite?**: `"Strict"` \| `"Lax"` \| `"None"`
|
|
4857
4858
|
|
|
4858
|
-
Defined in: [lib/core.ts:
|
|
4859
|
+
Defined in: [lib/core.ts:53](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L53)
|
|
4859
4860
|
|
|
4860
4861
|
***
|
|
4861
4862
|
|
|
@@ -4863,7 +4864,7 @@ Defined in: [lib/core.ts:52](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4863
4864
|
|
|
4864
4865
|
> `optional` **ssl?**: `boolean`
|
|
4865
4866
|
|
|
4866
|
-
Defined in: [lib/core.ts:
|
|
4867
|
+
Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L51)
|
|
4867
4868
|
|
|
4868
4869
|
***
|
|
4869
4870
|
|
|
@@ -4871,7 +4872,7 @@ Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4871
4872
|
|
|
4872
4873
|
> `optional` **ttl?**: `number`
|
|
4873
4874
|
|
|
4874
|
-
Defined in: [lib/core.ts:
|
|
4875
|
+
Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L48)
|
|
4875
4876
|
|
|
4876
4877
|
lib/core/interfaces/ILogOptions.md
|
|
4877
4878
|
---
|
|
@@ -4884,7 +4885,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4884
4885
|
|
|
4885
4886
|
# Interface: ILogOptions
|
|
4886
4887
|
|
|
4887
|
-
Defined in: [lib/core.ts:
|
|
4888
|
+
Defined in: [lib/core.ts:1118](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1118)
|
|
4888
4889
|
|
|
4889
4890
|
log 设置的选项
|
|
4890
4891
|
|
|
@@ -4894,7 +4895,7 @@ log 设置的选项
|
|
|
4894
4895
|
|
|
4895
4896
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4896
4897
|
|
|
4897
|
-
Defined in: [lib/core.ts:
|
|
4898
|
+
Defined in: [lib/core.ts:1124](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1124)
|
|
4898
4899
|
|
|
4899
4900
|
***
|
|
4900
4901
|
|
|
@@ -4902,7 +4903,7 @@ Defined in: [lib/core.ts:1121](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4902
4903
|
|
|
4903
4904
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4904
4905
|
|
|
4905
|
-
Defined in: [lib/core.ts:
|
|
4906
|
+
Defined in: [lib/core.ts:1123](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1123)
|
|
4906
4907
|
|
|
4907
4908
|
***
|
|
4908
4909
|
|
|
@@ -4910,7 +4911,7 @@ Defined in: [lib/core.ts:1120](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4910
4911
|
|
|
4911
4912
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4912
4913
|
|
|
4913
|
-
Defined in: [lib/core.ts:
|
|
4914
|
+
Defined in: [lib/core.ts:1126](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1126)
|
|
4914
4915
|
|
|
4915
4916
|
***
|
|
4916
4917
|
|
|
@@ -4918,7 +4919,7 @@ Defined in: [lib/core.ts:1123](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4918
4919
|
|
|
4919
4920
|
> `optional` **hostname?**: `string`
|
|
4920
4921
|
|
|
4921
|
-
Defined in: [lib/core.ts:
|
|
4922
|
+
Defined in: [lib/core.ts:1121](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1121)
|
|
4922
4923
|
|
|
4923
4924
|
***
|
|
4924
4925
|
|
|
@@ -4926,7 +4927,7 @@ Defined in: [lib/core.ts:1118](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4926
4927
|
|
|
4927
4928
|
> `optional` **path?**: `string`
|
|
4928
4929
|
|
|
4929
|
-
Defined in: [lib/core.ts:
|
|
4930
|
+
Defined in: [lib/core.ts:1119](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1119)
|
|
4930
4931
|
|
|
4931
4932
|
***
|
|
4932
4933
|
|
|
@@ -4934,7 +4935,7 @@ Defined in: [lib/core.ts:1116](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4934
4935
|
|
|
4935
4936
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4936
4937
|
|
|
4937
|
-
Defined in: [lib/core.ts:
|
|
4938
|
+
Defined in: [lib/core.ts:1122](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1122)
|
|
4938
4939
|
|
|
4939
4940
|
***
|
|
4940
4941
|
|
|
@@ -4942,7 +4943,7 @@ Defined in: [lib/core.ts:1119](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4942
4943
|
|
|
4943
4944
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4944
4945
|
|
|
4945
|
-
Defined in: [lib/core.ts:
|
|
4946
|
+
Defined in: [lib/core.ts:1125](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1125)
|
|
4946
4947
|
|
|
4947
4948
|
***
|
|
4948
4949
|
|
|
@@ -4950,7 +4951,7 @@ Defined in: [lib/core.ts:1122](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4950
4951
|
|
|
4951
4952
|
> `optional` **urlFull?**: `string`
|
|
4952
4953
|
|
|
4953
|
-
Defined in: [lib/core.ts:
|
|
4954
|
+
Defined in: [lib/core.ts:1120](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1120)
|
|
4954
4955
|
|
|
4955
4956
|
lib/core/type-aliases/TPm2Action.md
|
|
4956
4957
|
---
|
|
@@ -4965,7 +4966,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4965
4966
|
|
|
4966
4967
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4967
4968
|
|
|
4968
|
-
Defined in: [lib/core.ts:
|
|
4969
|
+
Defined in: [lib/core.ts:795](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L795)
|
|
4969
4970
|
|
|
4970
4971
|
PM2 操作类型
|
|
4971
4972
|
|
|
@@ -4982,7 +4983,7 @@ lib/core/variables/globalConfig.md
|
|
|
4982
4983
|
|
|
4983
4984
|
> `const` **globalConfig**: [`IConfig`](../../../index/interfaces/IConfig.md) & `object`
|
|
4984
4985
|
|
|
4985
|
-
Defined in: [lib/core.ts:
|
|
4986
|
+
Defined in: [lib/core.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L26)
|
|
4986
4987
|
|
|
4987
4988
|
全局参数
|
|
4988
4989
|
|
|
@@ -5039,7 +5040,7 @@ lib/core/variables/global.md
|
|
|
5039
5040
|
|
|
5040
5041
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
5041
5042
|
|
|
5042
|
-
Defined in: [lib/core.ts:
|
|
5043
|
+
Defined in: [lib/core.ts:894](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L894)
|
|
5043
5044
|
|
|
5044
5045
|
跨进程全局变量
|
|
5045
5046
|
|
|
@@ -5056,7 +5057,7 @@ lib/core/variables/RANDOM_L.md
|
|
|
5056
5057
|
|
|
5057
5058
|
> `const` **RANDOM\_L**: `"abcdefghijklmnopqrstuvwxyz"` = `'abcdefghijklmnopqrstuvwxyz'`
|
|
5058
5059
|
|
|
5059
|
-
Defined in: [lib/core.ts:
|
|
5060
|
+
Defined in: [lib/core.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L109)
|
|
5060
5061
|
|
|
5061
5062
|
小写字母字符集
|
|
5062
5063
|
|
|
@@ -5073,7 +5074,7 @@ lib/core/variables/RANDOM_LN.md
|
|
|
5073
5074
|
|
|
5074
5075
|
> `const` **RANDOM\_LN**: `string`
|
|
5075
5076
|
|
|
5076
|
-
Defined in: [lib/core.ts:
|
|
5077
|
+
Defined in: [lib/core.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L114)
|
|
5077
5078
|
|
|
5078
5079
|
小写字母 + 数字字符集
|
|
5079
5080
|
|
|
@@ -5090,7 +5091,7 @@ lib/core/variables/RANDOM_LU.md
|
|
|
5090
5091
|
|
|
5091
5092
|
> `const` **RANDOM\_LU**: `string`
|
|
5092
5093
|
|
|
5093
|
-
Defined in: [lib/core.ts:
|
|
5094
|
+
Defined in: [lib/core.ts:116](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L116)
|
|
5094
5095
|
|
|
5095
5096
|
小写字母 + 大写字母字符集
|
|
5096
5097
|
|
|
@@ -5107,7 +5108,7 @@ lib/core/variables/RANDOM_LUN.md
|
|
|
5107
5108
|
|
|
5108
5109
|
> `const` **RANDOM\_LUN**: `string`
|
|
5109
5110
|
|
|
5110
|
-
Defined in: [lib/core.ts:
|
|
5111
|
+
Defined in: [lib/core.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L118)
|
|
5111
5112
|
|
|
5112
5113
|
小写字母 + 大写字母 + 数字字符集
|
|
5113
5114
|
|
|
@@ -5124,7 +5125,7 @@ lib/core/variables/RANDOM_LUNS.md
|
|
|
5124
5125
|
|
|
5125
5126
|
> `const` **RANDOM\_LUNS**: `string`
|
|
5126
5127
|
|
|
5127
|
-
Defined in: [lib/core.ts:
|
|
5128
|
+
Defined in: [lib/core.ts:122](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L122)
|
|
5128
5129
|
|
|
5129
5130
|
小写字母 + 大写字母 + 数字字符集 + 特殊字符字符集
|
|
5130
5131
|
|
|
@@ -5141,7 +5142,7 @@ lib/core/variables/RANDOM_N.md
|
|
|
5141
5142
|
|
|
5142
5143
|
> `const` **RANDOM\_N**: `"0123456789"` = `'0123456789'`
|
|
5143
5144
|
|
|
5144
|
-
Defined in: [lib/core.ts:
|
|
5145
|
+
Defined in: [lib/core.ts:105](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L105)
|
|
5145
5146
|
|
|
5146
5147
|
数字字符集
|
|
5147
5148
|
|
|
@@ -5158,7 +5159,7 @@ lib/core/variables/RANDOM_U.md
|
|
|
5158
5159
|
|
|
5159
5160
|
> `const` **RANDOM\_U**: `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"` = `'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`
|
|
5160
5161
|
|
|
5161
|
-
Defined in: [lib/core.ts:
|
|
5162
|
+
Defined in: [lib/core.ts:107](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L107)
|
|
5162
5163
|
|
|
5163
5164
|
大写字母字符集
|
|
5164
5165
|
|
|
@@ -5175,7 +5176,7 @@ lib/core/variables/RANDOM_UN.md
|
|
|
5175
5176
|
|
|
5176
5177
|
> `const` **RANDOM\_UN**: `string`
|
|
5177
5178
|
|
|
5178
|
-
Defined in: [lib/core.ts:
|
|
5179
|
+
Defined in: [lib/core.ts:112](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L112)
|
|
5179
5180
|
|
|
5180
5181
|
大写字母 + 数字字符集
|
|
5181
5182
|
|
|
@@ -5192,7 +5193,7 @@ lib/core/variables/RANDOM_V.md
|
|
|
5192
5193
|
|
|
5193
5194
|
> `const` **RANDOM\_V**: `"ACEFGHJKLMNPRSTWXY34567"` = `'ACEFGHJKLMNPRSTWXY34567'`
|
|
5194
5195
|
|
|
5195
|
-
Defined in: [lib/core.ts:
|
|
5196
|
+
Defined in: [lib/core.ts:120](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L120)
|
|
5196
5197
|
|
|
5197
5198
|
验证码字符集
|
|
5198
5199
|
|
|
@@ -5209,10 +5210,27 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
5209
5210
|
|
|
5210
5211
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
5211
5212
|
|
|
5212
|
-
Defined in: [lib/core.ts:
|
|
5213
|
+
Defined in: [lib/core.ts:401](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L401)
|
|
5213
5214
|
|
|
5214
5215
|
使用的是 Cloudflare
|
|
5215
5216
|
|
|
5217
|
+
lib/core/variables/REAL_IP_EO.md
|
|
5218
|
+
---
|
|
5219
|
+
|
|
5220
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
5221
|
+
|
|
5222
|
+
***
|
|
5223
|
+
|
|
5224
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / REAL\_IP\_EO
|
|
5225
|
+
|
|
5226
|
+
# Variable: REAL\_IP\_EO
|
|
5227
|
+
|
|
5228
|
+
> `const` **REAL\_IP\_EO**: `"eo-connecting-ip"` = `'eo-connecting-ip'`
|
|
5229
|
+
|
|
5230
|
+
Defined in: [lib/core.ts:403](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L403)
|
|
5231
|
+
|
|
5232
|
+
使用的是 EO
|
|
5233
|
+
|
|
5216
5234
|
lib/core/variables/REAL_IP_X.md
|
|
5217
5235
|
---
|
|
5218
5236
|
|
|
@@ -5226,7 +5244,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
5226
5244
|
|
|
5227
5245
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
5228
5246
|
|
|
5229
|
-
Defined in: [lib/core.ts:
|
|
5247
|
+
Defined in: [lib/core.ts:399](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L399)
|
|
5230
5248
|
|
|
5231
5249
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
5232
5250
|
|
|
@@ -8524,7 +8542,7 @@ lib/fs/functions/chmod.md
|
|
|
8524
8542
|
|
|
8525
8543
|
> **chmod**(`path`, `mod`): `Promise`\<`boolean`\>
|
|
8526
8544
|
|
|
8527
|
-
Defined in: [lib/fs.ts:
|
|
8545
|
+
Defined in: [lib/fs.ts:277](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L277)
|
|
8528
8546
|
|
|
8529
8547
|
修改权限
|
|
8530
8548
|
|
|
@@ -8559,7 +8577,7 @@ lib/fs/functions/copyFile.md
|
|
|
8559
8577
|
|
|
8560
8578
|
> **copyFile**(`src`, `dest`): `Promise`\<`boolean`\>
|
|
8561
8579
|
|
|
8562
|
-
Defined in: [lib/fs.ts:
|
|
8580
|
+
Defined in: [lib/fs.ts:385](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L385)
|
|
8563
8581
|
|
|
8564
8582
|
复制文件
|
|
8565
8583
|
|
|
@@ -8594,7 +8612,7 @@ lib/fs/functions/copyFolder.md
|
|
|
8594
8612
|
|
|
8595
8613
|
> **copyFolder**(`from`, `to`, `ignore?`): `Promise`\<`number`\>
|
|
8596
8614
|
|
|
8597
|
-
Defined in: [lib/fs.ts:
|
|
8615
|
+
Defined in: [lib/fs.ts:340](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L340)
|
|
8598
8616
|
|
|
8599
8617
|
复制文件夹里的内容到另一个地方,失败不会回滚
|
|
8600
8618
|
|
|
@@ -8635,7 +8653,7 @@ lib/fs/functions/createReadStream.md
|
|
|
8635
8653
|
|
|
8636
8654
|
> **createReadStream**(`path`, `options?`): `ReadStream`
|
|
8637
8655
|
|
|
8638
|
-
Defined in: [lib/fs.ts:
|
|
8656
|
+
Defined in: [lib/fs.ts:400](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L400)
|
|
8639
8657
|
|
|
8640
8658
|
创建读取文件的流
|
|
8641
8659
|
|
|
@@ -8670,7 +8688,7 @@ lib/fs/functions/createWriteStream.md
|
|
|
8670
8688
|
|
|
8671
8689
|
> **createWriteStream**(`path`, `options?`): `WriteStream`
|
|
8672
8690
|
|
|
8673
|
-
Defined in: [lib/fs.ts:
|
|
8691
|
+
Defined in: [lib/fs.ts:447](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L447)
|
|
8674
8692
|
|
|
8675
8693
|
创建写入文件的流
|
|
8676
8694
|
|
|
@@ -8776,7 +8794,7 @@ lib/fs/functions/isDir.md
|
|
|
8776
8794
|
|
|
8777
8795
|
> **isDir**(`path`): `Promise`\<`false` \| `Stats`\>
|
|
8778
8796
|
|
|
8779
|
-
Defined in: [lib/fs.ts:
|
|
8797
|
+
Defined in: [lib/fs.ts:181](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L181)
|
|
8780
8798
|
|
|
8781
8799
|
判断是否是目录或目录是否存在,是的话返回 stats
|
|
8782
8800
|
|
|
@@ -8805,7 +8823,7 @@ lib/fs/functions/isFile.md
|
|
|
8805
8823
|
|
|
8806
8824
|
> **isFile**(`path`): `Promise`\<`false` \| `Stats`\>
|
|
8807
8825
|
|
|
8808
|
-
Defined in: [lib/fs.ts:
|
|
8826
|
+
Defined in: [lib/fs.ts:193](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L193)
|
|
8809
8827
|
|
|
8810
8828
|
判断是否是文件或文件是否存在,是的话返回 stats
|
|
8811
8829
|
|
|
@@ -8834,7 +8852,7 @@ lib/fs/functions/mkdir.md
|
|
|
8834
8852
|
|
|
8835
8853
|
> **mkdir**(`path`, `mode?`): `Promise`\<`boolean`\>
|
|
8836
8854
|
|
|
8837
|
-
Defined in: [lib/fs.ts:
|
|
8855
|
+
Defined in: [lib/fs.ts:206](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L206)
|
|
8838
8856
|
|
|
8839
8857
|
深度创建目录,如果最末目录存在,则自动创建成功
|
|
8840
8858
|
|
|
@@ -8869,7 +8887,7 @@ lib/fs/functions/pipe.md
|
|
|
8869
8887
|
|
|
8870
8888
|
> **pipe**(`path`, `destination`, `options?`): `Promise`\<`boolean`\>
|
|
8871
8889
|
|
|
8872
|
-
Defined in: [lib/fs.ts:
|
|
8890
|
+
Defined in: [lib/fs.ts:430](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L430)
|
|
8873
8891
|
|
|
8874
8892
|
读取文件写入到流,并等待写入完成
|
|
8875
8893
|
|
|
@@ -8912,7 +8930,7 @@ lib/fs/functions/putContent.md
|
|
|
8912
8930
|
|
|
8913
8931
|
> **putContent**(`path`, `data`, `options?`): `Promise`\<`boolean`\>
|
|
8914
8932
|
|
|
8915
|
-
Defined in: [lib/fs.ts:
|
|
8933
|
+
Defined in: [lib/fs.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L92)
|
|
8916
8934
|
|
|
8917
8935
|
写入文件内容
|
|
8918
8936
|
|
|
@@ -8963,7 +8981,7 @@ lib/fs/functions/readDir.md
|
|
|
8963
8981
|
|
|
8964
8982
|
> **readDir**(`path`, `encoding?`): `Promise`\<`Dirent`\<`string`\>[]\>
|
|
8965
8983
|
|
|
8966
|
-
Defined in: [lib/fs.ts:
|
|
8984
|
+
Defined in: [lib/fs.ts:306](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L306)
|
|
8967
8985
|
|
|
8968
8986
|
获取文件夹下文件列表
|
|
8969
8987
|
|
|
@@ -8996,7 +9014,7 @@ lib/fs/functions/readLink.md
|
|
|
8996
9014
|
|
|
8997
9015
|
> **readLink**(`path`, `encoding?`): `Promise`\<`string` \| `null`\>
|
|
8998
9016
|
|
|
8999
|
-
Defined in: [lib/fs.ts:
|
|
9017
|
+
Defined in: [lib/fs.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L114)
|
|
9000
9018
|
|
|
9001
9019
|
读取链接的 target
|
|
9002
9020
|
|
|
@@ -9031,7 +9049,7 @@ lib/fs/functions/readToResponse.md
|
|
|
9031
9049
|
|
|
9032
9050
|
> **readToResponse**(`path`, `req`, `res`, `stat?`): `Promise`\<`void`\>
|
|
9033
9051
|
|
|
9034
|
-
Defined in: [lib/fs.ts:
|
|
9052
|
+
Defined in: [lib/fs.ts:478](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L478)
|
|
9035
9053
|
|
|
9036
9054
|
读取文件并输出到 http 的 response
|
|
9037
9055
|
|
|
@@ -9078,7 +9096,7 @@ lib/fs/functions/rename.md
|
|
|
9078
9096
|
|
|
9079
9097
|
> **rename**(`oldPath`, `newPath`): `Promise`\<`boolean`\>
|
|
9080
9098
|
|
|
9081
|
-
Defined in: [lib/fs.ts:
|
|
9099
|
+
Defined in: [lib/fs.ts:292](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L292)
|
|
9082
9100
|
|
|
9083
9101
|
重命名/移动文件文件夹
|
|
9084
9102
|
|
|
@@ -9113,7 +9131,7 @@ lib/fs/functions/rmdirDeep.md
|
|
|
9113
9131
|
|
|
9114
9132
|
> **rmdirDeep**(`path`): `Promise`\<`boolean`\>
|
|
9115
9133
|
|
|
9116
|
-
Defined in: [lib/fs.ts:
|
|
9134
|
+
Defined in: [lib/fs.ts:245](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L245)
|
|
9117
9135
|
|
|
9118
9136
|
Danger 危险:危险函数,尽量不要使用
|
|
9119
9137
|
This is a danger function, please don't use it
|
|
@@ -9142,7 +9160,7 @@ lib/fs/functions/rmdir.md
|
|
|
9142
9160
|
|
|
9143
9161
|
> **rmdir**(`path`): `Promise`\<`boolean`\>
|
|
9144
9162
|
|
|
9145
|
-
Defined in: [lib/fs.ts:
|
|
9163
|
+
Defined in: [lib/fs.ts:227](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L227)
|
|
9146
9164
|
|
|
9147
9165
|
删除空目录
|
|
9148
9166
|
|
|
@@ -9171,7 +9189,7 @@ lib/fs/functions/stats.md
|
|
|
9171
9189
|
|
|
9172
9190
|
> **stats**(`path`): `Promise`\<`Stats` \| `null`\>
|
|
9173
9191
|
|
|
9174
|
-
Defined in: [lib/fs.ts:
|
|
9192
|
+
Defined in: [lib/fs.ts:168](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L168)
|
|
9175
9193
|
|
|
9176
9194
|
获取对象是否存在,存在则返回 stats 对象,否则返回 null
|
|
9177
9195
|
|
|
@@ -9200,7 +9218,7 @@ lib/fs/functions/symlink.md
|
|
|
9200
9218
|
|
|
9201
9219
|
> **symlink**(`filePath`, `linkPath`, `type?`): `Promise`\<`boolean`\>
|
|
9202
9220
|
|
|
9203
|
-
Defined in: [lib/fs.ts:
|
|
9221
|
+
Defined in: [lib/fs.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L131)
|
|
9204
9222
|
|
|
9205
9223
|
把源文件创建一个 link
|
|
9206
9224
|
|
|
@@ -9241,7 +9259,7 @@ lib/fs/functions/unlink.md
|
|
|
9241
9259
|
|
|
9242
9260
|
> **unlink**(`path`): `Promise`\<`boolean`\>
|
|
9243
9261
|
|
|
9244
|
-
Defined in: [lib/fs.ts:
|
|
9262
|
+
Defined in: [lib/fs.ts:145](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L145)
|
|
9245
9263
|
|
|
9246
9264
|
删除一个文件
|
|
9247
9265
|
|
|
@@ -9398,7 +9416,7 @@ Defined in: [lib/kv.ts:142](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9398
9416
|
|
|
9399
9417
|
> **bLMove**(`sourceKey`, `destKey`, `soo`, `deo`, `timeout`): `Promise`\<`string` \| `false` \| `null`\>
|
|
9400
9418
|
|
|
9401
|
-
Defined in: [lib/kv.ts:
|
|
9419
|
+
Defined in: [lib/kv.ts:762](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L762)
|
|
9402
9420
|
|
|
9403
9421
|
#### Parameters
|
|
9404
9422
|
|
|
@@ -9432,7 +9450,7 @@ Defined in: [lib/kv.ts:741](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9432
9450
|
|
|
9433
9451
|
> **bRPop**(`key`, `timeout`): `Promise`\<`false` \| `Record`\<`string`, `string`\>\>
|
|
9434
9452
|
|
|
9435
|
-
Defined in: [lib/kv.ts:
|
|
9453
|
+
Defined in: [lib/kv.ts:801](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L801)
|
|
9436
9454
|
|
|
9437
9455
|
#### Parameters
|
|
9438
9456
|
|
|
@@ -9454,7 +9472,7 @@ Defined in: [lib/kv.ts:780](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9454
9472
|
|
|
9455
9473
|
> **decr**(`key`, `num?`): `Promise`\<`number` \| `false`\>
|
|
9456
9474
|
|
|
9457
|
-
Defined in: [lib/kv.ts:
|
|
9475
|
+
Defined in: [lib/kv.ts:408](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L408)
|
|
9458
9476
|
|
|
9459
9477
|
自减
|
|
9460
9478
|
|
|
@@ -9480,7 +9498,7 @@ Defined in: [lib/kv.ts:387](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9480
9498
|
|
|
9481
9499
|
> **del**(`keys`): `Promise`\<`boolean`\>
|
|
9482
9500
|
|
|
9483
|
-
Defined in: [lib/kv.ts:
|
|
9501
|
+
Defined in: [lib/kv.ts:356](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L356)
|
|
9484
9502
|
|
|
9485
9503
|
删除已存在的值
|
|
9486
9504
|
|
|
@@ -9522,7 +9540,7 @@ Defined in: [lib/kv.ts:194](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9522
9540
|
|
|
9523
9541
|
> **expire**(`key`, `ttl`): `Promise`\<`boolean`\>
|
|
9524
9542
|
|
|
9525
|
-
Defined in: [lib/kv.ts:
|
|
9543
|
+
Defined in: [lib/kv.ts:436](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L436)
|
|
9526
9544
|
|
|
9527
9545
|
仅修改过期时间不修改值
|
|
9528
9546
|
|
|
@@ -9546,7 +9564,7 @@ Defined in: [lib/kv.ts:415](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9546
9564
|
|
|
9547
9565
|
> **flushDb**(): `Promise`\<`boolean`\>
|
|
9548
9566
|
|
|
9549
|
-
Defined in: [lib/kv.ts:
|
|
9567
|
+
Defined in: [lib/kv.ts:503](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L503)
|
|
9550
9568
|
|
|
9551
9569
|
清除当前所选数据库的所有内容
|
|
9552
9570
|
|
|
@@ -9578,6 +9596,28 @@ Defined in: [lib/kv.ts:218](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9578
9596
|
|
|
9579
9597
|
***
|
|
9580
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
|
+
|
|
9581
9621
|
### getJson()
|
|
9582
9622
|
|
|
9583
9623
|
> **getJson**(`key`): `Promise`\<`any`\>
|
|
@@ -9602,7 +9642,7 @@ Defined in: [lib/kv.ts:322](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9602
9642
|
|
|
9603
9643
|
> **hDel**(`key`, `fields`): `Promise`\<`number` \| `false`\>
|
|
9604
9644
|
|
|
9605
|
-
Defined in: [lib/kv.ts:
|
|
9645
|
+
Defined in: [lib/kv.ts:664](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L664)
|
|
9606
9646
|
|
|
9607
9647
|
删除哈希键
|
|
9608
9648
|
|
|
@@ -9628,7 +9668,7 @@ Defined in: [lib/kv.ts:643](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9628
9668
|
|
|
9629
9669
|
> **hExists**(`key`, `field`): `Promise`\<`boolean`\>
|
|
9630
9670
|
|
|
9631
|
-
Defined in: [lib/kv.ts:
|
|
9671
|
+
Defined in: [lib/kv.ts:682](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L682)
|
|
9632
9672
|
|
|
9633
9673
|
判断哈希字段是否存在
|
|
9634
9674
|
|
|
@@ -9652,7 +9692,7 @@ Defined in: [lib/kv.ts:661](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9652
9692
|
|
|
9653
9693
|
> **hGet**(`key`, `field`): `Promise`\<`string` \| `false` \| `null`\>
|
|
9654
9694
|
|
|
9655
|
-
Defined in: [lib/kv.ts:
|
|
9695
|
+
Defined in: [lib/kv.ts:594](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L594)
|
|
9656
9696
|
|
|
9657
9697
|
获取哈希值
|
|
9658
9698
|
|
|
@@ -9676,7 +9716,7 @@ Defined in: [lib/kv.ts:573](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9676
9716
|
|
|
9677
9717
|
> **hGetAll**(`key`): `Promise`\<`false` \| `Record`\<`string`, `string` \| `null`\>\>
|
|
9678
9718
|
|
|
9679
|
-
Defined in: [lib/kv.ts:
|
|
9719
|
+
Defined in: [lib/kv.ts:646](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L646)
|
|
9680
9720
|
|
|
9681
9721
|
批量获取哈希键值对
|
|
9682
9722
|
|
|
@@ -9696,7 +9736,7 @@ Defined in: [lib/kv.ts:625](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9696
9736
|
|
|
9697
9737
|
> **hGetJson**(`key`, `field`): `Promise`\<`any`\>
|
|
9698
9738
|
|
|
9699
|
-
Defined in: [lib/kv.ts:
|
|
9739
|
+
Defined in: [lib/kv.ts:612](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L612)
|
|
9700
9740
|
|
|
9701
9741
|
获取哈希 json 对象
|
|
9702
9742
|
|
|
@@ -9720,7 +9760,7 @@ Defined in: [lib/kv.ts:591](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9720
9760
|
|
|
9721
9761
|
> **hIncr**(`key`, `field`, `increment`): `Promise`\<`number` \| `false`\>
|
|
9722
9762
|
|
|
9723
|
-
Defined in: [lib/kv.ts:
|
|
9763
|
+
Defined in: [lib/kv.ts:701](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L701)
|
|
9724
9764
|
|
|
9725
9765
|
设置哈希自增自减
|
|
9726
9766
|
|
|
@@ -9754,7 +9794,7 @@ key
|
|
|
9754
9794
|
|
|
9755
9795
|
> **hKeys**(`key`): `Promise`\<`false` \| `string`[]\>
|
|
9756
9796
|
|
|
9757
|
-
Defined in: [lib/kv.ts:
|
|
9797
|
+
Defined in: [lib/kv.ts:723](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L723)
|
|
9758
9798
|
|
|
9759
9799
|
获取哈希所有字段
|
|
9760
9800
|
|
|
@@ -9774,7 +9814,7 @@ Defined in: [lib/kv.ts:702](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9774
9814
|
|
|
9775
9815
|
> **hMGet**(`key`, `fields`): `Promise`\<`false` \| `Record`\<`string`, `string` \| `null`\>\>
|
|
9776
9816
|
|
|
9777
|
-
Defined in: [lib/kv.ts:
|
|
9817
|
+
Defined in: [lib/kv.ts:629](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L629)
|
|
9778
9818
|
|
|
9779
9819
|
批量获取哈希值
|
|
9780
9820
|
|
|
@@ -9798,7 +9838,7 @@ Defined in: [lib/kv.ts:608](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9798
9838
|
|
|
9799
9839
|
> **hMSet**(`key`, `rows`): `Promise`\<`boolean`\>
|
|
9800
9840
|
|
|
9801
|
-
Defined in: [lib/kv.ts:
|
|
9841
|
+
Defined in: [lib/kv.ts:566](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L566)
|
|
9802
9842
|
|
|
9803
9843
|
批量设置哈希值
|
|
9804
9844
|
|
|
@@ -9826,7 +9866,7 @@ key / val 数组
|
|
|
9826
9866
|
|
|
9827
9867
|
> **hSet**(`key`, `field`, `val`, `mod?`): `Promise`\<`boolean`\>
|
|
9828
9868
|
|
|
9829
|
-
Defined in: [lib/kv.ts:
|
|
9869
|
+
Defined in: [lib/kv.ts:540](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L540)
|
|
9830
9870
|
|
|
9831
9871
|
设置哈希表值
|
|
9832
9872
|
|
|
@@ -9866,7 +9906,7 @@ key 名
|
|
|
9866
9906
|
|
|
9867
9907
|
> **incr**(`key`, `num?`): `Promise`\<`number` \| `false`\>
|
|
9868
9908
|
|
|
9869
|
-
Defined in: [lib/kv.ts:
|
|
9909
|
+
Defined in: [lib/kv.ts:380](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L380)
|
|
9870
9910
|
|
|
9871
9911
|
自增
|
|
9872
9912
|
|
|
@@ -9892,7 +9932,7 @@ Defined in: [lib/kv.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9892
9932
|
|
|
9893
9933
|
> **keys**(`pattern`): `Promise`\<`false` \| `string`[]\>
|
|
9894
9934
|
|
|
9895
|
-
Defined in: [lib/kv.ts:
|
|
9935
|
+
Defined in: [lib/kv.ts:453](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L453)
|
|
9896
9936
|
|
|
9897
9937
|
获取服务器上的所有 key 列表
|
|
9898
9938
|
|
|
@@ -9912,7 +9952,7 @@ Defined in: [lib/kv.ts:432](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9912
9952
|
|
|
9913
9953
|
> **lLen**(`key`): `Promise`\<`number` \| `false`\>
|
|
9914
9954
|
|
|
9915
|
-
Defined in: [lib/kv.ts:
|
|
9955
|
+
Defined in: [lib/kv.ts:830](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L830)
|
|
9916
9956
|
|
|
9917
9957
|
#### Parameters
|
|
9918
9958
|
|
|
@@ -9930,7 +9970,7 @@ Defined in: [lib/kv.ts:809](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9930
9970
|
|
|
9931
9971
|
> **lPop**(`key`): `Promise`\<`string` \| `false` \| `null`\>
|
|
9932
9972
|
|
|
9933
|
-
Defined in: [lib/kv.ts:
|
|
9973
|
+
Defined in: [lib/kv.ts:775](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L775)
|
|
9934
9974
|
|
|
9935
9975
|
#### Parameters
|
|
9936
9976
|
|
|
@@ -9948,7 +9988,7 @@ Defined in: [lib/kv.ts:754](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9948
9988
|
|
|
9949
9989
|
> **lPush**(`key`, `values`): `Promise`\<`number` \| `false`\>
|
|
9950
9990
|
|
|
9951
|
-
Defined in: [lib/kv.ts:
|
|
9991
|
+
Defined in: [lib/kv.ts:736](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L736)
|
|
9952
9992
|
|
|
9953
9993
|
#### Parameters
|
|
9954
9994
|
|
|
@@ -9970,7 +10010,7 @@ Defined in: [lib/kv.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9970
10010
|
|
|
9971
10011
|
> **lRange**(`key`, `start`, `stop`): `Promise`\<`false` \| `string`[]\>
|
|
9972
10012
|
|
|
9973
|
-
Defined in: [lib/kv.ts:
|
|
10013
|
+
Defined in: [lib/kv.ts:817](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L817)
|
|
9974
10014
|
|
|
9975
10015
|
#### Parameters
|
|
9976
10016
|
|
|
@@ -10040,7 +10080,7 @@ key / val 数组
|
|
|
10040
10080
|
|
|
10041
10081
|
> **ping**(): `Promise`\<`string` \| `false`\>
|
|
10042
10082
|
|
|
10043
|
-
Defined in: [lib/kv.ts:
|
|
10083
|
+
Defined in: [lib/kv.ts:520](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L520)
|
|
10044
10084
|
|
|
10045
10085
|
发送 ping
|
|
10046
10086
|
|
|
@@ -10148,7 +10188,7 @@ Defined in: [lib/kv.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10148
10188
|
|
|
10149
10189
|
> **rPop**(`key`): `Promise`\<`string` \| `false` \| `null`\>
|
|
10150
10190
|
|
|
10151
|
-
Defined in: [lib/kv.ts:
|
|
10191
|
+
Defined in: [lib/kv.ts:788](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L788)
|
|
10152
10192
|
|
|
10153
10193
|
#### Parameters
|
|
10154
10194
|
|
|
@@ -10166,7 +10206,7 @@ Defined in: [lib/kv.ts:767](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10166
10206
|
|
|
10167
10207
|
> **rPush**(`key`, `values`): `Promise`\<`number` \| `false`\>
|
|
10168
10208
|
|
|
10169
|
-
Defined in: [lib/kv.ts:
|
|
10209
|
+
Defined in: [lib/kv.ts:749](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L749)
|
|
10170
10210
|
|
|
10171
10211
|
#### Parameters
|
|
10172
10212
|
|
|
@@ -10188,7 +10228,7 @@ Defined in: [lib/kv.ts:728](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10188
10228
|
|
|
10189
10229
|
> **scan**(`cursor?`, `pattern?`, `count?`): `Promise`\<`false` \| `IScanResult`\<`string`\>\>
|
|
10190
10230
|
|
|
10191
|
-
Defined in: [lib/kv.ts:
|
|
10231
|
+
Defined in: [lib/kv.ts:479](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L479)
|
|
10192
10232
|
|
|
10193
10233
|
根据条件获取服务器上的 keys
|
|
10194
10234
|
|
|
@@ -10280,7 +10320,7 @@ Defined in: [lib/kv.ts:235](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10280
10320
|
|
|
10281
10321
|
> **zAdd**(`key`, `score`, `member`): `Promise`\<`boolean`\>
|
|
10282
10322
|
|
|
10283
|
-
Defined in: [lib/kv.ts:
|
|
10323
|
+
Defined in: [lib/kv.ts:849](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L849)
|
|
10284
10324
|
|
|
10285
10325
|
添加有序集合元素(单个元素)
|
|
10286
10326
|
|
|
@@ -10312,7 +10352,7 @@ key 名
|
|
|
10312
10352
|
|
|
10313
10353
|
> **zAdd**(`key`, `elements`, `options`): `Promise`\<`number` \| `false`\>
|
|
10314
10354
|
|
|
10315
|
-
Defined in: [lib/kv.ts:
|
|
10355
|
+
Defined in: [lib/kv.ts:856](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L856)
|
|
10316
10356
|
|
|
10317
10357
|
添加有序集合元素(多个元素,含 INCR 选项)
|
|
10318
10358
|
|
|
@@ -10344,7 +10384,7 @@ key 名
|
|
|
10344
10384
|
|
|
10345
10385
|
> **zAdd**(`key`, `elements`, `options`): `Promise`\<`number` \| `false` \| `null`\>
|
|
10346
10386
|
|
|
10347
|
-
Defined in: [lib/kv.ts:
|
|
10387
|
+
Defined in: [lib/kv.ts:863](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L863)
|
|
10348
10388
|
|
|
10349
10389
|
添加有序集合元素(多个元素,含 INCR 选项,可空)
|
|
10350
10390
|
|
|
@@ -10376,7 +10416,7 @@ key 名
|
|
|
10376
10416
|
|
|
10377
10417
|
> **zAdd**(`key`, `elements`, `options?`): `Promise`\<`number` \| `false`\>
|
|
10378
10418
|
|
|
10379
|
-
Defined in: [lib/kv.ts:
|
|
10419
|
+
Defined in: [lib/kv.ts:870](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L870)
|
|
10380
10420
|
|
|
10381
10421
|
添加有序集合元素(多个元素)
|
|
10382
10422
|
|
|
@@ -10410,7 +10450,7 @@ key 名
|
|
|
10410
10450
|
|
|
10411
10451
|
> **zRangeWithScores**(`key`, `start`, `stop`, `options?`): `Promise`\<`false` \| `object`[]\>
|
|
10412
10452
|
|
|
10413
|
-
Defined in: [lib/kv.ts:
|
|
10453
|
+
Defined in: [lib/kv.ts:891](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L891)
|
|
10414
10454
|
|
|
10415
10455
|
#### Parameters
|
|
10416
10456
|
|
|
@@ -10440,7 +10480,7 @@ Defined in: [lib/kv.ts:870](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10440
10480
|
|
|
10441
10481
|
> **zRem**(`key`, `members`): `Promise`\<`number` \| `false`\>
|
|
10442
10482
|
|
|
10443
|
-
Defined in: [lib/kv.ts:
|
|
10483
|
+
Defined in: [lib/kv.ts:916](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L916)
|
|
10444
10484
|
|
|
10445
10485
|
#### Parameters
|
|
10446
10486
|
|
|
@@ -10469,7 +10509,7 @@ lib/kv/functions/get.md
|
|
|
10469
10509
|
|
|
10470
10510
|
> **get**(`ctrEtc`, `oetc?`): [`Kv`](../classes/Kv.md)
|
|
10471
10511
|
|
|
10472
|
-
Defined in: [lib/kv.ts:
|
|
10512
|
+
Defined in: [lib/kv.ts:977](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L977)
|
|
10473
10513
|
|
|
10474
10514
|
获取 Kv 对象
|
|
10475
10515
|
|
|
@@ -10536,7 +10576,7 @@ lib/kv/interfaces/IConnectionInfo.md
|
|
|
10536
10576
|
|
|
10537
10577
|
# Interface: IConnectionInfo
|
|
10538
10578
|
|
|
10539
|
-
Defined in: [lib/kv.ts:
|
|
10579
|
+
Defined in: [lib/kv.ts:993](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L993)
|
|
10540
10580
|
|
|
10541
10581
|
连接信息
|
|
10542
10582
|
|
|
@@ -10546,7 +10586,7 @@ Defined in: [lib/kv.ts:972](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10546
10586
|
|
|
10547
10587
|
> **conn**: `ICommandClient`
|
|
10548
10588
|
|
|
10549
|
-
Defined in: [lib/kv.ts:
|
|
10589
|
+
Defined in: [lib/kv.ts:997](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L997)
|
|
10550
10590
|
|
|
10551
10591
|
***
|
|
10552
10592
|
|
|
@@ -10554,7 +10594,7 @@ Defined in: [lib/kv.ts:976](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10554
10594
|
|
|
10555
10595
|
> **host**: `string`
|
|
10556
10596
|
|
|
10557
|
-
Defined in: [lib/kv.ts:
|
|
10597
|
+
Defined in: [lib/kv.ts:994](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L994)
|
|
10558
10598
|
|
|
10559
10599
|
***
|
|
10560
10600
|
|
|
@@ -10562,7 +10602,7 @@ Defined in: [lib/kv.ts:973](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10562
10602
|
|
|
10563
10603
|
> **index**: `number`
|
|
10564
10604
|
|
|
10565
|
-
Defined in: [lib/kv.ts:
|
|
10605
|
+
Defined in: [lib/kv.ts:996](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L996)
|
|
10566
10606
|
|
|
10567
10607
|
***
|
|
10568
10608
|
|
|
@@ -10570,7 +10610,7 @@ Defined in: [lib/kv.ts:975](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
10570
10610
|
|
|
10571
10611
|
> **port**: `number`
|
|
10572
10612
|
|
|
10573
|
-
Defined in: [lib/kv.ts:
|
|
10613
|
+
Defined in: [lib/kv.ts:995](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L995)
|
|
10574
10614
|
|
|
10575
10615
|
lib/kv/interfaces/IZRangeOptions.md
|
|
10576
10616
|
---
|
|
@@ -10785,201 +10825,6 @@ lib/lan/index.md
|
|
|
10785
10825
|
- [card](functions/card.md)
|
|
10786
10826
|
- [scan](functions/scan.md)
|
|
10787
10827
|
|
|
10788
|
-
lib/net/formdata/classes/FormData.md
|
|
10789
|
-
---
|
|
10790
|
-
|
|
10791
|
-
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
10792
|
-
|
|
10793
|
-
***
|
|
10794
|
-
|
|
10795
|
-
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/formdata](../index.md) / FormData
|
|
10796
|
-
|
|
10797
|
-
# Class: FormData
|
|
10798
|
-
|
|
10799
|
-
Defined in: [lib/net/formdata.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L37)
|
|
10800
|
-
|
|
10801
|
-
## Extends
|
|
10802
|
-
|
|
10803
|
-
- `Readable`
|
|
10804
|
-
|
|
10805
|
-
## Constructors
|
|
10806
|
-
|
|
10807
|
-
### Constructor
|
|
10808
|
-
|
|
10809
|
-
> **new FormData**(`options?`): `FormData`
|
|
10810
|
-
|
|
10811
|
-
Defined in: node\_modules/@types/node/stream.d.ts:81
|
|
10812
|
-
|
|
10813
|
-
#### Parameters
|
|
10814
|
-
|
|
10815
|
-
##### options?
|
|
10816
|
-
|
|
10817
|
-
`ReadableOptions`\<`Readable`\>
|
|
10818
|
-
|
|
10819
|
-
#### Returns
|
|
10820
|
-
|
|
10821
|
-
`FormData`
|
|
10822
|
-
|
|
10823
|
-
#### Inherited from
|
|
10824
|
-
|
|
10825
|
-
`stream.Readable.constructor`
|
|
10826
|
-
|
|
10827
|
-
## Methods
|
|
10828
|
-
|
|
10829
|
-
### \_read()
|
|
10830
|
-
|
|
10831
|
-
> **\_read**(): `void`
|
|
10832
|
-
|
|
10833
|
-
Defined in: [lib/net/formdata.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L146)
|
|
10834
|
-
|
|
10835
|
-
间隔读取(on data 或 pipe 触发)
|
|
10836
|
-
|
|
10837
|
-
#### Returns
|
|
10838
|
-
|
|
10839
|
-
`void`
|
|
10840
|
-
|
|
10841
|
-
#### Overrides
|
|
10842
|
-
|
|
10843
|
-
`stream.Readable._read`
|
|
10844
|
-
|
|
10845
|
-
***
|
|
10846
|
-
|
|
10847
|
-
### getBoundary()
|
|
10848
|
-
|
|
10849
|
-
> **getBoundary**(): `string`
|
|
10850
|
-
|
|
10851
|
-
Defined in: [lib/net/formdata.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L124)
|
|
10852
|
-
|
|
10853
|
-
获取 boundary
|
|
10854
|
-
|
|
10855
|
-
#### Returns
|
|
10856
|
-
|
|
10857
|
-
`string`
|
|
10858
|
-
|
|
10859
|
-
***
|
|
10860
|
-
|
|
10861
|
-
### getLength()
|
|
10862
|
-
|
|
10863
|
-
> **getLength**(): `number`
|
|
10864
|
-
|
|
10865
|
-
Defined in: [lib/net/formdata.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L131)
|
|
10866
|
-
|
|
10867
|
-
获取总字节长度
|
|
10868
|
-
|
|
10869
|
-
#### Returns
|
|
10870
|
-
|
|
10871
|
-
`number`
|
|
10872
|
-
|
|
10873
|
-
***
|
|
10874
|
-
|
|
10875
|
-
### getSent()
|
|
10876
|
-
|
|
10877
|
-
> **getSent**(): `number`
|
|
10878
|
-
|
|
10879
|
-
Defined in: [lib/net/formdata.ts:138](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L138)
|
|
10880
|
-
|
|
10881
|
-
获取已发送的字节长度
|
|
10882
|
-
|
|
10883
|
-
#### Returns
|
|
10884
|
-
|
|
10885
|
-
`number`
|
|
10886
|
-
|
|
10887
|
-
***
|
|
10888
|
-
|
|
10889
|
-
### putBuffer()
|
|
10890
|
-
|
|
10891
|
-
> **putBuffer**(`key`, `buffer`, `fname`): `void`
|
|
10892
|
-
|
|
10893
|
-
Defined in: [lib/net/formdata.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L109)
|
|
10894
|
-
|
|
10895
|
-
添加 Buffer 数据
|
|
10896
|
-
|
|
10897
|
-
#### Parameters
|
|
10898
|
-
|
|
10899
|
-
##### key
|
|
10900
|
-
|
|
10901
|
-
`string`
|
|
10902
|
-
|
|
10903
|
-
键
|
|
10904
|
-
|
|
10905
|
-
##### buffer
|
|
10906
|
-
|
|
10907
|
-
`Buffer`
|
|
10908
|
-
|
|
10909
|
-
Buffer 数据
|
|
10910
|
-
|
|
10911
|
-
##### fname
|
|
10912
|
-
|
|
10913
|
-
`string`
|
|
10914
|
-
|
|
10915
|
-
文件名
|
|
10916
|
-
|
|
10917
|
-
#### Returns
|
|
10918
|
-
|
|
10919
|
-
`void`
|
|
10920
|
-
|
|
10921
|
-
***
|
|
10922
|
-
|
|
10923
|
-
### putFile()
|
|
10924
|
-
|
|
10925
|
-
> **putFile**(`key`, `path`, `fname?`): `Promise`\<`boolean`\>
|
|
10926
|
-
|
|
10927
|
-
Defined in: [lib/net/formdata.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L81)
|
|
10928
|
-
|
|
10929
|
-
添加文件
|
|
10930
|
-
|
|
10931
|
-
#### Parameters
|
|
10932
|
-
|
|
10933
|
-
##### key
|
|
10934
|
-
|
|
10935
|
-
`string`
|
|
10936
|
-
|
|
10937
|
-
键
|
|
10938
|
-
|
|
10939
|
-
##### path
|
|
10940
|
-
|
|
10941
|
-
`string`
|
|
10942
|
-
|
|
10943
|
-
路径
|
|
10944
|
-
|
|
10945
|
-
##### fname?
|
|
10946
|
-
|
|
10947
|
-
`string`
|
|
10948
|
-
|
|
10949
|
-
可选,文件名
|
|
10950
|
-
|
|
10951
|
-
#### Returns
|
|
10952
|
-
|
|
10953
|
-
`Promise`\<`boolean`\>
|
|
10954
|
-
|
|
10955
|
-
***
|
|
10956
|
-
|
|
10957
|
-
### putString()
|
|
10958
|
-
|
|
10959
|
-
> **putString**(`key`, `val`): `void`
|
|
10960
|
-
|
|
10961
|
-
Defined in: [lib/net/formdata.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L65)
|
|
10962
|
-
|
|
10963
|
-
添加字符串
|
|
10964
|
-
|
|
10965
|
-
#### Parameters
|
|
10966
|
-
|
|
10967
|
-
##### key
|
|
10968
|
-
|
|
10969
|
-
`string`
|
|
10970
|
-
|
|
10971
|
-
键
|
|
10972
|
-
|
|
10973
|
-
##### val
|
|
10974
|
-
|
|
10975
|
-
`string`
|
|
10976
|
-
|
|
10977
|
-
值
|
|
10978
|
-
|
|
10979
|
-
#### Returns
|
|
10980
|
-
|
|
10981
|
-
`void`
|
|
10982
|
-
|
|
10983
10828
|
lib/net/formdata/index.md
|
|
10984
10829
|
---
|
|
10985
10830
|
|
|
@@ -10991,112 +10836,17 @@ lib/net/formdata/index.md
|
|
|
10991
10836
|
|
|
10992
10837
|
# lib/net/formdata
|
|
10993
10838
|
|
|
10994
|
-
##
|
|
10995
|
-
|
|
10996
|
-
- [FormData](classes/FormData.md)
|
|
10997
|
-
|
|
10998
|
-
## Type Aliases
|
|
10999
|
-
|
|
11000
|
-
- [IItem](type-aliases/IItem.md)
|
|
11001
|
-
|
|
11002
|
-
lib/net/formdata/type-aliases/IItem.md
|
|
11003
|
-
---
|
|
11004
|
-
|
|
11005
|
-
[**Documents for @maiyunnet/kebab**](../../../../index.md)
|
|
11006
|
-
|
|
11007
|
-
***
|
|
11008
|
-
|
|
11009
|
-
[Documents for @maiyunnet/kebab](../../../../index.md) / [lib/net/formdata](../index.md) / IItem
|
|
11010
|
-
|
|
11011
|
-
# Type Alias: IItem
|
|
11012
|
-
|
|
11013
|
-
> **IItem** = \{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \} \| \{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \} \| \{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
11014
|
-
|
|
11015
|
-
Defined in: [lib/net/formdata.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/net/formdata.ts#L12)
|
|
11016
|
-
|
|
11017
|
-
Item 对象
|
|
11018
|
-
|
|
11019
|
-
## Union Members
|
|
11020
|
-
|
|
11021
|
-
### Type Literal
|
|
11022
|
-
|
|
11023
|
-
\{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \}
|
|
11024
|
-
|
|
11025
|
-
#### key
|
|
11026
|
-
|
|
11027
|
-
> **key**: `string`
|
|
11028
|
-
|
|
11029
|
-
key 键
|
|
11030
|
-
|
|
11031
|
-
#### path
|
|
11032
|
-
|
|
11033
|
-
> **path**: `""`
|
|
11034
|
-
|
|
11035
|
-
#### type
|
|
11036
|
-
|
|
11037
|
-
> **type**: `"string"`
|
|
11038
|
-
|
|
11039
|
-
#### value
|
|
11040
|
-
|
|
11041
|
-
> **value**: `string`
|
|
11042
|
-
|
|
11043
|
-
字符串值
|
|
11044
|
-
|
|
11045
|
-
***
|
|
11046
|
-
|
|
11047
|
-
### Type Literal
|
|
11048
|
-
|
|
11049
|
-
\{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \}
|
|
11050
|
-
|
|
11051
|
-
#### key
|
|
11052
|
-
|
|
11053
|
-
> **key**: `string`
|
|
11054
|
-
|
|
11055
|
-
key 键
|
|
11056
|
-
|
|
11057
|
-
#### path
|
|
11058
|
-
|
|
11059
|
-
> **path**: `string`
|
|
11060
|
-
|
|
11061
|
-
文件路径
|
|
11062
|
-
|
|
11063
|
-
#### type
|
|
11064
|
-
|
|
11065
|
-
> **type**: `"file"`
|
|
11066
|
-
|
|
11067
|
-
#### value
|
|
10839
|
+
## References
|
|
11068
10840
|
|
|
11069
|
-
|
|
10841
|
+
### FormData
|
|
11070
10842
|
|
|
11071
|
-
|
|
10843
|
+
Re-exports [FormData](../../undici/formdata/classes/FormData.md)
|
|
11072
10844
|
|
|
11073
10845
|
***
|
|
11074
10846
|
|
|
11075
|
-
###
|
|
11076
|
-
|
|
11077
|
-
\{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
11078
|
-
|
|
11079
|
-
#### key
|
|
11080
|
-
|
|
11081
|
-
> **key**: `string`
|
|
11082
|
-
|
|
11083
|
-
key 键
|
|
11084
|
-
|
|
11085
|
-
#### path
|
|
11086
|
-
|
|
11087
|
-
> **path**: `Buffer`
|
|
11088
|
-
|
|
11089
|
-
Buffer 数据
|
|
11090
|
-
|
|
11091
|
-
#### type
|
|
11092
|
-
|
|
11093
|
-
> **type**: `"buffer"`
|
|
11094
|
-
|
|
11095
|
-
#### value
|
|
10847
|
+
### IItem
|
|
11096
10848
|
|
|
11097
|
-
|
|
11098
|
-
|
|
11099
|
-
文件名
|
|
10849
|
+
Re-exports [IItem](../../undici/formdata/type-aliases/IItem.md)
|
|
11100
10850
|
|
|
11101
10851
|
lib/net/functions/fetch.md
|
|
11102
10852
|
---
|
|
@@ -11146,7 +10896,7 @@ lib/net/functions/filterHeaders.md
|
|
|
11146
10896
|
|
|
11147
10897
|
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
11148
10898
|
|
|
11149
|
-
Defined in: [lib/net.ts:
|
|
10899
|
+
Defined in: [lib/net.ts:547](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L547)
|
|
11150
10900
|
|
|
11151
10901
|
剔除不代理的 header,返回新的 header
|
|
11152
10902
|
|
|
@@ -11206,15 +10956,15 @@ lib/net/functions/getFormData.md
|
|
|
11206
10956
|
|
|
11207
10957
|
# Function: getFormData()
|
|
11208
10958
|
|
|
11209
|
-
> **getFormData**(): [`FormData`](
|
|
10959
|
+
> **getFormData**(): [`FormData`](../../undici/formdata/classes/FormData.md)
|
|
11210
10960
|
|
|
11211
|
-
Defined in: [lib/net.ts:
|
|
10961
|
+
Defined in: [lib/net.ts:531](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L531)
|
|
11212
10962
|
|
|
11213
10963
|
创建 FormData 对象
|
|
11214
10964
|
|
|
11215
10965
|
## Returns
|
|
11216
10966
|
|
|
11217
|
-
[`FormData`](
|
|
10967
|
+
[`FormData`](../../undici/formdata/classes/FormData.md)
|
|
11218
10968
|
|
|
11219
10969
|
lib/net/functions/get.md
|
|
11220
10970
|
---
|
|
@@ -11301,7 +11051,7 @@ lib/net/functions/mproxyData.md
|
|
|
11301
11051
|
|
|
11302
11052
|
> **mproxyData**(`ctr`): `any`
|
|
11303
11053
|
|
|
11304
|
-
Defined in: [lib/net.ts:
|
|
11054
|
+
Defined in: [lib/net.ts:635](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L635)
|
|
11305
11055
|
|
|
11306
11056
|
获取 mproxy 的附加数据
|
|
11307
11057
|
|
|
@@ -11330,7 +11080,7 @@ lib/net/functions/mproxy.md
|
|
|
11330
11080
|
|
|
11331
11081
|
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
11332
11082
|
|
|
11333
|
-
Defined in: [lib/net.ts:
|
|
11083
|
+
Defined in: [lib/net.ts:583](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L583)
|
|
11334
11084
|
|
|
11335
11085
|
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
11336
11086
|
get: url, auth
|
|
@@ -11604,7 +11354,7 @@ lib/net/functions/rproxy.md
|
|
|
11604
11354
|
|
|
11605
11355
|
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
11606
11356
|
|
|
11607
|
-
Defined in: [lib/net.ts:
|
|
11357
|
+
Defined in: [lib/net.ts:653](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L653)
|
|
11608
11358
|
|
|
11609
11359
|
反向代理,注意提前处理不要自动处理 post 数据,将本服务器的某个路由反代到其他网址
|
|
11610
11360
|
|
|
@@ -11682,7 +11432,7 @@ lib/net/interfaces/IMproxyOptions.md
|
|
|
11682
11432
|
|
|
11683
11433
|
# Interface: IMproxyOptions
|
|
11684
11434
|
|
|
11685
|
-
Defined in: [lib/net.ts:
|
|
11435
|
+
Defined in: [lib/net.ts:737](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L737)
|
|
11686
11436
|
|
|
11687
11437
|
正向代理请求的传入参数选项
|
|
11688
11438
|
|
|
@@ -11692,7 +11442,7 @@ Defined in: [lib/net.ts:723](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11692
11442
|
|
|
11693
11443
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
11694
11444
|
|
|
11695
|
-
Defined in: [lib/net.ts:
|
|
11445
|
+
Defined in: [lib/net.ts:746](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L746)
|
|
11696
11446
|
|
|
11697
11447
|
过滤 header,返回 true 则留下
|
|
11698
11448
|
|
|
@@ -11712,7 +11462,7 @@ Defined in: [lib/net.ts:732](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11712
11462
|
|
|
11713
11463
|
> `optional` **follow?**: `number`
|
|
11714
11464
|
|
|
11715
|
-
Defined in: [lib/net.ts:
|
|
11465
|
+
Defined in: [lib/net.ts:740](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L740)
|
|
11716
11466
|
|
|
11717
11467
|
***
|
|
11718
11468
|
|
|
@@ -11720,7 +11470,7 @@ Defined in: [lib/net.ts:726](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11720
11470
|
|
|
11721
11471
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11722
11472
|
|
|
11723
|
-
Defined in: [lib/net.ts:
|
|
11473
|
+
Defined in: [lib/net.ts:744](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L744)
|
|
11724
11474
|
|
|
11725
11475
|
***
|
|
11726
11476
|
|
|
@@ -11728,7 +11478,7 @@ Defined in: [lib/net.ts:730](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11728
11478
|
|
|
11729
11479
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11730
11480
|
|
|
11731
|
-
Defined in: [lib/net.ts:
|
|
11481
|
+
Defined in: [lib/net.ts:742](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L742)
|
|
11732
11482
|
|
|
11733
11483
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11734
11484
|
|
|
@@ -11738,7 +11488,7 @@ Defined in: [lib/net.ts:728](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11738
11488
|
|
|
11739
11489
|
> `optional` **local?**: `string`
|
|
11740
11490
|
|
|
11741
|
-
Defined in: [lib/net.ts:
|
|
11491
|
+
Defined in: [lib/net.ts:743](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L743)
|
|
11742
11492
|
|
|
11743
11493
|
***
|
|
11744
11494
|
|
|
@@ -11746,7 +11496,7 @@ Defined in: [lib/net.ts:729](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11746
11496
|
|
|
11747
11497
|
> `optional` **reuse?**: `string`
|
|
11748
11498
|
|
|
11749
|
-
Defined in: [lib/net.ts:
|
|
11499
|
+
Defined in: [lib/net.ts:748](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L748)
|
|
11750
11500
|
|
|
11751
11501
|
默认为 default
|
|
11752
11502
|
|
|
@@ -11756,7 +11506,7 @@ Defined in: [lib/net.ts:734](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11756
11506
|
|
|
11757
11507
|
> `optional` **timeout?**: `number`
|
|
11758
11508
|
|
|
11759
|
-
Defined in: [lib/net.ts:
|
|
11509
|
+
Defined in: [lib/net.ts:739](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L739)
|
|
11760
11510
|
|
|
11761
11511
|
秒数
|
|
11762
11512
|
|
|
@@ -11771,7 +11521,7 @@ lib/net/interfaces/IRequestOptions.md
|
|
|
11771
11521
|
|
|
11772
11522
|
# Interface: IRequestOptions
|
|
11773
11523
|
|
|
11774
|
-
Defined in: [lib/net.ts:
|
|
11524
|
+
Defined in: [lib/net.ts:706](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L706)
|
|
11775
11525
|
|
|
11776
11526
|
请求的传入参数选项
|
|
11777
11527
|
|
|
@@ -11781,7 +11531,7 @@ Defined in: [lib/net.ts:692](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11781
11531
|
|
|
11782
11532
|
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
11783
11533
|
|
|
11784
|
-
Defined in: [lib/net.ts:
|
|
11534
|
+
Defined in: [lib/net.ts:731](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L731)
|
|
11785
11535
|
|
|
11786
11536
|
cookie 托管对象
|
|
11787
11537
|
|
|
@@ -11791,7 +11541,7 @@ cookie 托管对象
|
|
|
11791
11541
|
|
|
11792
11542
|
> `optional` **follow?**: `number`
|
|
11793
11543
|
|
|
11794
|
-
Defined in: [lib/net.ts:
|
|
11544
|
+
Defined in: [lib/net.ts:712](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L712)
|
|
11795
11545
|
|
|
11796
11546
|
追踪 location 次数,0 为不追踪,默认为 0
|
|
11797
11547
|
|
|
@@ -11801,7 +11551,7 @@ Defined in: [lib/net.ts:698](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11801
11551
|
|
|
11802
11552
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11803
11553
|
|
|
11804
|
-
Defined in: [lib/net.ts:
|
|
11554
|
+
Defined in: [lib/net.ts:717](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L717)
|
|
11805
11555
|
|
|
11806
11556
|
***
|
|
11807
11557
|
|
|
@@ -11809,7 +11559,7 @@ Defined in: [lib/net.ts:703](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11809
11559
|
|
|
11810
11560
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11811
11561
|
|
|
11812
|
-
Defined in: [lib/net.ts:
|
|
11562
|
+
Defined in: [lib/net.ts:714](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L714)
|
|
11813
11563
|
|
|
11814
11564
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11815
11565
|
|
|
@@ -11819,7 +11569,7 @@ Defined in: [lib/net.ts:700](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11819
11569
|
|
|
11820
11570
|
> `optional` **keep?**: `boolean`
|
|
11821
11571
|
|
|
11822
|
-
Defined in: [lib/net.ts:
|
|
11572
|
+
Defined in: [lib/net.ts:727](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L727)
|
|
11823
11573
|
|
|
11824
11574
|
连接是否保持长连接(即是否允许复用),默认为 true
|
|
11825
11575
|
|
|
@@ -11829,7 +11579,7 @@ Defined in: [lib/net.ts:713](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11829
11579
|
|
|
11830
11580
|
> `optional` **local?**: `string`
|
|
11831
11581
|
|
|
11832
|
-
Defined in: [lib/net.ts:
|
|
11582
|
+
Defined in: [lib/net.ts:716](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L716)
|
|
11833
11583
|
|
|
11834
11584
|
***
|
|
11835
11585
|
|
|
@@ -11837,7 +11587,7 @@ Defined in: [lib/net.ts:702](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11837
11587
|
|
|
11838
11588
|
> `optional` **log?**: `boolean`
|
|
11839
11589
|
|
|
11840
|
-
Defined in: [lib/net.ts:
|
|
11590
|
+
Defined in: [lib/net.ts:733](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L733)
|
|
11841
11591
|
|
|
11842
11592
|
若有异常写入文件日志,默认为 true
|
|
11843
11593
|
|
|
@@ -11847,7 +11597,7 @@ Defined in: [lib/net.ts:719](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11847
11597
|
|
|
11848
11598
|
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
11849
11599
|
|
|
11850
|
-
Defined in: [lib/net.ts:
|
|
11600
|
+
Defined in: [lib/net.ts:707](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L707)
|
|
11851
11601
|
|
|
11852
11602
|
***
|
|
11853
11603
|
|
|
@@ -11855,7 +11605,7 @@ Defined in: [lib/net.ts:693](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11855
11605
|
|
|
11856
11606
|
> `optional` **mproxy?**: `object`
|
|
11857
11607
|
|
|
11858
|
-
Defined in: [lib/net.ts:
|
|
11608
|
+
Defined in: [lib/net.ts:719](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L719)
|
|
11859
11609
|
|
|
11860
11610
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
11861
11611
|
|
|
@@ -11883,7 +11633,7 @@ Defined in: [lib/net.ts:705](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11883
11633
|
|
|
11884
11634
|
> `optional` **reuse?**: `string`
|
|
11885
11635
|
|
|
11886
|
-
Defined in: [lib/net.ts:
|
|
11636
|
+
Defined in: [lib/net.ts:729](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L729)
|
|
11887
11637
|
|
|
11888
11638
|
复用池名,默认为 default
|
|
11889
11639
|
|
|
@@ -11893,7 +11643,7 @@ Defined in: [lib/net.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11893
11643
|
|
|
11894
11644
|
> `optional` **save?**: `string`
|
|
11895
11645
|
|
|
11896
|
-
Defined in: [lib/net.ts:
|
|
11646
|
+
Defined in: [lib/net.ts:715](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L715)
|
|
11897
11647
|
|
|
11898
11648
|
***
|
|
11899
11649
|
|
|
@@ -11901,7 +11651,7 @@ Defined in: [lib/net.ts:701](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11901
11651
|
|
|
11902
11652
|
> `optional` **timeout?**: `number`
|
|
11903
11653
|
|
|
11904
|
-
Defined in: [lib/net.ts:
|
|
11654
|
+
Defined in: [lib/net.ts:710](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L710)
|
|
11905
11655
|
|
|
11906
11656
|
秒数,默认 10 秒
|
|
11907
11657
|
|
|
@@ -11911,7 +11661,7 @@ Defined in: [lib/net.ts:696](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11911
11661
|
|
|
11912
11662
|
> `optional` **type?**: `"form"` \| `"json"`
|
|
11913
11663
|
|
|
11914
|
-
Defined in: [lib/net.ts:
|
|
11664
|
+
Defined in: [lib/net.ts:708](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L708)
|
|
11915
11665
|
|
|
11916
11666
|
lib/net/interfaces/IRproxyOptions.md
|
|
11917
11667
|
---
|
|
@@ -11924,7 +11674,7 @@ lib/net/interfaces/IRproxyOptions.md
|
|
|
11924
11674
|
|
|
11925
11675
|
# Interface: IRproxyOptions
|
|
11926
11676
|
|
|
11927
|
-
Defined in: [lib/net.ts:
|
|
11677
|
+
Defined in: [lib/net.ts:752](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L752)
|
|
11928
11678
|
|
|
11929
11679
|
反向代理请求的传入参数选项
|
|
11930
11680
|
|
|
@@ -11934,7 +11684,7 @@ Defined in: [lib/net.ts:738](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11934
11684
|
|
|
11935
11685
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
11936
11686
|
|
|
11937
|
-
Defined in: [lib/net.ts:
|
|
11687
|
+
Defined in: [lib/net.ts:761](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L761)
|
|
11938
11688
|
|
|
11939
11689
|
过滤 header,返回 true 则留下
|
|
11940
11690
|
|
|
@@ -11954,7 +11704,7 @@ Defined in: [lib/net.ts:747](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11954
11704
|
|
|
11955
11705
|
> `optional` **follow?**: `number`
|
|
11956
11706
|
|
|
11957
|
-
Defined in: [lib/net.ts:
|
|
11707
|
+
Defined in: [lib/net.ts:755](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L755)
|
|
11958
11708
|
|
|
11959
11709
|
***
|
|
11960
11710
|
|
|
@@ -11962,7 +11712,7 @@ Defined in: [lib/net.ts:741](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11962
11712
|
|
|
11963
11713
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11964
11714
|
|
|
11965
|
-
Defined in: [lib/net.ts:
|
|
11715
|
+
Defined in: [lib/net.ts:759](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L759)
|
|
11966
11716
|
|
|
11967
11717
|
***
|
|
11968
11718
|
|
|
@@ -11970,7 +11720,7 @@ Defined in: [lib/net.ts:745](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11970
11720
|
|
|
11971
11721
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11972
11722
|
|
|
11973
|
-
Defined in: [lib/net.ts:
|
|
11723
|
+
Defined in: [lib/net.ts:757](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L757)
|
|
11974
11724
|
|
|
11975
11725
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11976
11726
|
|
|
@@ -11980,7 +11730,7 @@ Defined in: [lib/net.ts:743](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11980
11730
|
|
|
11981
11731
|
> `optional` **local?**: `string`
|
|
11982
11732
|
|
|
11983
|
-
Defined in: [lib/net.ts:
|
|
11733
|
+
Defined in: [lib/net.ts:758](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L758)
|
|
11984
11734
|
|
|
11985
11735
|
***
|
|
11986
11736
|
|
|
@@ -11988,7 +11738,7 @@ Defined in: [lib/net.ts:744](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11988
11738
|
|
|
11989
11739
|
> `optional` **mproxy?**: `object`
|
|
11990
11740
|
|
|
11991
|
-
Defined in: [lib/net.ts:
|
|
11741
|
+
Defined in: [lib/net.ts:763](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L763)
|
|
11992
11742
|
|
|
11993
11743
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
11994
11744
|
|
|
@@ -12016,7 +11766,7 @@ Defined in: [lib/net.ts:749](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12016
11766
|
|
|
12017
11767
|
> `optional` **reuse?**: `string`
|
|
12018
11768
|
|
|
12019
|
-
Defined in: [lib/net.ts:
|
|
11769
|
+
Defined in: [lib/net.ts:771](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L771)
|
|
12020
11770
|
|
|
12021
11771
|
默认为 default
|
|
12022
11772
|
|
|
@@ -12026,7 +11776,7 @@ Defined in: [lib/net.ts:757](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12026
11776
|
|
|
12027
11777
|
> `optional` **timeout?**: `number`
|
|
12028
11778
|
|
|
12029
|
-
Defined in: [lib/net.ts:
|
|
11779
|
+
Defined in: [lib/net.ts:754](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L754)
|
|
12030
11780
|
|
|
12031
11781
|
秒数
|
|
12032
11782
|
|
|
@@ -12487,7 +12237,7 @@ lib/net/type-aliases/THttpHeaders.md
|
|
|
12487
12237
|
|
|
12488
12238
|
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
12489
12239
|
|
|
12490
|
-
Defined in: [lib/net.ts:
|
|
12240
|
+
Defined in: [lib/net.ts:776](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L776)
|
|
12491
12241
|
|
|
12492
12242
|
http headers
|
|
12493
12243
|
|
|
@@ -13371,7 +13121,7 @@ Defined in: [lib/scan.ts:58](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13371
13121
|
|
|
13372
13122
|
> **createToken**(): `Promise`\<`boolean`\>
|
|
13373
13123
|
|
|
13374
|
-
Defined in: [lib/scan.ts:
|
|
13124
|
+
Defined in: [lib/scan.ts:171](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L171)
|
|
13375
13125
|
|
|
13376
13126
|
创建 token,直接应用到本类
|
|
13377
13127
|
|
|
@@ -13385,7 +13135,7 @@ Defined in: [lib/scan.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
13385
13135
|
|
|
13386
13136
|
> **getTimeLeft**(): `number` \| `null`
|
|
13387
13137
|
|
|
13388
|
-
Defined in: [lib/scan.ts:
|
|
13138
|
+
Defined in: [lib/scan.ts:238](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L238)
|
|
13389
13139
|
|
|
13390
13140
|
获取当前 token 可扫剩余有效期
|
|
13391
13141
|
|
|
@@ -13399,7 +13149,7 @@ Defined in: [lib/scan.ts:223](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
13399
13149
|
|
|
13400
13150
|
> **getToken**(): `string` \| `null`
|
|
13401
13151
|
|
|
13402
|
-
Defined in: [lib/scan.ts:
|
|
13152
|
+
Defined in: [lib/scan.ts:216](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L216)
|
|
13403
13153
|
|
|
13404
13154
|
获取当前 token
|
|
13405
13155
|
|
|
@@ -13413,7 +13163,7 @@ Defined in: [lib/scan.ts:201](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
13413
13163
|
|
|
13414
13164
|
> **getTTL**(): `number`
|
|
13415
13165
|
|
|
13416
|
-
Defined in: [lib/scan.ts:
|
|
13166
|
+
Defined in: [lib/scan.ts:231](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L231)
|
|
13417
13167
|
|
|
13418
13168
|
获取设置的有效期
|
|
13419
13169
|
|
|
@@ -13443,7 +13193,7 @@ Defined in: [lib/scan.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13443
13193
|
|
|
13444
13194
|
> **setTTL**(`ttl`): `void`
|
|
13445
13195
|
|
|
13446
|
-
Defined in: [lib/scan.ts:
|
|
13196
|
+
Defined in: [lib/scan.ts:224](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L224)
|
|
13447
13197
|
|
|
13448
13198
|
设置有效期,设置后的新 token 被创建有效
|
|
13449
13199
|
|
|
@@ -13470,7 +13220,7 @@ lib/scan/functions/get.md
|
|
|
13470
13220
|
|
|
13471
13221
|
> **get**(`link`, `token?`, `opt?`): `Promise`\<[`Scan`](../classes/Scan.md)\>
|
|
13472
13222
|
|
|
13473
|
-
Defined in: [lib/scan.ts:
|
|
13223
|
+
Defined in: [lib/scan.ts:266](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L266)
|
|
13474
13224
|
|
|
13475
13225
|
-- 创建 Scan 对象
|
|
13476
13226
|
|
|
@@ -13507,7 +13257,7 @@ lib/scan/functions/scanned.md
|
|
|
13507
13257
|
|
|
13508
13258
|
> **scanned**(`link`, `token`, `opt?`): `Promise`\<`boolean`\>
|
|
13509
13259
|
|
|
13510
|
-
Defined in: [lib/scan.ts:
|
|
13260
|
+
Defined in: [lib/scan.ts:280](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L280)
|
|
13511
13261
|
|
|
13512
13262
|
对 token 执行访问操作,通常用户扫码后展示的网页所调用,代表已扫码
|
|
13513
13263
|
|
|
@@ -13548,7 +13298,7 @@ lib/scan/functions/setData.md
|
|
|
13548
13298
|
|
|
13549
13299
|
> **setData**(`link`, `token`, `data`, `opt?`): `Promise`\<`boolean`\>
|
|
13550
13300
|
|
|
13551
|
-
Defined in: [lib/scan.ts:
|
|
13301
|
+
Defined in: [lib/scan.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L338)
|
|
13552
13302
|
|
|
13553
13303
|
将数据写入 token,通常在客户的逻辑下去写,服务器会 poll 到
|
|
13554
13304
|
|
|
@@ -13715,7 +13465,7 @@ Defined in: [lib/session.ts:51](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
13715
13465
|
|
|
13716
13466
|
> **getName**(): `string`
|
|
13717
13467
|
|
|
13718
|
-
Defined in: [lib/session.ts:
|
|
13468
|
+
Defined in: [lib/session.ts:226](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L226)
|
|
13719
13469
|
|
|
13720
13470
|
获取当前的 cookie 的 name 值
|
|
13721
13471
|
|
|
@@ -13729,7 +13479,7 @@ Defined in: [lib/session.ts:224](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
13729
13479
|
|
|
13730
13480
|
> **getToken**(): `string`
|
|
13731
13481
|
|
|
13732
|
-
Defined in: [lib/session.ts:
|
|
13482
|
+
Defined in: [lib/session.ts:219](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L219)
|
|
13733
13483
|
|
|
13734
13484
|
获取当前的 token 值
|
|
13735
13485
|
|
|
@@ -13785,7 +13535,7 @@ false 表示系统错误
|
|
|
13785
13535
|
|
|
13786
13536
|
> **update**(): `Promise`\<`void`\>
|
|
13787
13537
|
|
|
13788
|
-
Defined in: [lib/session.ts:
|
|
13538
|
+
Defined in: [lib/session.ts:233](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L233)
|
|
13789
13539
|
|
|
13790
13540
|
页面整体结束时,要写入到 Kv 或 数据库
|
|
13791
13541
|
|
|
@@ -16377,7 +16127,7 @@ lib/text/functions/csvescape.md
|
|
|
16377
16127
|
|
|
16378
16128
|
> **csvescape**(`str`): `string`
|
|
16379
16129
|
|
|
16380
|
-
Defined in: [lib/text.ts:
|
|
16130
|
+
Defined in: [lib/text.ts:547](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L547)
|
|
16381
16131
|
|
|
16382
16132
|
CSV 特殊字符转换为实体字符
|
|
16383
16133
|
|
|
@@ -16404,7 +16154,7 @@ lib/text/functions/getFileExt.md
|
|
|
16404
16154
|
|
|
16405
16155
|
> **getFileExt**(`path`): `string`
|
|
16406
16156
|
|
|
16407
|
-
Defined in: [lib/text.ts:
|
|
16157
|
+
Defined in: [lib/text.ts:588](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L588)
|
|
16408
16158
|
|
|
16409
16159
|
获取文件后缀
|
|
16410
16160
|
|
|
@@ -16433,7 +16183,7 @@ lib/text/functions/getFileNameExt.md
|
|
|
16433
16183
|
|
|
16434
16184
|
> **getFileNameExt**(`path`): `object`
|
|
16435
16185
|
|
|
16436
|
-
Defined in: [lib/text.ts:
|
|
16186
|
+
Defined in: [lib/text.ts:601](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L601)
|
|
16437
16187
|
|
|
16438
16188
|
获取文件名和后缀
|
|
16439
16189
|
|
|
@@ -16470,7 +16220,7 @@ lib/text/functions/getFilename.md
|
|
|
16470
16220
|
|
|
16471
16221
|
> **getFilename**(`path`, `ext?`): `string`
|
|
16472
16222
|
|
|
16473
|
-
Defined in: [lib/text.ts:
|
|
16223
|
+
Defined in: [lib/text.ts:568](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L568)
|
|
16474
16224
|
|
|
16475
16225
|
获取文件名
|
|
16476
16226
|
|
|
@@ -16505,7 +16255,7 @@ lib/text/functions/htmlescape.md
|
|
|
16505
16255
|
|
|
16506
16256
|
> **htmlescape**(`html`): `string`
|
|
16507
16257
|
|
|
16508
|
-
Defined in: [lib/text.ts:
|
|
16258
|
+
Defined in: [lib/text.ts:533](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L533)
|
|
16509
16259
|
|
|
16510
16260
|
HTML 特殊字符转换为实体字符
|
|
16511
16261
|
|
|
@@ -16534,7 +16284,7 @@ lib/text/functions/int2str.md
|
|
|
16534
16284
|
|
|
16535
16285
|
> **int2str**(`int`, `digits?`, `decimal?`): `string`
|
|
16536
16286
|
|
|
16537
|
-
Defined in: [lib/text.ts:
|
|
16287
|
+
Defined in: [lib/text.ts:801](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L801)
|
|
16538
16288
|
|
|
16539
16289
|
为解决精度问题,将整数转换为小数字符串
|
|
16540
16290
|
以下几个示例都是当 digits 为 3、decimal 为 2 时
|
|
@@ -16580,7 +16330,7 @@ lib/text/functions/isAscii.md
|
|
|
16580
16330
|
|
|
16581
16331
|
> **isAscii**(`text`): `boolean`
|
|
16582
16332
|
|
|
16583
|
-
Defined in: [lib/text.ts:
|
|
16333
|
+
Defined in: [lib/text.ts:291](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L291)
|
|
16584
16334
|
|
|
16585
16335
|
判断是否在 ascii 字符集内,仅可输入部分
|
|
16586
16336
|
|
|
@@ -16609,7 +16359,7 @@ lib/text/functions/isDomain.md
|
|
|
16609
16359
|
|
|
16610
16360
|
> **isDomain**(`domain`): `boolean`
|
|
16611
16361
|
|
|
16612
|
-
Defined in: [lib/text.ts:
|
|
16362
|
+
Defined in: [lib/text.ts:280](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L280)
|
|
16613
16363
|
|
|
16614
16364
|
判断是否是域名
|
|
16615
16365
|
|
|
@@ -16640,7 +16390,7 @@ lib/text/functions/isEMail.md
|
|
|
16640
16390
|
|
|
16641
16391
|
> **isEMail**(`email`): `boolean`
|
|
16642
16392
|
|
|
16643
|
-
Defined in: [lib/text.ts:
|
|
16393
|
+
Defined in: [lib/text.ts:253](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L253)
|
|
16644
16394
|
|
|
16645
16395
|
是否是邮件地址
|
|
16646
16396
|
|
|
@@ -16667,7 +16417,7 @@ lib/text/functions/isFalsy.md
|
|
|
16667
16417
|
|
|
16668
16418
|
> **isFalsy**(`val`): `val is TFalsy`
|
|
16669
16419
|
|
|
16670
|
-
Defined in: [lib/text.ts:
|
|
16420
|
+
Defined in: [lib/text.ts:752](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L752)
|
|
16671
16421
|
|
|
16672
16422
|
判断一个值是否是虚假的(为 null/undefined/空字符串/false/0)
|
|
16673
16423
|
|
|
@@ -16696,7 +16446,7 @@ lib/text/functions/isIdCardCN.md
|
|
|
16696
16446
|
|
|
16697
16447
|
> **isIdCardCN**(`idcard`): `boolean`
|
|
16698
16448
|
|
|
16699
|
-
Defined in: [lib/text.ts:
|
|
16449
|
+
Defined in: [lib/text.ts:403](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L403)
|
|
16700
16450
|
|
|
16701
16451
|
是否是中国大陆身份证号码
|
|
16702
16452
|
|
|
@@ -16725,7 +16475,7 @@ lib/text/functions/isIPv4.md
|
|
|
16725
16475
|
|
|
16726
16476
|
> **isIPv4**(`ip`): `boolean`
|
|
16727
16477
|
|
|
16728
|
-
Defined in: [lib/text.ts:
|
|
16478
|
+
Defined in: [lib/text.ts:261](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L261)
|
|
16729
16479
|
|
|
16730
16480
|
是否是 IPv4(基于 Node 原生 net.isIP,严格校验)
|
|
16731
16481
|
|
|
@@ -16752,7 +16502,7 @@ lib/text/functions/isIPv6.md
|
|
|
16752
16502
|
|
|
16753
16503
|
> **isIPv6**(`ip`): `boolean`
|
|
16754
16504
|
|
|
16755
|
-
Defined in: [lib/text.ts:
|
|
16505
|
+
Defined in: [lib/text.ts:269](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L269)
|
|
16756
16506
|
|
|
16757
16507
|
是否是 IPv6(基于 Node 原生 net.isIP,严格校验)
|
|
16758
16508
|
|
|
@@ -16779,7 +16529,7 @@ lib/text/functions/isPhoneCN.md
|
|
|
16779
16529
|
|
|
16780
16530
|
> **isPhoneCN**(`p`): `boolean`
|
|
16781
16531
|
|
|
16782
|
-
Defined in: [lib/text.ts:
|
|
16532
|
+
Defined in: [lib/text.ts:395](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L395)
|
|
16783
16533
|
|
|
16784
16534
|
判断手机号是否是 11 位,不做真实性校验
|
|
16785
16535
|
|
|
@@ -16808,7 +16558,7 @@ lib/text/functions/isRealPath.md
|
|
|
16808
16558
|
|
|
16809
16559
|
> **isRealPath**(`path`): `boolean`
|
|
16810
16560
|
|
|
16811
|
-
Defined in: [lib/text.ts:
|
|
16561
|
+
Defined in: [lib/text.ts:555](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L555)
|
|
16812
16562
|
|
|
16813
16563
|
判断是否是绝对路径,是返回 true,相对路径返回 false
|
|
16814
16564
|
|
|
@@ -16824,6 +16574,41 @@ Defined in: [lib/text.ts:519](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16824
16574
|
|
|
16825
16575
|
`boolean`
|
|
16826
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
|
+
|
|
16827
16612
|
lib/text/functions/isTruthy.md
|
|
16828
16613
|
---
|
|
16829
16614
|
|
|
@@ -16837,7 +16622,7 @@ lib/text/functions/isTruthy.md
|
|
|
16837
16622
|
|
|
16838
16623
|
> **isTruthy**\<`T`\>(`val`): `val is Exclude<T, TFalsy>`
|
|
16839
16624
|
|
|
16840
|
-
Defined in: [lib/text.ts:
|
|
16625
|
+
Defined in: [lib/text.ts:760](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L760)
|
|
16841
16626
|
|
|
16842
16627
|
判断一个值是否是真实的(不为 null/undefined/空字符串/false/0)
|
|
16843
16628
|
|
|
@@ -16872,7 +16657,7 @@ lib/text/functions/logicalOr.md
|
|
|
16872
16657
|
|
|
16873
16658
|
> **logicalOr**\<`T`, `T2`\>(`v1`, `v2`): `T` *extends* [`TFalsy`](../type-aliases/TFalsy.md) ? `T2` : `T`
|
|
16874
16659
|
|
|
16875
|
-
Defined in: [lib/text.ts:
|
|
16660
|
+
Defined in: [lib/text.ts:769](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L769)
|
|
16876
16661
|
|
|
16877
16662
|
类似 || 运算符的效果
|
|
16878
16663
|
|
|
@@ -16917,7 +16702,7 @@ lib/text/functions/match.md
|
|
|
16917
16702
|
|
|
16918
16703
|
> **match**(`str`, `regs`): `boolean`
|
|
16919
16704
|
|
|
16920
|
-
Defined in: [lib/text.ts:
|
|
16705
|
+
Defined in: [lib/text.ts:380](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L380)
|
|
16921
16706
|
|
|
16922
16707
|
传入正则进行匹配 str 是否有一项满足
|
|
16923
16708
|
|
|
@@ -16952,7 +16737,7 @@ lib/text/functions/nlReplace.md
|
|
|
16952
16737
|
|
|
16953
16738
|
> **nlReplace**(`str`, `to?`): `string`
|
|
16954
16739
|
|
|
16955
|
-
Defined in: [lib/text.ts:
|
|
16740
|
+
Defined in: [lib/text.ts:300](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L300)
|
|
16956
16741
|
|
|
16957
16742
|
换行替换为别的
|
|
16958
16743
|
|
|
@@ -16987,7 +16772,7 @@ lib/text/functions/parseDomain.md
|
|
|
16987
16772
|
|
|
16988
16773
|
> **parseDomain**(`domain`): `Promise`\<[`IDomain`](../interfaces/IDomain.md)\>
|
|
16989
16774
|
|
|
16990
|
-
Defined in: [lib/text.ts:
|
|
16775
|
+
Defined in: [lib/text.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L323)
|
|
16991
16776
|
|
|
16992
16777
|
解析域名并获取 tld/sld/domain/sub
|
|
16993
16778
|
|
|
@@ -17057,7 +16842,7 @@ lib/text/functions/parseJson.md
|
|
|
17057
16842
|
|
|
17058
16843
|
> **parseJson**\<`T`\>(`str`): `false` \| `T`
|
|
17059
16844
|
|
|
17060
|
-
Defined in: [lib/text.ts:
|
|
16845
|
+
Defined in: [lib/text.ts:663](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L663)
|
|
17061
16846
|
|
|
17062
16847
|
将字符串解析为对象,返回 false 代表解析失败,支持 BigInt
|
|
17063
16848
|
|
|
@@ -17119,7 +16904,7 @@ lib/text/functions/queryParse.md
|
|
|
17119
16904
|
|
|
17120
16905
|
> **queryParse**(`query`): `Record`\<`string`, `string` \| `string`[]\>
|
|
17121
16906
|
|
|
17122
|
-
Defined in: [lib/text.ts:
|
|
16907
|
+
Defined in: [lib/text.ts:480](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L480)
|
|
17123
16908
|
|
|
17124
16909
|
将 query string 转换为对象
|
|
17125
16910
|
|
|
@@ -17150,7 +16935,7 @@ lib/text/functions/queryStringify.md
|
|
|
17150
16935
|
|
|
17151
16936
|
> **queryStringify**(`query`, `encode?`): `string`
|
|
17152
16937
|
|
|
17153
|
-
Defined in: [lib/text.ts:
|
|
16938
|
+
Defined in: [lib/text.ts:431](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L431)
|
|
17154
16939
|
|
|
17155
16940
|
将对象转换为 query string
|
|
17156
16941
|
|
|
@@ -17176,7 +16961,7 @@ Defined in: [lib/text.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17176
16961
|
|
|
17177
16962
|
> **queryStringify**(`query`, `options`): `string`
|
|
17178
16963
|
|
|
17179
|
-
Defined in: [lib/text.ts:
|
|
16964
|
+
Defined in: [lib/text.ts:437](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L437)
|
|
17180
16965
|
|
|
17181
16966
|
将对象转换为 query string
|
|
17182
16967
|
|
|
@@ -17256,7 +17041,7 @@ lib/text/functions/str2int.md
|
|
|
17256
17041
|
|
|
17257
17042
|
> **str2int**(`str`, `digits?`): `number`
|
|
17258
17043
|
|
|
17259
|
-
Defined in: [lib/text.ts:
|
|
17044
|
+
Defined in: [lib/text.ts:783](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L783)
|
|
17260
17045
|
|
|
17261
17046
|
为解决精度问题,将字符串数字转换为整数显示
|
|
17262
17047
|
以下几个示例都是当 digits 为 2 时
|
|
@@ -17296,7 +17081,7 @@ lib/text/functions/stringifyBuffer.md
|
|
|
17296
17081
|
|
|
17297
17082
|
> **stringifyBuffer**(`buf`): `string`
|
|
17298
17083
|
|
|
17299
|
-
Defined in: [lib/text.ts:
|
|
17084
|
+
Defined in: [lib/text.ts:706](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L706)
|
|
17300
17085
|
|
|
17301
17086
|
输出文本格式的 buffer
|
|
17302
17087
|
|
|
@@ -17325,7 +17110,7 @@ lib/text/functions/stringifyJson.md
|
|
|
17325
17110
|
|
|
17326
17111
|
> **stringifyJson**(`obj`, `space?`): `string`
|
|
17327
17112
|
|
|
17328
|
-
Defined in: [lib/text.ts:
|
|
17113
|
+
Defined in: [lib/text.ts:693](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L693)
|
|
17329
17114
|
|
|
17330
17115
|
将对象转换为 json 字符串,返回 false 代表解析失败,支持 BigInt
|
|
17331
17116
|
|
|
@@ -17360,7 +17145,7 @@ lib/text/functions/stringifyResult.md
|
|
|
17360
17145
|
|
|
17361
17146
|
> **stringifyResult**(`rtn`): `string`
|
|
17362
17147
|
|
|
17363
|
-
Defined in: [lib/text.ts:
|
|
17148
|
+
Defined in: [lib/text.ts:623](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L623)
|
|
17364
17149
|
|
|
17365
17150
|
将普通的返回 JSON 对象序列化为字符串
|
|
17366
17151
|
|
|
@@ -17389,7 +17174,7 @@ lib/text/functions/trimJson.md
|
|
|
17389
17174
|
|
|
17390
17175
|
> **trimJson**(`json`): `any`
|
|
17391
17176
|
|
|
17392
|
-
Defined in: [lib/text.ts:
|
|
17177
|
+
Defined in: [lib/text.ts:714](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L714)
|
|
17393
17178
|
|
|
17394
17179
|
递归删除 json 中的字符串首尾空格,会返回一个新的对象
|
|
17395
17180
|
|
|
@@ -17416,7 +17201,7 @@ lib/text/functions/urlAtom.md
|
|
|
17416
17201
|
|
|
17417
17202
|
> **urlAtom**(`url`): `string`
|
|
17418
17203
|
|
|
17419
|
-
Defined in: [lib/text.ts:
|
|
17204
|
+
Defined in: [lib/text.ts:234](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L234)
|
|
17420
17205
|
|
|
17421
17206
|
将路径中的 ../ ./ 都按规范妥善处理
|
|
17422
17207
|
|
|
@@ -17445,7 +17230,7 @@ lib/text/functions/urlResolve.md
|
|
|
17445
17230
|
|
|
17446
17231
|
> **urlResolve**(`from`, `to`, `limit?`): `string`
|
|
17447
17232
|
|
|
17448
|
-
Defined in: [lib/text.ts:
|
|
17233
|
+
Defined in: [lib/text.ts:168](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L168)
|
|
17449
17234
|
|
|
17450
17235
|
将相对路径根据基准路径进行转换
|
|
17451
17236
|
|
|
@@ -17515,6 +17300,7 @@ lib/text/index.md
|
|
|
17515
17300
|
- [isIPv6](functions/isIPv6.md)
|
|
17516
17301
|
- [isPhoneCN](functions/isPhoneCN.md)
|
|
17517
17302
|
- [isRealPath](functions/isRealPath.md)
|
|
17303
|
+
- [isSameOrigin](functions/isSameOrigin.md)
|
|
17518
17304
|
- [isTruthy](functions/isTruthy.md)
|
|
17519
17305
|
- [logicalOr](functions/logicalOr.md)
|
|
17520
17306
|
- [match](functions/match.md)
|
|
@@ -17545,7 +17331,7 @@ lib/text/interfaces/IDomain.md
|
|
|
17545
17331
|
|
|
17546
17332
|
# Interface: IDomain
|
|
17547
17333
|
|
|
17548
|
-
Defined in: [lib/text.ts:
|
|
17334
|
+
Defined in: [lib/text.ts:312](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L312)
|
|
17549
17335
|
|
|
17550
17336
|
解析后的 domain
|
|
17551
17337
|
|
|
@@ -17555,7 +17341,7 @@ Defined in: [lib/text.ts:291](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17555
17341
|
|
|
17556
17342
|
> **domain**: `string` \| `null`
|
|
17557
17343
|
|
|
17558
|
-
Defined in: [lib/text.ts:
|
|
17344
|
+
Defined in: [lib/text.ts:315](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L315)
|
|
17559
17345
|
|
|
17560
17346
|
***
|
|
17561
17347
|
|
|
@@ -17563,7 +17349,7 @@ Defined in: [lib/text.ts:294](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17563
17349
|
|
|
17564
17350
|
> **sld**: `string` \| `null`
|
|
17565
17351
|
|
|
17566
|
-
Defined in: [lib/text.ts:
|
|
17352
|
+
Defined in: [lib/text.ts:314](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L314)
|
|
17567
17353
|
|
|
17568
17354
|
***
|
|
17569
17355
|
|
|
@@ -17571,7 +17357,7 @@ Defined in: [lib/text.ts:293](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17571
17357
|
|
|
17572
17358
|
> **sub**: `string` \| `null`
|
|
17573
17359
|
|
|
17574
|
-
Defined in: [lib/text.ts:
|
|
17360
|
+
Defined in: [lib/text.ts:316](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L316)
|
|
17575
17361
|
|
|
17576
17362
|
***
|
|
17577
17363
|
|
|
@@ -17579,7 +17365,7 @@ Defined in: [lib/text.ts:295](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17579
17365
|
|
|
17580
17366
|
> **tld**: `string` \| `null`
|
|
17581
17367
|
|
|
17582
|
-
Defined in: [lib/text.ts:
|
|
17368
|
+
Defined in: [lib/text.ts:313](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L313)
|
|
17583
17369
|
|
|
17584
17370
|
lib/text/type-aliases/TFalsy.md
|
|
17585
17371
|
---
|
|
@@ -17594,7 +17380,7 @@ lib/text/type-aliases/TFalsy.md
|
|
|
17594
17380
|
|
|
17595
17381
|
> **TFalsy** = `false` \| `""` \| `0` \| `null` \| `undefined` \| *typeof* `NaN`
|
|
17596
17382
|
|
|
17597
|
-
Defined in: [lib/text.ts:
|
|
17383
|
+
Defined in: [lib/text.ts:746](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L746)
|
|
17598
17384
|
|
|
17599
17385
|
虚假值类型
|
|
17600
17386
|
|
|
@@ -17611,7 +17397,7 @@ lib/text/variables/REGEXP_ASCII.md
|
|
|
17611
17397
|
|
|
17612
17398
|
> `const` **REGEXP\_ASCII**: `RegExp`
|
|
17613
17399
|
|
|
17614
|
-
Defined in: [lib/text.ts:
|
|
17400
|
+
Defined in: [lib/text.ts:285](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L285)
|
|
17615
17401
|
|
|
17616
17402
|
可打印的 ascii 字符集
|
|
17617
17403
|
|
|
@@ -17628,7 +17414,7 @@ lib/text/variables/REGEXP_DOMAIN.md
|
|
|
17628
17414
|
|
|
17629
17415
|
> `const` **REGEXP\_DOMAIN**: `RegExp`
|
|
17630
17416
|
|
|
17631
|
-
Defined in: [lib/text.ts:
|
|
17417
|
+
Defined in: [lib/text.ts:273](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L273)
|
|
17632
17418
|
|
|
17633
17419
|
lib/text/variables/REGEXP_EMAIL.md
|
|
17634
17420
|
---
|
|
@@ -17643,7 +17429,7 @@ lib/text/variables/REGEXP_EMAIL.md
|
|
|
17643
17429
|
|
|
17644
17430
|
> `const` **REGEXP\_EMAIL**: `RegExp`
|
|
17645
17431
|
|
|
17646
|
-
Defined in: [lib/text.ts:
|
|
17432
|
+
Defined in: [lib/text.ts:247](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L247)
|
|
17647
17433
|
|
|
17648
17434
|
lib/time/classes/Time.md
|
|
17649
17435
|
---
|
|
@@ -18476,7 +18262,7 @@ lib/undici/functions/filterHeaders.md
|
|
|
18476
18262
|
|
|
18477
18263
|
> **filterHeaders**(`headers`, `res?`, `filter?`): `Record`\<`string`, `string` \| `string`[]\>
|
|
18478
18264
|
|
|
18479
|
-
Defined in: [lib/undici.ts:
|
|
18265
|
+
Defined in: [lib/undici.ts:569](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L569)
|
|
18480
18266
|
|
|
18481
18267
|
剔除不代理的 header,返回新的 header
|
|
18482
18268
|
|
|
@@ -18517,7 +18303,7 @@ lib/undici/functions/getFormData.md
|
|
|
18517
18303
|
|
|
18518
18304
|
> **getFormData**(): [`FormData`](../formdata/classes/FormData.md)
|
|
18519
18305
|
|
|
18520
|
-
Defined in: [lib/undici.ts:
|
|
18306
|
+
Defined in: [lib/undici.ts:553](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L553)
|
|
18521
18307
|
|
|
18522
18308
|
创建 FormData 对象
|
|
18523
18309
|
|
|
@@ -18637,7 +18423,7 @@ lib/undici/functions/mproxyData.md
|
|
|
18637
18423
|
|
|
18638
18424
|
> **mproxyData**(`ctr`): `any`
|
|
18639
18425
|
|
|
18640
|
-
Defined in: [lib/undici.ts:
|
|
18426
|
+
Defined in: [lib/undici.ts:671](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L671)
|
|
18641
18427
|
|
|
18642
18428
|
获取 mproxy 的附加数据
|
|
18643
18429
|
|
|
@@ -18666,7 +18452,7 @@ lib/undici/functions/mproxy.md
|
|
|
18666
18452
|
|
|
18667
18453
|
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
18668
18454
|
|
|
18669
|
-
Defined in: [lib/undici.ts:
|
|
18455
|
+
Defined in: [lib/undici.ts:609](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L609)
|
|
18670
18456
|
|
|
18671
18457
|
正向 mproxy 代理,注意提前处理不要自动处理 post 数据,读取 get 的 url 为实际请求地址
|
|
18672
18458
|
get: url, auth
|
|
@@ -18938,7 +18724,7 @@ lib/undici/functions/rproxy.md
|
|
|
18938
18724
|
|
|
18939
18725
|
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
18940
18726
|
|
|
18941
|
-
Defined in: [lib/undici.ts:
|
|
18727
|
+
Defined in: [lib/undici.ts:701](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L701)
|
|
18942
18728
|
|
|
18943
18729
|
反向代理,将本服务器的某个路由反代到其他网址
|
|
18944
18730
|
|
|
@@ -19027,7 +18813,7 @@ lib/undici/interfaces/IMproxyOptions.md
|
|
|
19027
18813
|
|
|
19028
18814
|
# Interface: IMproxyOptions
|
|
19029
18815
|
|
|
19030
|
-
Defined in: [lib/undici.ts:
|
|
18816
|
+
Defined in: [lib/undici.ts:818](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L818)
|
|
19031
18817
|
|
|
19032
18818
|
正向代理请求的传入参数选项
|
|
19033
18819
|
|
|
@@ -19037,7 +18823,7 @@ Defined in: [lib/undici.ts:803](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19037
18823
|
|
|
19038
18824
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
19039
18825
|
|
|
19040
|
-
Defined in: [lib/undici.ts:
|
|
18826
|
+
Defined in: [lib/undici.ts:827](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L827)
|
|
19041
18827
|
|
|
19042
18828
|
过滤 header,返回 true 则留下
|
|
19043
18829
|
|
|
@@ -19057,7 +18843,7 @@ Defined in: [lib/undici.ts:812](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19057
18843
|
|
|
19058
18844
|
> `optional` **follow?**: `number`
|
|
19059
18845
|
|
|
19060
|
-
Defined in: [lib/undici.ts:
|
|
18846
|
+
Defined in: [lib/undici.ts:821](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L821)
|
|
19061
18847
|
|
|
19062
18848
|
***
|
|
19063
18849
|
|
|
@@ -19065,7 +18851,7 @@ Defined in: [lib/undici.ts:806](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19065
18851
|
|
|
19066
18852
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
19067
18853
|
|
|
19068
|
-
Defined in: [lib/undici.ts:
|
|
18854
|
+
Defined in: [lib/undici.ts:825](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L825)
|
|
19069
18855
|
|
|
19070
18856
|
***
|
|
19071
18857
|
|
|
@@ -19073,7 +18859,7 @@ Defined in: [lib/undici.ts:810](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19073
18859
|
|
|
19074
18860
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
19075
18861
|
|
|
19076
|
-
Defined in: [lib/undici.ts:
|
|
18862
|
+
Defined in: [lib/undici.ts:823](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L823)
|
|
19077
18863
|
|
|
19078
18864
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
19079
18865
|
|
|
@@ -19083,7 +18869,7 @@ Defined in: [lib/undici.ts:808](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19083
18869
|
|
|
19084
18870
|
> `optional` **local?**: `string`
|
|
19085
18871
|
|
|
19086
|
-
Defined in: [lib/undici.ts:
|
|
18872
|
+
Defined in: [lib/undici.ts:824](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L824)
|
|
19087
18873
|
|
|
19088
18874
|
***
|
|
19089
18875
|
|
|
@@ -19091,7 +18877,7 @@ Defined in: [lib/undici.ts:809](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19091
18877
|
|
|
19092
18878
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
19093
18879
|
|
|
19094
|
-
Defined in: [lib/undici.ts:
|
|
18880
|
+
Defined in: [lib/undici.ts:829](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L829)
|
|
19095
18881
|
|
|
19096
18882
|
默认为 default
|
|
19097
18883
|
|
|
@@ -19101,7 +18887,7 @@ Defined in: [lib/undici.ts:814](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19101
18887
|
|
|
19102
18888
|
> `optional` **timeout?**: `number`
|
|
19103
18889
|
|
|
19104
|
-
Defined in: [lib/undici.ts:
|
|
18890
|
+
Defined in: [lib/undici.ts:820](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L820)
|
|
19105
18891
|
|
|
19106
18892
|
秒数,默认 300 秒
|
|
19107
18893
|
|
|
@@ -19116,7 +18902,7 @@ lib/undici/interfaces/IRequestOptions.md
|
|
|
19116
18902
|
|
|
19117
18903
|
# Interface: IRequestOptions
|
|
19118
18904
|
|
|
19119
|
-
Defined in: [lib/undici.ts:
|
|
18905
|
+
Defined in: [lib/undici.ts:785](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L785)
|
|
19120
18906
|
|
|
19121
18907
|
请求的传入参数选项
|
|
19122
18908
|
|
|
@@ -19126,7 +18912,7 @@ Defined in: [lib/undici.ts:770](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19126
18912
|
|
|
19127
18913
|
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../cookie/interfaces/ICookie.md)\>
|
|
19128
18914
|
|
|
19129
|
-
Defined in: [lib/undici.ts:
|
|
18915
|
+
Defined in: [lib/undici.ts:810](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L810)
|
|
19130
18916
|
|
|
19131
18917
|
cookie 托管对象
|
|
19132
18918
|
|
|
@@ -19136,7 +18922,7 @@ cookie 托管对象
|
|
|
19136
18922
|
|
|
19137
18923
|
> `optional` **follow?**: `number`
|
|
19138
18924
|
|
|
19139
|
-
Defined in: [lib/undici.ts:
|
|
18925
|
+
Defined in: [lib/undici.ts:791](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L791)
|
|
19140
18926
|
|
|
19141
18927
|
追踪 location 次数,0 为不追踪,默认为 0
|
|
19142
18928
|
|
|
@@ -19146,7 +18932,7 @@ Defined in: [lib/undici.ts:776](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19146
18932
|
|
|
19147
18933
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
19148
18934
|
|
|
19149
|
-
Defined in: [lib/undici.ts:
|
|
18935
|
+
Defined in: [lib/undici.ts:796](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L796)
|
|
19150
18936
|
|
|
19151
18937
|
***
|
|
19152
18938
|
|
|
@@ -19154,7 +18940,7 @@ Defined in: [lib/undici.ts:781](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19154
18940
|
|
|
19155
18941
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
19156
18942
|
|
|
19157
|
-
Defined in: [lib/undici.ts:
|
|
18943
|
+
Defined in: [lib/undici.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L793)
|
|
19158
18944
|
|
|
19159
18945
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
19160
18946
|
|
|
@@ -19164,7 +18950,7 @@ Defined in: [lib/undici.ts:778](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19164
18950
|
|
|
19165
18951
|
> `optional` **keep?**: `boolean`
|
|
19166
18952
|
|
|
19167
|
-
Defined in: [lib/undici.ts:
|
|
18953
|
+
Defined in: [lib/undici.ts:806](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L806)
|
|
19168
18954
|
|
|
19169
18955
|
连接是否保持长连接(即是否允许复用),默认为 true
|
|
19170
18956
|
|
|
@@ -19174,7 +18960,7 @@ Defined in: [lib/undici.ts:791](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19174
18960
|
|
|
19175
18961
|
> `optional` **local?**: `string`
|
|
19176
18962
|
|
|
19177
|
-
Defined in: [lib/undici.ts:
|
|
18963
|
+
Defined in: [lib/undici.ts:795](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L795)
|
|
19178
18964
|
|
|
19179
18965
|
***
|
|
19180
18966
|
|
|
@@ -19182,7 +18968,7 @@ Defined in: [lib/undici.ts:780](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19182
18968
|
|
|
19183
18969
|
> `optional` **log?**: `boolean`
|
|
19184
18970
|
|
|
19185
|
-
Defined in: [lib/undici.ts:
|
|
18971
|
+
Defined in: [lib/undici.ts:812](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L812)
|
|
19186
18972
|
|
|
19187
18973
|
若有异常写入文件日志,默认为 true
|
|
19188
18974
|
|
|
@@ -19192,7 +18978,7 @@ Defined in: [lib/undici.ts:797](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19192
18978
|
|
|
19193
18979
|
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
19194
18980
|
|
|
19195
|
-
Defined in: [lib/undici.ts:
|
|
18981
|
+
Defined in: [lib/undici.ts:786](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L786)
|
|
19196
18982
|
|
|
19197
18983
|
***
|
|
19198
18984
|
|
|
@@ -19200,7 +18986,7 @@ Defined in: [lib/undici.ts:771](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19200
18986
|
|
|
19201
18987
|
> `optional` **mproxy?**: `object`
|
|
19202
18988
|
|
|
19203
|
-
Defined in: [lib/undici.ts:
|
|
18989
|
+
Defined in: [lib/undici.ts:798](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L798)
|
|
19204
18990
|
|
|
19205
18991
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
19206
18992
|
|
|
@@ -19228,7 +19014,7 @@ Defined in: [lib/undici.ts:783](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19228
19014
|
|
|
19229
19015
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
19230
19016
|
|
|
19231
|
-
Defined in: [lib/undici.ts:
|
|
19017
|
+
Defined in: [lib/undici.ts:808](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L808)
|
|
19232
19018
|
|
|
19233
19019
|
复用池名/Agent,默认为 default
|
|
19234
19020
|
|
|
@@ -19238,7 +19024,7 @@ Defined in: [lib/undici.ts:793](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19238
19024
|
|
|
19239
19025
|
> `optional` **save?**: `string`
|
|
19240
19026
|
|
|
19241
|
-
Defined in: [lib/undici.ts:
|
|
19027
|
+
Defined in: [lib/undici.ts:794](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L794)
|
|
19242
19028
|
|
|
19243
19029
|
***
|
|
19244
19030
|
|
|
@@ -19246,7 +19032,7 @@ Defined in: [lib/undici.ts:779](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19246
19032
|
|
|
19247
19033
|
> `optional` **signal?**: `AbortSignal`
|
|
19248
19034
|
|
|
19249
|
-
Defined in: [lib/undici.ts:
|
|
19035
|
+
Defined in: [lib/undici.ts:814](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L814)
|
|
19250
19036
|
|
|
19251
19037
|
请求中止信号
|
|
19252
19038
|
|
|
@@ -19256,7 +19042,7 @@ Defined in: [lib/undici.ts:799](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19256
19042
|
|
|
19257
19043
|
> `optional` **timeout?**: `number`
|
|
19258
19044
|
|
|
19259
|
-
Defined in: [lib/undici.ts:
|
|
19045
|
+
Defined in: [lib/undici.ts:789](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L789)
|
|
19260
19046
|
|
|
19261
19047
|
秒数,默认 300 秒
|
|
19262
19048
|
|
|
@@ -19266,7 +19052,7 @@ Defined in: [lib/undici.ts:774](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19266
19052
|
|
|
19267
19053
|
> `optional` **type?**: `"form"` \| `"json"`
|
|
19268
19054
|
|
|
19269
|
-
Defined in: [lib/undici.ts:
|
|
19055
|
+
Defined in: [lib/undici.ts:787](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L787)
|
|
19270
19056
|
|
|
19271
19057
|
lib/undici/interfaces/IRproxyOptions.md
|
|
19272
19058
|
---
|
|
@@ -19279,7 +19065,7 @@ lib/undici/interfaces/IRproxyOptions.md
|
|
|
19279
19065
|
|
|
19280
19066
|
# Interface: IRproxyOptions
|
|
19281
19067
|
|
|
19282
|
-
Defined in: [lib/undici.ts:
|
|
19068
|
+
Defined in: [lib/undici.ts:833](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L833)
|
|
19283
19069
|
|
|
19284
19070
|
反向代理请求的传入参数选项
|
|
19285
19071
|
|
|
@@ -19289,7 +19075,7 @@ Defined in: [lib/undici.ts:818](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19289
19075
|
|
|
19290
19076
|
> `optional` **body?**: `string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
19291
19077
|
|
|
19292
|
-
Defined in: [lib/undici.ts:
|
|
19078
|
+
Defined in: [lib/undici.ts:852](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L852)
|
|
19293
19079
|
|
|
19294
19080
|
手动传入请求体(优先于原始 req 流),用于 req 流已消费后仍需转发 body 的场景
|
|
19295
19081
|
|
|
@@ -19299,7 +19085,7 @@ Defined in: [lib/undici.ts:837](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19299
19085
|
|
|
19300
19086
|
> `optional` **filter?**: (`h`) => `boolean`
|
|
19301
19087
|
|
|
19302
|
-
Defined in: [lib/undici.ts:
|
|
19088
|
+
Defined in: [lib/undici.ts:842](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L842)
|
|
19303
19089
|
|
|
19304
19090
|
过滤 header,返回 true 则留下
|
|
19305
19091
|
|
|
@@ -19319,7 +19105,7 @@ Defined in: [lib/undici.ts:827](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19319
19105
|
|
|
19320
19106
|
> `optional` **follow?**: `number`
|
|
19321
19107
|
|
|
19322
|
-
Defined in: [lib/undici.ts:
|
|
19108
|
+
Defined in: [lib/undici.ts:836](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L836)
|
|
19323
19109
|
|
|
19324
19110
|
***
|
|
19325
19111
|
|
|
@@ -19327,7 +19113,7 @@ Defined in: [lib/undici.ts:821](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19327
19113
|
|
|
19328
19114
|
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
19329
19115
|
|
|
19330
|
-
Defined in: [lib/undici.ts:
|
|
19116
|
+
Defined in: [lib/undici.ts:840](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L840)
|
|
19331
19117
|
|
|
19332
19118
|
***
|
|
19333
19119
|
|
|
@@ -19335,7 +19121,7 @@ Defined in: [lib/undici.ts:825](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19335
19121
|
|
|
19336
19122
|
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
19337
19123
|
|
|
19338
|
-
Defined in: [lib/undici.ts:
|
|
19124
|
+
Defined in: [lib/undici.ts:838](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L838)
|
|
19339
19125
|
|
|
19340
19126
|
自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
19341
19127
|
|
|
@@ -19345,7 +19131,7 @@ Defined in: [lib/undici.ts:823](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19345
19131
|
|
|
19346
19132
|
> `optional` **local?**: `string`
|
|
19347
19133
|
|
|
19348
|
-
Defined in: [lib/undici.ts:
|
|
19134
|
+
Defined in: [lib/undici.ts:839](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L839)
|
|
19349
19135
|
|
|
19350
19136
|
***
|
|
19351
19137
|
|
|
@@ -19353,7 +19139,7 @@ Defined in: [lib/undici.ts:824](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19353
19139
|
|
|
19354
19140
|
> `optional` **mproxy?**: `object`
|
|
19355
19141
|
|
|
19356
|
-
Defined in: [lib/undici.ts:
|
|
19142
|
+
Defined in: [lib/undici.ts:844](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L844)
|
|
19357
19143
|
|
|
19358
19144
|
正向 mproxy 代理,url 如 https://xxx/abc
|
|
19359
19145
|
|
|
@@ -19381,7 +19167,7 @@ Defined in: [lib/undici.ts:829](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19381
19167
|
|
|
19382
19168
|
> `optional` **querys?**: `Record`\<`string`, `any`\>
|
|
19383
19169
|
|
|
19384
|
-
Defined in: [lib/undici.ts:
|
|
19170
|
+
Defined in: [lib/undici.ts:854](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L854)
|
|
19385
19171
|
|
|
19386
19172
|
自定义 GET 查询参数,传入后直接替换代理目标 URL 的整个 query string
|
|
19387
19173
|
|
|
@@ -19391,7 +19177,7 @@ Defined in: [lib/undici.ts:839](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19391
19177
|
|
|
19392
19178
|
> `optional` **reuse?**: `string` \| `Agent` \| `ProxyAgent`
|
|
19393
19179
|
|
|
19394
|
-
Defined in: [lib/undici.ts:
|
|
19180
|
+
Defined in: [lib/undici.ts:856](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L856)
|
|
19395
19181
|
|
|
19396
19182
|
默认为 default
|
|
19397
19183
|
|
|
@@ -19401,7 +19187,7 @@ Defined in: [lib/undici.ts:841](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
19401
19187
|
|
|
19402
19188
|
> `optional` **timeout?**: `number`
|
|
19403
19189
|
|
|
19404
|
-
Defined in: [lib/undici.ts:
|
|
19190
|
+
Defined in: [lib/undici.ts:835](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L835)
|
|
19405
19191
|
|
|
19406
19192
|
秒数,默认 300 秒
|
|
19407
19193
|
|
|
@@ -19804,7 +19590,7 @@ Defined in: [lib/undici/response.ts:66](https://github.com/maiyunnet/kebab/blob/
|
|
|
19804
19590
|
|
|
19805
19591
|
> **getRawStream**(): `BodyReadable` & `BodyMixin` \| `null`
|
|
19806
19592
|
|
|
19807
|
-
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)
|
|
19808
19594
|
|
|
19809
19595
|
获取原生响应读取流对象
|
|
19810
19596
|
|
|
@@ -19818,7 +19604,7 @@ Defined in: [lib/undici/response.ts:128](https://github.com/maiyunnet/kebab/blob
|
|
|
19818
19604
|
|
|
19819
19605
|
> **getStream**(): `BrotliDecompress` \| `Gunzip` \| `Inflate` \| `BodyReadable` & `BodyMixin` \| `null`
|
|
19820
19606
|
|
|
19821
|
-
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)
|
|
19822
19608
|
|
|
19823
19609
|
获取响应读取流对象
|
|
19824
19610
|
|
|
@@ -19890,7 +19676,7 @@ lib/undici/type-aliases/THttpHeaders.md
|
|
|
19890
19676
|
|
|
19891
19677
|
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
19892
19678
|
|
|
19893
|
-
Defined in: [lib/undici.ts:
|
|
19679
|
+
Defined in: [lib/undici.ts:861](https://github.com/maiyunnet/kebab/blob/master/lib/undici.ts#L861)
|
|
19894
19680
|
|
|
19895
19681
|
http headers
|
|
19896
19682
|
|
|
@@ -23245,6 +23031,24 @@ Defined in: [sys/ctr.ts:1102](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23245
23031
|
|
|
23246
23032
|
单个文件最大字节数
|
|
23247
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
|
+
|
|
23248
23052
|
###### timeout?
|
|
23249
23053
|
|
|
23250
23054
|
`number`
|
|
@@ -26742,7 +26546,7 @@ sys/route/functions/getFormData.md
|
|
|
26742
26546
|
|
|
26743
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)\>; \}\>
|
|
26744
26548
|
|
|
26745
|
-
Defined in: [sys/route.ts:
|
|
26549
|
+
Defined in: [sys/route.ts:995](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L995)
|
|
26746
26550
|
|
|
26747
26551
|
获取 formdata 的 post
|
|
26748
26552
|
|
|
@@ -26798,6 +26602,24 @@ Defined in: [sys/route.ts:980](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
26798
26602
|
|
|
26799
26603
|
单个文件最大字节数
|
|
26800
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
|
+
|
|
26801
26623
|
#### timeout?
|
|
26802
26624
|
|
|
26803
26625
|
`number`
|
|
@@ -26821,7 +26643,7 @@ sys/route/functions/getPost.md
|
|
|
26821
26643
|
|
|
26822
26644
|
> **getPost**(`req`): `Promise`\<\{ `input`: `string`; `post`: `Record`\<`string`, `any`\>; `raw`: `Record`\<`string`, `any`\>; \}\>
|
|
26823
26645
|
|
|
26824
|
-
Defined in: [sys/route.ts:
|
|
26646
|
+
Defined in: [sys/route.ts:909](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L909)
|
|
26825
26647
|
|
|
26826
26648
|
获取 post 对象(通常已自动获取),如果是文件上传(formdata)的情况则不获取
|
|
26827
26649
|
|
|
@@ -26850,7 +26672,7 @@ sys/route/functions/run.md
|
|
|
26850
26672
|
|
|
26851
26673
|
> **run**(`data`): `Promise`\<`boolean`\>
|
|
26852
26674
|
|
|
26853
|
-
Defined in: [sys/route.ts:
|
|
26675
|
+
Defined in: [sys/route.ts:102](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L102)
|
|
26854
26676
|
|
|
26855
26677
|
若为动态路径则执行此函数,此函数不进行判断 kebab.json 是否存在
|
|
26856
26678
|
|
|
@@ -26937,7 +26759,7 @@ sys/route/functions/unlinkUploadFiles.md
|
|
|
26937
26759
|
|
|
26938
26760
|
> **unlinkUploadFiles**(`cctr`): `Promise`\<`void`\>
|
|
26939
26761
|
|
|
26940
|
-
Defined in: [sys/route.ts:
|
|
26762
|
+
Defined in: [sys/route.ts:868](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L868)
|
|
26941
26763
|
|
|
26942
26764
|
删除本次请求所有已上传的临时文件
|
|
26943
26765
|
|
|
@@ -26966,7 +26788,7 @@ sys/route/functions/waitCtr.md
|
|
|
26966
26788
|
|
|
26967
26789
|
> **waitCtr**(`cctr`): `Promise`\<`void`\>
|
|
26968
26790
|
|
|
26969
|
-
Defined in: [sys/route.ts:
|
|
26791
|
+
Defined in: [sys/route.ts:888](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L888)
|
|
26970
26792
|
|
|
26971
26793
|
等待异步任务结束,并删除临时文件,如果结束后还有事务没关闭,则会在本函数中打印控制台并且写入 log 文件
|
|
26972
26794
|
此时其实已经给客户端返回了,此处等待不消耗客户端的等待时间
|