@maiyunnet/kebab 9.13.8 → 9.14.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/doc/kebab-rag.md +372 -180
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/core.js +24 -7
- package/lib/crypto.d.ts +26 -26
- package/lib/crypto.js +1 -1
- package/lib/sql.d.ts +27 -1
- package/lib/sql.js +34 -1
- package/lib/undici/response.d.ts +1 -1
- package/package.json +23 -23
- package/sys/child.js +15 -0
- package/sys/ctr.d.ts +4 -0
- package/sys/master.js +57 -31
- package/sys/mod.d.ts +33 -1
- package/sys/mod.js +37 -1
- package/sys/route.d.ts +4 -0
- package/sys/route.js +63 -0
- package/www/example/ctr/test.js +16 -0
- package/www/example/stc/chunk-FG5CKGYR.js +81 -0
- package/www/example/stc/lib/ui/checkbox.d.ts +1 -1
- package/www/example/stc/lib/ui/input.d.ts +1 -1
- package/www/example/stc/lib/ui/label.d.ts +1 -1
- package/www/example/stc/lib/ui/switch.d.ts +1 -1
- package/www/example/stc/view/hello.page.bundle.js +1 -1
- package/www/example/stc/view/hello.page.css +2 -2
- package/www/example/stc/view/react-router.page.bundle.js +1 -1
- package/www/example/stc/view/react-router.page.css +2 -2
- package/www/example/stc/view/react-router.page.d.ts +1 -1
- package/www/example/stc/view/react-router.page.js +1 -1
- package/www/example/stc/view/react-router.page.tsx +1 -1
- package/www/example/stc/view/react.page.bundle.js +3 -3
- package/www/example/stc/view/react.page.css +2 -2
- package/www/example/stc/view/react.page.d.ts +1 -1
- package/www/example/stc/chunk-YJ3GYATF.js +0 -81
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.14.1"` = `'9.14.1'`
|
|
1364
1364
|
|
|
1365
1365
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1366
1366
|
|
|
@@ -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:1189](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1189)
|
|
3354
3354
|
|
|
3355
3355
|
完整的克隆一份数组/对象
|
|
3356
3356
|
|
|
@@ -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:1223](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1223)
|
|
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:1236](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1236)
|
|
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:471](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L471)
|
|
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:533](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L533)
|
|
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:1101](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1101)
|
|
3558
3558
|
|
|
3559
3559
|
获取日志内容为一个数组
|
|
3560
3560
|
|
|
@@ -3654,7 +3654,7 @@ lib/core/functions/ips.md
|
|
|
3654
3654
|
|
|
3655
3655
|
> **ips**(`ctr`): `object`
|
|
3656
3656
|
|
|
3657
|
-
Defined in: [lib/core.ts:
|
|
3657
|
+
Defined in: [lib/core.ts:384](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L384)
|
|
3658
3658
|
|
|
3659
3659
|
获取 CF 和 X 的 IP
|
|
3660
3660
|
|
|
@@ -3689,7 +3689,7 @@ lib/core/functions/loadEnv.md
|
|
|
3689
3689
|
|
|
3690
3690
|
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3691
3691
|
|
|
3692
|
-
Defined in: [lib/core.ts:
|
|
3692
|
+
Defined in: [lib/core.ts:1288](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1288)
|
|
3693
3693
|
|
|
3694
3694
|
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3695
3695
|
|
|
@@ -3718,7 +3718,7 @@ lib/core/functions/log.md
|
|
|
3718
3718
|
|
|
3719
3719
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3720
3720
|
|
|
3721
|
-
Defined in: [lib/core.ts:
|
|
3721
|
+
Defined in: [lib/core.ts:988](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L988)
|
|
3722
3722
|
|
|
3723
3723
|
写入文件日志
|
|
3724
3724
|
|
|
@@ -3759,7 +3759,7 @@ lib/core/functions/ls.md
|
|
|
3759
3759
|
|
|
3760
3760
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3761
3761
|
|
|
3762
|
-
Defined in: [lib/core.ts:
|
|
3762
|
+
Defined in: [lib/core.ts:1150](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1150)
|
|
3763
3763
|
|
|
3764
3764
|
获取目录内文件/文件夹列表
|
|
3765
3765
|
|
|
@@ -3865,7 +3865,7 @@ lib/core/functions/objectSort.md
|
|
|
3865
3865
|
|
|
3866
3866
|
> **objectSort**\<`T`\>(`o`): `T`
|
|
3867
3867
|
|
|
3868
|
-
Defined in: [lib/core.ts:
|
|
3868
|
+
Defined in: [lib/core.ts:452](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L452)
|
|
3869
3869
|
|
|
3870
3870
|
将对象进行升序排列
|
|
3871
3871
|
|
|
@@ -3900,7 +3900,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3900
3900
|
|
|
3901
3901
|
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3902
3902
|
|
|
3903
|
-
Defined in: [lib/core.ts:
|
|
3903
|
+
Defined in: [lib/core.ts:490](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L490)
|
|
3904
3904
|
|
|
3905
3905
|
调用前自行创建 passThrough,并且调用 pipe 绑定到应该绑定的对象,然后再调用本函数
|
|
3906
3906
|
|
|
@@ -4052,7 +4052,7 @@ lib/core/functions/realIP.md
|
|
|
4052
4052
|
|
|
4053
4053
|
> **realIP**(`ctr`, `name?`): `string`
|
|
4054
4054
|
|
|
4055
|
-
Defined in: [lib/core.ts:
|
|
4055
|
+
Defined in: [lib/core.ts:424](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L424)
|
|
4056
4056
|
|
|
4057
4057
|
获取直连 IP(安全 IP)
|
|
4058
4058
|
|
|
@@ -4085,7 +4085,7 @@ lib/core/functions/removeGlobal.md
|
|
|
4085
4085
|
|
|
4086
4086
|
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4087
4087
|
|
|
4088
|
-
Defined in: [lib/core.ts:
|
|
4088
|
+
Defined in: [lib/core.ts:805](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L805)
|
|
4089
4089
|
|
|
4090
4090
|
移除某个跨线程/跨内网服务器全局变量
|
|
4091
4091
|
|
|
@@ -4120,7 +4120,7 @@ lib/core/functions/resolveEnvVars.md
|
|
|
4120
4120
|
|
|
4121
4121
|
> **resolveEnvVars**(`obj`): `void`
|
|
4122
4122
|
|
|
4123
|
-
Defined in: [lib/core.ts:
|
|
4123
|
+
Defined in: [lib/core.ts:1318](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1318)
|
|
4124
4124
|
|
|
4125
4125
|
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
4126
4126
|
|
|
@@ -4149,7 +4149,7 @@ lib/core/functions/sendNpm.md
|
|
|
4149
4149
|
|
|
4150
4150
|
> **sendNpm**(`path`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4151
4151
|
|
|
4152
|
-
Defined in: [lib/core.ts:
|
|
4152
|
+
Defined in: [lib/core.ts:704](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L704)
|
|
4153
4153
|
|
|
4154
4154
|
向本机或局域网 RPC 发送 npm install 操作
|
|
4155
4155
|
|
|
@@ -4184,7 +4184,7 @@ lib/core/functions/sendPackage.md
|
|
|
4184
4184
|
|
|
4185
4185
|
> **sendPackage**(`content`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4186
4186
|
|
|
4187
|
-
Defined in: [lib/core.ts:
|
|
4187
|
+
Defined in: [lib/core.ts:928](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L928)
|
|
4188
4188
|
|
|
4189
4189
|
向本机或局域网 RPC 发送 package.json 更新操作
|
|
4190
4190
|
|
|
@@ -4219,7 +4219,7 @@ lib/core/functions/sendPm2.md
|
|
|
4219
4219
|
|
|
4220
4220
|
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4221
4221
|
|
|
4222
|
-
Defined in: [lib/core.ts:
|
|
4222
|
+
Defined in: [lib/core.ts:656](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L656)
|
|
4223
4223
|
|
|
4224
4224
|
向本机或局域网 RPC 发送 PM2 操作
|
|
4225
4225
|
|
|
@@ -4260,7 +4260,7 @@ lib/core/functions/sendProject.md
|
|
|
4260
4260
|
|
|
4261
4261
|
> **sendProject**(`path`, `key`, `value`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4262
4262
|
|
|
4263
|
-
Defined in: [lib/core.ts:
|
|
4263
|
+
Defined in: [lib/core.ts:880](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L880)
|
|
4264
4264
|
|
|
4265
4265
|
向本机或局域网 RPC 发送项目配置更新操作
|
|
4266
4266
|
|
|
@@ -4307,7 +4307,7 @@ lib/core/functions/sendReload.md
|
|
|
4307
4307
|
|
|
4308
4308
|
> **sendReload**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4309
4309
|
|
|
4310
|
-
Defined in: [lib/core.ts:
|
|
4310
|
+
Defined in: [lib/core.ts:553](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L553)
|
|
4311
4311
|
|
|
4312
4312
|
向主进程(或局域网同代码机子)发送广播将进行 reload 操作,等待回传
|
|
4313
4313
|
主要作用除代码热更新以外的其他情况
|
|
@@ -4335,7 +4335,7 @@ lib/core/functions/sendRestart.md
|
|
|
4335
4335
|
|
|
4336
4336
|
> **sendRestart**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4337
4337
|
|
|
4338
|
-
Defined in: [lib/core.ts:
|
|
4338
|
+
Defined in: [lib/core.ts:602](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L602)
|
|
4339
4339
|
|
|
4340
4340
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
4341
4341
|
主要用作不间断的代码热更新
|
|
@@ -4410,7 +4410,7 @@ lib/core/functions/setGlobal.md
|
|
|
4410
4410
|
|
|
4411
4411
|
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4412
4412
|
|
|
4413
|
-
Defined in: [lib/core.ts:
|
|
4413
|
+
Defined in: [lib/core.ts:755](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L755)
|
|
4414
4414
|
|
|
4415
4415
|
设置跨线程/指定的局域网主机的全局变量
|
|
4416
4416
|
|
|
@@ -4451,7 +4451,7 @@ lib/core/functions/sleep.md
|
|
|
4451
4451
|
|
|
4452
4452
|
> **sleep**(`ms`): `Promise`\<`void`\>
|
|
4453
4453
|
|
|
4454
|
-
Defined in: [lib/core.ts:
|
|
4454
|
+
Defined in: [lib/core.ts:440](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L440)
|
|
4455
4455
|
|
|
4456
4456
|
间隔一段时间
|
|
4457
4457
|
|
|
@@ -4509,7 +4509,7 @@ lib/core/functions/updateCode.md
|
|
|
4509
4509
|
|
|
4510
4510
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4511
4511
|
|
|
4512
|
-
Defined in: [lib/core.ts:
|
|
4512
|
+
Defined in: [lib/core.ts:820](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L820)
|
|
4513
4513
|
|
|
4514
4514
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
4515
4515
|
|
|
@@ -4562,7 +4562,7 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4562
4562
|
|
|
4563
4563
|
> **writeEventStreamHead**(`res`): `void`
|
|
4564
4564
|
|
|
4565
|
-
Defined in: [lib/core.ts:
|
|
4565
|
+
Defined in: [lib/core.ts:1258](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1258)
|
|
4566
4566
|
|
|
4567
4567
|
## Parameters
|
|
4568
4568
|
|
|
@@ -4587,7 +4587,7 @@ lib/core/functions/writeHead.md
|
|
|
4587
4587
|
|
|
4588
4588
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4589
4589
|
|
|
4590
|
-
Defined in: [lib/core.ts:
|
|
4590
|
+
Defined in: [lib/core.ts:1247](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1247)
|
|
4591
4591
|
|
|
4592
4592
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4593
4593
|
|
|
@@ -4628,7 +4628,7 @@ lib/core/functions/write.md
|
|
|
4628
4628
|
|
|
4629
4629
|
> **write**(`res`, `data`): `void`
|
|
4630
4630
|
|
|
4631
|
-
Defined in: [lib/core.ts:
|
|
4631
|
+
Defined in: [lib/core.ts:1270](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1270)
|
|
4632
4632
|
|
|
4633
4633
|
向 res 发送数据
|
|
4634
4634
|
|
|
@@ -4800,7 +4800,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4800
4800
|
|
|
4801
4801
|
# Interface: ILogOptions
|
|
4802
4802
|
|
|
4803
|
-
Defined in: [lib/core.ts:
|
|
4803
|
+
Defined in: [lib/core.ts:971](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L971)
|
|
4804
4804
|
|
|
4805
4805
|
log 设置的选项
|
|
4806
4806
|
|
|
@@ -4810,7 +4810,7 @@ log 设置的选项
|
|
|
4810
4810
|
|
|
4811
4811
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4812
4812
|
|
|
4813
|
-
Defined in: [lib/core.ts:
|
|
4813
|
+
Defined in: [lib/core.ts:977](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L977)
|
|
4814
4814
|
|
|
4815
4815
|
***
|
|
4816
4816
|
|
|
@@ -4818,7 +4818,7 @@ Defined in: [lib/core.ts:959](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4818
4818
|
|
|
4819
4819
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4820
4820
|
|
|
4821
|
-
Defined in: [lib/core.ts:
|
|
4821
|
+
Defined in: [lib/core.ts:976](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L976)
|
|
4822
4822
|
|
|
4823
4823
|
***
|
|
4824
4824
|
|
|
@@ -4826,7 +4826,7 @@ Defined in: [lib/core.ts:958](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4826
4826
|
|
|
4827
4827
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4828
4828
|
|
|
4829
|
-
Defined in: [lib/core.ts:
|
|
4829
|
+
Defined in: [lib/core.ts:979](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L979)
|
|
4830
4830
|
|
|
4831
4831
|
***
|
|
4832
4832
|
|
|
@@ -4834,7 +4834,7 @@ Defined in: [lib/core.ts:961](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4834
4834
|
|
|
4835
4835
|
> `optional` **hostname?**: `string`
|
|
4836
4836
|
|
|
4837
|
-
Defined in: [lib/core.ts:
|
|
4837
|
+
Defined in: [lib/core.ts:974](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L974)
|
|
4838
4838
|
|
|
4839
4839
|
***
|
|
4840
4840
|
|
|
@@ -4842,7 +4842,7 @@ Defined in: [lib/core.ts:956](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4842
4842
|
|
|
4843
4843
|
> `optional` **path?**: `string`
|
|
4844
4844
|
|
|
4845
|
-
Defined in: [lib/core.ts:
|
|
4845
|
+
Defined in: [lib/core.ts:972](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L972)
|
|
4846
4846
|
|
|
4847
4847
|
***
|
|
4848
4848
|
|
|
@@ -4850,7 +4850,7 @@ Defined in: [lib/core.ts:954](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4850
4850
|
|
|
4851
4851
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4852
4852
|
|
|
4853
|
-
Defined in: [lib/core.ts:
|
|
4853
|
+
Defined in: [lib/core.ts:975](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L975)
|
|
4854
4854
|
|
|
4855
4855
|
***
|
|
4856
4856
|
|
|
@@ -4858,7 +4858,7 @@ Defined in: [lib/core.ts:957](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4858
4858
|
|
|
4859
4859
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4860
4860
|
|
|
4861
|
-
Defined in: [lib/core.ts:
|
|
4861
|
+
Defined in: [lib/core.ts:978](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L978)
|
|
4862
4862
|
|
|
4863
4863
|
***
|
|
4864
4864
|
|
|
@@ -4866,7 +4866,7 @@ Defined in: [lib/core.ts:960](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4866
4866
|
|
|
4867
4867
|
> `optional` **urlFull?**: `string`
|
|
4868
4868
|
|
|
4869
|
-
Defined in: [lib/core.ts:
|
|
4869
|
+
Defined in: [lib/core.ts:973](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L973)
|
|
4870
4870
|
|
|
4871
4871
|
lib/core/type-aliases/TPm2Action.md
|
|
4872
4872
|
---
|
|
@@ -4881,7 +4881,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4881
4881
|
|
|
4882
4882
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4883
4883
|
|
|
4884
|
-
Defined in: [lib/core.ts:
|
|
4884
|
+
Defined in: [lib/core.ts:648](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L648)
|
|
4885
4885
|
|
|
4886
4886
|
PM2 操作类型
|
|
4887
4887
|
|
|
@@ -4955,7 +4955,7 @@ lib/core/variables/global.md
|
|
|
4955
4955
|
|
|
4956
4956
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
4957
4957
|
|
|
4958
|
-
Defined in: [lib/core.ts:
|
|
4958
|
+
Defined in: [lib/core.ts:747](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L747)
|
|
4959
4959
|
|
|
4960
4960
|
跨进程全局变量
|
|
4961
4961
|
|
|
@@ -5125,7 +5125,7 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
5125
5125
|
|
|
5126
5126
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
5127
5127
|
|
|
5128
|
-
Defined in: [lib/core.ts:
|
|
5128
|
+
Defined in: [lib/core.ts:400](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L400)
|
|
5129
5129
|
|
|
5130
5130
|
使用的是 Cloudflare
|
|
5131
5131
|
|
|
@@ -5142,7 +5142,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
5142
5142
|
|
|
5143
5143
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
5144
5144
|
|
|
5145
|
-
Defined in: [lib/core.ts:
|
|
5145
|
+
Defined in: [lib/core.ts:398](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L398)
|
|
5146
5146
|
|
|
5147
5147
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
5148
5148
|
|
|
@@ -5420,7 +5420,7 @@ AES 解密
|
|
|
5420
5420
|
|
|
5421
5421
|
#### key
|
|
5422
5422
|
|
|
5423
|
-
`
|
|
5423
|
+
`KeyLike`
|
|
5424
5424
|
|
|
5425
5425
|
密钥 32 个英文字母和数字
|
|
5426
5426
|
|
|
@@ -5462,7 +5462,7 @@ AES 解密
|
|
|
5462
5462
|
|
|
5463
5463
|
#### key
|
|
5464
5464
|
|
|
5465
|
-
`
|
|
5465
|
+
`KeyLike`
|
|
5466
5466
|
|
|
5467
5467
|
密钥 32 个英文字母和数字
|
|
5468
5468
|
|
|
@@ -5515,7 +5515,7 @@ AES 加密
|
|
|
5515
5515
|
|
|
5516
5516
|
#### key
|
|
5517
5517
|
|
|
5518
|
-
`
|
|
5518
|
+
`KeyLike`
|
|
5519
5519
|
|
|
5520
5520
|
密钥尽量 32 个英文字母和数字,不是 32 个系统会自动处理
|
|
5521
5521
|
|
|
@@ -5559,7 +5559,7 @@ AES 加密
|
|
|
5559
5559
|
|
|
5560
5560
|
#### key
|
|
5561
5561
|
|
|
5562
|
-
`
|
|
5562
|
+
`KeyLike`
|
|
5563
5563
|
|
|
5564
5564
|
密钥尽量 32 个英文字母和数字,不是 32 个系统会自动处理
|
|
5565
5565
|
|
|
@@ -5704,7 +5704,7 @@ cipher 解密
|
|
|
5704
5704
|
|
|
5705
5705
|
### key
|
|
5706
5706
|
|
|
5707
|
-
`
|
|
5707
|
+
`KeyLike`
|
|
5708
5708
|
|
|
5709
5709
|
密钥 32 个英文字母和数字
|
|
5710
5710
|
|
|
@@ -5757,7 +5757,7 @@ cipher 加密,强烈不建议使用 AES_256_ECB
|
|
|
5757
5757
|
|
|
5758
5758
|
### key
|
|
5759
5759
|
|
|
5760
|
-
`
|
|
5760
|
+
`KeyLike`
|
|
5761
5761
|
|
|
5762
5762
|
密钥 32 个英文字母和数字
|
|
5763
5763
|
|
|
@@ -5812,7 +5812,7 @@ AES 解密
|
|
|
5812
5812
|
|
|
5813
5813
|
#### key
|
|
5814
5814
|
|
|
5815
|
-
`
|
|
5815
|
+
`KeyLike`
|
|
5816
5816
|
|
|
5817
5817
|
密钥 32 个英文字母和数字
|
|
5818
5818
|
|
|
@@ -5844,7 +5844,7 @@ AES 解密
|
|
|
5844
5844
|
|
|
5845
5845
|
#### key
|
|
5846
5846
|
|
|
5847
|
-
`
|
|
5847
|
+
`KeyLike`
|
|
5848
5848
|
|
|
5849
5849
|
密钥 32 个英文字母和数字
|
|
5850
5850
|
|
|
@@ -5887,7 +5887,7 @@ AES GCM 托管加密
|
|
|
5887
5887
|
|
|
5888
5888
|
#### key
|
|
5889
5889
|
|
|
5890
|
-
`
|
|
5890
|
+
`KeyLike`
|
|
5891
5891
|
|
|
5892
5892
|
密钥尽量 32 个英文字母和数字,不是 32 个系统会自动处理
|
|
5893
5893
|
|
|
@@ -5919,7 +5919,7 @@ AES GCM 托管加密
|
|
|
5919
5919
|
|
|
5920
5920
|
#### key
|
|
5921
5921
|
|
|
5922
|
-
`
|
|
5922
|
+
`KeyLike`
|
|
5923
5923
|
|
|
5924
5924
|
密钥尽量 32 个英文字母和数字,不是 32 个系统会自动处理
|
|
5925
5925
|
|
|
@@ -6033,7 +6033,7 @@ hash 或 hmac 加密文件
|
|
|
6033
6033
|
|
|
6034
6034
|
#### key?
|
|
6035
6035
|
|
|
6036
|
-
`
|
|
6036
|
+
`KeyLike`
|
|
6037
6037
|
|
|
6038
6038
|
设置则采用 hmac 加密
|
|
6039
6039
|
|
|
@@ -6069,7 +6069,7 @@ hash 或 hmac 加密文件
|
|
|
6069
6069
|
|
|
6070
6070
|
#### key
|
|
6071
6071
|
|
|
6072
|
-
`
|
|
6072
|
+
`KeyLike`
|
|
6073
6073
|
|
|
6074
6074
|
设置则采用 hmac 加密
|
|
6075
6075
|
|
|
@@ -6116,7 +6116,7 @@ hash 或 hmac 加密
|
|
|
6116
6116
|
|
|
6117
6117
|
#### key?
|
|
6118
6118
|
|
|
6119
|
-
`
|
|
6119
|
+
`KeyLike`
|
|
6120
6120
|
|
|
6121
6121
|
设置则采用 hmac 加密
|
|
6122
6122
|
|
|
@@ -6152,7 +6152,7 @@ hash 或 hmac 加密
|
|
|
6152
6152
|
|
|
6153
6153
|
#### key
|
|
6154
6154
|
|
|
6155
|
-
`
|
|
6155
|
+
`KeyLike` \| `undefined`
|
|
6156
6156
|
|
|
6157
6157
|
设置则采用 hmac 加密
|
|
6158
6158
|
|
|
@@ -6185,7 +6185,7 @@ Defined in: [lib/crypto.ts:136](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6185
6185
|
|
|
6186
6186
|
### key
|
|
6187
6187
|
|
|
6188
|
-
`KeyLike` \| `
|
|
6188
|
+
`KeyLike` \| `PrivateKeyInput`
|
|
6189
6189
|
|
|
6190
6190
|
私钥
|
|
6191
6191
|
|
|
@@ -6220,7 +6220,7 @@ Defined in: [lib/crypto.ts:114](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6220
6220
|
|
|
6221
6221
|
### key
|
|
6222
6222
|
|
|
6223
|
-
`KeyLike` \| `
|
|
6223
|
+
`KeyLike` \| `PrivateKeyInput`
|
|
6224
6224
|
|
|
6225
6225
|
私钥
|
|
6226
6226
|
|
|
@@ -6255,7 +6255,7 @@ Defined in: [lib/crypto.ts:125](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6255
6255
|
|
|
6256
6256
|
### key
|
|
6257
6257
|
|
|
6258
|
-
`KeyLike` \| `
|
|
6258
|
+
`KeyLike` \| `PrivateKeyInput` \| `PublicKeyInput`
|
|
6259
6259
|
|
|
6260
6260
|
公钥
|
|
6261
6261
|
|
|
@@ -6290,7 +6290,7 @@ Defined in: [lib/crypto.ts:103](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6290
6290
|
|
|
6291
6291
|
### key
|
|
6292
6292
|
|
|
6293
|
-
`KeyLike` \| `
|
|
6293
|
+
`KeyLike` \| `PrivateKeyInput` \| `PublicKeyInput`
|
|
6294
6294
|
|
|
6295
6295
|
公钥
|
|
6296
6296
|
|
|
@@ -6327,7 +6327,7 @@ Defined in: [lib/crypto.ts:69](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
6327
6327
|
|
|
6328
6328
|
#### data
|
|
6329
6329
|
|
|
6330
|
-
`
|
|
6330
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
6331
6331
|
|
|
6332
6332
|
数据
|
|
6333
6333
|
|
|
@@ -6365,7 +6365,7 @@ Defined in: [lib/crypto.ts:72](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
6365
6365
|
|
|
6366
6366
|
#### data
|
|
6367
6367
|
|
|
6368
|
-
`
|
|
6368
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
6369
6369
|
|
|
6370
6370
|
数据
|
|
6371
6371
|
|
|
@@ -6420,7 +6420,7 @@ SM4 解密
|
|
|
6420
6420
|
|
|
6421
6421
|
#### key
|
|
6422
6422
|
|
|
6423
|
-
`
|
|
6423
|
+
`KeyLike`
|
|
6424
6424
|
|
|
6425
6425
|
密钥 32 个英文字母和数字
|
|
6426
6426
|
|
|
@@ -6462,7 +6462,7 @@ SM4 解密
|
|
|
6462
6462
|
|
|
6463
6463
|
#### key
|
|
6464
6464
|
|
|
6465
|
-
`
|
|
6465
|
+
`KeyLike`
|
|
6466
6466
|
|
|
6467
6467
|
密钥 32 个英文字母和数字
|
|
6468
6468
|
|
|
@@ -6515,7 +6515,7 @@ SM4 加密
|
|
|
6515
6515
|
|
|
6516
6516
|
#### key
|
|
6517
6517
|
|
|
6518
|
-
`
|
|
6518
|
+
`KeyLike`
|
|
6519
6519
|
|
|
6520
6520
|
密钥 32 个英文字母和数字
|
|
6521
6521
|
|
|
@@ -6557,7 +6557,7 @@ SM4 加密
|
|
|
6557
6557
|
|
|
6558
6558
|
#### key
|
|
6559
6559
|
|
|
6560
|
-
`
|
|
6560
|
+
`KeyLike`
|
|
6561
6561
|
|
|
6562
6562
|
密钥 32 个英文字母和数字
|
|
6563
6563
|
|
|
@@ -6631,7 +6631,7 @@ Defined in: [lib/crypto.ts:90](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
6631
6631
|
|
|
6632
6632
|
### data
|
|
6633
6633
|
|
|
6634
|
-
`
|
|
6634
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
6635
6635
|
|
|
6636
6636
|
数据
|
|
6637
6637
|
|
|
@@ -8623,10 +8623,14 @@ lib/fs/functions/getContent.md
|
|
|
8623
8623
|
|
|
8624
8624
|
## Param
|
|
8625
8625
|
|
|
8626
|
+
**path**
|
|
8627
|
+
|
|
8626
8628
|
文件路径
|
|
8627
8629
|
|
|
8628
8630
|
## Param
|
|
8629
8631
|
|
|
8632
|
+
**options**
|
|
8633
|
+
|
|
8630
8634
|
编码或选项
|
|
8631
8635
|
|
|
8632
8636
|
## Call Signature
|
|
@@ -10720,7 +10724,7 @@ Defined in: [lib/net/formdata.ts:37](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
10720
10724
|
|
|
10721
10725
|
> **new FormData**(`options?`): `FormData`
|
|
10722
10726
|
|
|
10723
|
-
Defined in: node\_modules/@types/node/stream.d.ts:
|
|
10727
|
+
Defined in: node\_modules/@types/node/stream.d.ts:81
|
|
10724
10728
|
|
|
10725
10729
|
#### Parameters
|
|
10726
10730
|
|
|
@@ -13959,7 +13963,7 @@ Defined in: [lib/sql.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
13959
13963
|
|
|
13960
13964
|
> **new Sql**(`opt`): `Sql`
|
|
13961
13965
|
|
|
13962
|
-
Defined in: [lib/sql.ts:
|
|
13966
|
+
Defined in: [lib/sql.ts:72](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L72)
|
|
13963
13967
|
|
|
13964
13968
|
#### Parameters
|
|
13965
13969
|
|
|
@@ -14001,7 +14005,7 @@ Defined in: [lib/sql.ts:69](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14001
14005
|
|
|
14002
14006
|
> **append**(`sql`): `this`
|
|
14003
14007
|
|
|
14004
|
-
Defined in: [lib/sql.ts:
|
|
14008
|
+
Defined in: [lib/sql.ts:1041](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1041)
|
|
14005
14009
|
|
|
14006
14010
|
在 sql 最后追加字符串
|
|
14007
14011
|
|
|
@@ -14021,7 +14025,7 @@ Defined in: [lib/sql.ts:1006](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
14021
14025
|
|
|
14022
14026
|
> **by**(`c`, `d?`): `this`
|
|
14023
14027
|
|
|
14024
|
-
Defined in: [lib/sql.ts:
|
|
14028
|
+
Defined in: [lib/sql.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L793)
|
|
14025
14029
|
|
|
14026
14030
|
ORDER BY
|
|
14027
14031
|
|
|
@@ -14049,7 +14053,7 @@ ORDER BY
|
|
|
14049
14053
|
|
|
14050
14054
|
> **copy**(`f?`, `opt?`): `Sql`
|
|
14051
14055
|
|
|
14052
|
-
Defined in: [lib/sql.ts:
|
|
14056
|
+
Defined in: [lib/sql.ts:861](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L861)
|
|
14053
14057
|
|
|
14054
14058
|
创建一个本对象的一个新的 sql 对象拷贝
|
|
14055
14059
|
|
|
@@ -14077,7 +14081,7 @@ Defined in: [lib/sql.ts:830](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14077
14081
|
|
|
14078
14082
|
> **crossJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14079
14083
|
|
|
14080
|
-
Defined in: [lib/sql.ts:
|
|
14084
|
+
Defined in: [lib/sql.ts:522](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L522)
|
|
14081
14085
|
|
|
14082
14086
|
cross join 方法
|
|
14083
14087
|
|
|
@@ -14117,7 +14121,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14117
14121
|
|
|
14118
14122
|
> **delete**(`f`): `this`
|
|
14119
14123
|
|
|
14120
|
-
Defined in: [lib/sql.ts:
|
|
14124
|
+
Defined in: [lib/sql.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L410)
|
|
14121
14125
|
|
|
14122
14126
|
'xx'
|
|
14123
14127
|
|
|
@@ -14139,7 +14143,7 @@ Defined in: [lib/sql.ts:379](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14139
14143
|
|
|
14140
14144
|
> **field**(`str`, `pre?`, `suf?`): `string`
|
|
14141
14145
|
|
|
14142
|
-
Defined in: [lib/sql.ts:
|
|
14146
|
+
Defined in: [lib/sql.ts:1052](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1052)
|
|
14143
14147
|
|
|
14144
14148
|
对字段进行包裹
|
|
14145
14149
|
|
|
@@ -14171,7 +14175,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅请在 field 表名时
|
|
|
14171
14175
|
|
|
14172
14176
|
> **format**(`sql?`, `data?`): `string`
|
|
14173
14177
|
|
|
14174
|
-
Defined in: [lib/sql.ts:
|
|
14178
|
+
Defined in: [lib/sql.ts:1031](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1031)
|
|
14175
14179
|
|
|
14176
14180
|
获取带 data 的 sql 语句
|
|
14177
14181
|
|
|
@@ -14195,7 +14199,7 @@ Defined in: [lib/sql.ts:996](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14195
14199
|
|
|
14196
14200
|
> **fullJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14197
14201
|
|
|
14198
|
-
Defined in: [lib/sql.ts:
|
|
14202
|
+
Defined in: [lib/sql.ts:511](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L511)
|
|
14199
14203
|
|
|
14200
14204
|
full join 方法
|
|
14201
14205
|
|
|
@@ -14235,7 +14239,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14235
14239
|
|
|
14236
14240
|
> **getData**(): [`DbValue`](../../../index/type-aliases/DbValue.md)[]
|
|
14237
14241
|
|
|
14238
|
-
Defined in: [lib/sql.ts:
|
|
14242
|
+
Defined in: [lib/sql.ts:1015](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1015)
|
|
14239
14243
|
|
|
14240
14244
|
获取全部 data
|
|
14241
14245
|
|
|
@@ -14249,7 +14253,7 @@ Defined in: [lib/sql.ts:980](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14249
14253
|
|
|
14250
14254
|
> **getPre**(): `string`
|
|
14251
14255
|
|
|
14252
|
-
Defined in: [lib/sql.ts:
|
|
14256
|
+
Defined in: [lib/sql.ts:1022](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1022)
|
|
14253
14257
|
|
|
14254
14258
|
获取定义的 pre
|
|
14255
14259
|
|
|
@@ -14263,7 +14267,7 @@ Defined in: [lib/sql.ts:987](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14263
14267
|
|
|
14264
14268
|
> **getSql**(): `string`
|
|
14265
14269
|
|
|
14266
|
-
Defined in: [lib/sql.ts:
|
|
14270
|
+
Defined in: [lib/sql.ts:995](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L995)
|
|
14267
14271
|
|
|
14268
14272
|
获取 sql 语句
|
|
14269
14273
|
|
|
@@ -14277,7 +14281,7 @@ Defined in: [lib/sql.ts:964](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14277
14281
|
|
|
14278
14282
|
> **group**(`c`): `this`
|
|
14279
14283
|
|
|
14280
|
-
Defined in: [lib/sql.ts:
|
|
14284
|
+
Defined in: [lib/sql.ts:817](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L817)
|
|
14281
14285
|
|
|
14282
14286
|
GROUP BY
|
|
14283
14287
|
|
|
@@ -14299,7 +14303,7 @@ GROUP BY
|
|
|
14299
14303
|
|
|
14300
14304
|
> **having**(`s?`): `this`
|
|
14301
14305
|
|
|
14302
|
-
Defined in: [lib/sql.ts:
|
|
14306
|
+
Defined in: [lib/sql.ts:529](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L529)
|
|
14303
14307
|
|
|
14304
14308
|
having 后置筛选器,用法类似 where
|
|
14305
14309
|
|
|
@@ -14315,11 +14319,56 @@ having 后置筛选器,用法类似 where
|
|
|
14315
14319
|
|
|
14316
14320
|
***
|
|
14317
14321
|
|
|
14322
|
+
### hint()
|
|
14323
|
+
|
|
14324
|
+
> **hint**(`h`): `this`
|
|
14325
|
+
|
|
14326
|
+
Defined in: [lib/sql.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L118)
|
|
14327
|
+
|
|
14328
|
+
设置 MySQL 优化器 Hint
|
|
14329
|
+
会以 Optimizer Hint 注释语法注入到 SELECT 关键字后
|
|
14330
|
+
传入 hint 内容即可,无需包裹注释符号
|
|
14331
|
+
|
|
14332
|
+
#### Parameters
|
|
14333
|
+
|
|
14334
|
+
##### h
|
|
14335
|
+
|
|
14336
|
+
`string`
|
|
14337
|
+
|
|
14338
|
+
Hint 内容
|
|
14339
|
+
|
|
14340
|
+
#### Returns
|
|
14341
|
+
|
|
14342
|
+
`this`
|
|
14343
|
+
|
|
14344
|
+
#### Example
|
|
14345
|
+
|
|
14346
|
+
```ts
|
|
14347
|
+
// --- 强制走指定索引(最常用)
|
|
14348
|
+
INDEX(`supply_date_0_0` `idx_supply_date_query`)
|
|
14349
|
+
|
|
14350
|
+
// --- 指定某表不用某索引
|
|
14351
|
+
NO_INDEX(`supply_date_0_0` `idx_old`)
|
|
14352
|
+
|
|
14353
|
+
// --- 指定 JOIN 顺序和索引
|
|
14354
|
+
JOIN_ORDER(`a` `b`) INDEX(`a` `idx_a`) INDEX(`b` `idx_b`)
|
|
14355
|
+
|
|
14356
|
+
// --- 指定 JOIN 中某表使用的索引
|
|
14357
|
+
JOIN_INDEX(`supply_date_0_0` `idx_supply_date_query`)
|
|
14358
|
+
|
|
14359
|
+
// --- 多表多索引组合
|
|
14360
|
+
INDEX(`t1` `idx_a`) JOIN_INDEX(`t2` `idx_b`)
|
|
14361
|
+
|
|
14362
|
+
// --- 官方文档: https://dev.mysql.com/doc/refman/8.0/en/optimizer-hints.html
|
|
14363
|
+
```
|
|
14364
|
+
|
|
14365
|
+
***
|
|
14366
|
+
|
|
14318
14367
|
### innerJoin()
|
|
14319
14368
|
|
|
14320
14369
|
> **innerJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14321
14370
|
|
|
14322
|
-
Defined in: [lib/sql.ts:
|
|
14371
|
+
Defined in: [lib/sql.ts:500](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L500)
|
|
14323
14372
|
|
|
14324
14373
|
inner join 方法
|
|
14325
14374
|
|
|
@@ -14359,7 +14408,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14359
14408
|
|
|
14360
14409
|
> **insert**(`table`, `ignore?`): `this`
|
|
14361
14410
|
|
|
14362
|
-
Defined in: [lib/sql.ts:
|
|
14411
|
+
Defined in: [lib/sql.ts:130](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L130)
|
|
14363
14412
|
|
|
14364
14413
|
插入数据前导
|
|
14365
14414
|
|
|
@@ -14387,7 +14436,7 @@ Defined in: [lib/sql.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14387
14436
|
|
|
14388
14437
|
> **join**(`f`, `s?`, `type?`, `suf?`, `pre?`): `this`
|
|
14389
14438
|
|
|
14390
|
-
Defined in: [lib/sql.ts:
|
|
14439
|
+
Defined in: [lib/sql.ts:452](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L452)
|
|
14391
14440
|
|
|
14392
14441
|
join 方法
|
|
14393
14442
|
|
|
@@ -14433,7 +14482,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14433
14482
|
|
|
14434
14483
|
> **leftJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14435
14484
|
|
|
14436
|
-
Defined in: [lib/sql.ts:
|
|
14485
|
+
Defined in: [lib/sql.ts:478](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L478)
|
|
14437
14486
|
|
|
14438
14487
|
left join 方法
|
|
14439
14488
|
|
|
@@ -14473,7 +14522,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14473
14522
|
|
|
14474
14523
|
> **limit**(`a`, `b?`): `this`
|
|
14475
14524
|
|
|
14476
|
-
Defined in: [lib/sql.ts:
|
|
14525
|
+
Defined in: [lib/sql.ts:837](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L837)
|
|
14477
14526
|
|
|
14478
14527
|
LIMIT(limit、offset, limit)
|
|
14479
14528
|
|
|
@@ -14501,7 +14550,7 @@ LIMIT(limit、offset, limit)
|
|
|
14501
14550
|
|
|
14502
14551
|
> **lock**(): `this`
|
|
14503
14552
|
|
|
14504
|
-
Defined in: [lib/sql.ts:
|
|
14553
|
+
Defined in: [lib/sql.ts:852](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L852)
|
|
14505
14554
|
|
|
14506
14555
|
追加消极锁,通常不建议使用
|
|
14507
14556
|
|
|
@@ -14515,7 +14564,7 @@ Defined in: [lib/sql.ts:821](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14515
14564
|
|
|
14516
14565
|
> **rightJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14517
14566
|
|
|
14518
|
-
Defined in: [lib/sql.ts:
|
|
14567
|
+
Defined in: [lib/sql.ts:489](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L489)
|
|
14519
14568
|
|
|
14520
14569
|
right join 方法
|
|
14521
14570
|
|
|
@@ -14555,7 +14604,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14555
14604
|
|
|
14556
14605
|
> **select**(`c`, `f`): `this`
|
|
14557
14606
|
|
|
14558
|
-
Defined in: [lib/sql.ts:
|
|
14607
|
+
Defined in: [lib/sql.ts:301](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L301)
|
|
14559
14608
|
|
|
14560
14609
|
'*', 'xx'
|
|
14561
14610
|
|
|
@@ -14583,7 +14632,7 @@ Defined in: [lib/sql.ts:270](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14583
14632
|
|
|
14584
14633
|
> **union**(`lsql`, `type?`): `this`
|
|
14585
14634
|
|
|
14586
|
-
Defined in: [lib/sql.ts:
|
|
14635
|
+
Defined in: [lib/sql.ts:422](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L422)
|
|
14587
14636
|
|
|
14588
14637
|
联查另一个 sql 对象
|
|
14589
14638
|
|
|
@@ -14611,7 +14660,7 @@ sql 对象
|
|
|
14611
14660
|
|
|
14612
14661
|
> **unionAll**(`lsql`): `this`
|
|
14613
14662
|
|
|
14614
|
-
Defined in: [lib/sql.ts:
|
|
14663
|
+
Defined in: [lib/sql.ts:440](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L440)
|
|
14615
14664
|
|
|
14616
14665
|
所有联查另一个 sql 对象
|
|
14617
14666
|
|
|
@@ -14633,7 +14682,7 @@ sql 对象
|
|
|
14633
14682
|
|
|
14634
14683
|
> **update**(`f`, `s`): `this`
|
|
14635
14684
|
|
|
14636
|
-
Defined in: [lib/sql.ts:
|
|
14685
|
+
Defined in: [lib/sql.ts:342](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L342)
|
|
14637
14686
|
|
|
14638
14687
|
UPDATE SQL 方法
|
|
14639
14688
|
|
|
@@ -14661,7 +14710,7 @@ UPDATE SQL 方法
|
|
|
14661
14710
|
|
|
14662
14711
|
> **updateByValues**(`table`, `key`, `cols`, `rows`): `this`
|
|
14663
14712
|
|
|
14664
|
-
Defined in: [lib/sql.ts:
|
|
14713
|
+
Defined in: [lib/sql.ts:246](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L246)
|
|
14665
14714
|
|
|
14666
14715
|
批量 UPDATE,以子查询作为数据源,纯更新语义(不会插入新行)
|
|
14667
14716
|
MySQL: UPDATE t INNER JOIN (SELECT col AS alias ... UNION ALL SELECT ...) AS tmp ON t.key=tmp.key SET t.c=tmp.c
|
|
@@ -14704,7 +14753,7 @@ PostgreSQL: UPDATE t SET c=tmp.c FROM (VALUES ($1,...)) AS tmp(cols) WHERE t.key
|
|
|
14704
14753
|
|
|
14705
14754
|
> **upsert**(`data`, `conflict?`): `this`
|
|
14706
14755
|
|
|
14707
|
-
Defined in: [lib/sql.ts:
|
|
14756
|
+
Defined in: [lib/sql.ts:207](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L207)
|
|
14708
14757
|
|
|
14709
14758
|
如果存在则更新不存在则插入(UPSERT)
|
|
14710
14759
|
|
|
@@ -14732,7 +14781,7 @@ Defined in: [lib/sql.ts:176](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14732
14781
|
|
|
14733
14782
|
> **values**(`cs`, `vs?`): `this`
|
|
14734
14783
|
|
|
14735
|
-
Defined in: [lib/sql.ts:
|
|
14784
|
+
Defined in: [lib/sql.ts:149](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L149)
|
|
14736
14785
|
|
|
14737
14786
|
实际插入数据的数据
|
|
14738
14787
|
|
|
@@ -14760,7 +14809,7 @@ Defined in: [lib/sql.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14760
14809
|
|
|
14761
14810
|
> **where**(`s`): `this`
|
|
14762
14811
|
|
|
14763
|
-
Defined in: [lib/sql.ts:
|
|
14812
|
+
Defined in: [lib/sql.ts:563](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L563)
|
|
14764
14813
|
|
|
14765
14814
|
筛选器
|
|
14766
14815
|
1. 'city': 'bj', 'type': '2'
|
|
@@ -14903,7 +14952,7 @@ lib/sql/functions/aoMix.md
|
|
|
14903
14952
|
|
|
14904
14953
|
> **aoMix**(`arr`): `Record`\<`string`, `string` \| `number` \| [`Json`](../../../index/type-aliases/Json.md)\>
|
|
14905
14954
|
|
|
14906
|
-
Defined in: [lib/sql.ts:
|
|
14955
|
+
Defined in: [lib/sql.ts:1437](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1437)
|
|
14907
14956
|
|
|
14908
14957
|
将数组兑换为组合的对象(Array/Object mix)
|
|
14909
14958
|
|
|
@@ -14932,7 +14981,7 @@ lib/sql/functions/column.md
|
|
|
14932
14981
|
|
|
14933
14982
|
> **column**(`field`): `object`
|
|
14934
14983
|
|
|
14935
|
-
Defined in: [lib/sql.ts:
|
|
14984
|
+
Defined in: [lib/sql.ts:1458](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1458)
|
|
14936
14985
|
|
|
14937
14986
|
创建字段对象
|
|
14938
14987
|
|
|
@@ -14971,7 +15020,7 @@ lib/sql/functions/format.md
|
|
|
14971
15020
|
|
|
14972
15021
|
> **format**(`sql`, `data`, `service?`): `string`
|
|
14973
15022
|
|
|
14974
|
-
Defined in: [lib/sql.ts:
|
|
15023
|
+
Defined in: [lib/sql.ts:1399](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1399)
|
|
14975
15024
|
|
|
14976
15025
|
返回代入后的完整 SQL 字符串,这并不安全不能直接执行,只是用来调试打印 sql 语句
|
|
14977
15026
|
|
|
@@ -15012,7 +15061,7 @@ lib/sql/functions/get.md
|
|
|
15012
15061
|
|
|
15013
15062
|
> **get**(`opt`): [`Sql`](../classes/Sql.md)
|
|
15014
15063
|
|
|
15015
|
-
Defined in: [lib/sql.ts:
|
|
15064
|
+
Defined in: [lib/sql.ts:1371](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1371)
|
|
15016
15065
|
|
|
15017
15066
|
创建 sql 对象
|
|
15018
15067
|
|
|
@@ -15063,23 +15112,29 @@ lib/sql/functions/json.md
|
|
|
15063
15112
|
|
|
15064
15113
|
# Function: json()
|
|
15065
15114
|
|
|
15066
|
-
> **json
|
|
15115
|
+
> **json**\<`T`\>(`obj`): `T`
|
|
15067
15116
|
|
|
15068
|
-
Defined in: [lib/sql.ts:
|
|
15117
|
+
Defined in: [lib/sql.ts:1496](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1496)
|
|
15069
15118
|
|
|
15070
15119
|
将对象转换为 JSON 字符串并避开类型检查,用于适配 PostgreSQL 的 jsonb 字段
|
|
15071
15120
|
|
|
15121
|
+
## Type Parameters
|
|
15122
|
+
|
|
15123
|
+
### T
|
|
15124
|
+
|
|
15125
|
+
`T`
|
|
15126
|
+
|
|
15072
15127
|
## Parameters
|
|
15073
15128
|
|
|
15074
15129
|
### obj
|
|
15075
15130
|
|
|
15076
|
-
`
|
|
15131
|
+
`T`
|
|
15077
15132
|
|
|
15078
15133
|
要转换的 JSON 对象
|
|
15079
15134
|
|
|
15080
15135
|
## Returns
|
|
15081
15136
|
|
|
15082
|
-
`
|
|
15137
|
+
`T`
|
|
15083
15138
|
|
|
15084
15139
|
lib/sql/functions/value.md
|
|
15085
15140
|
---
|
|
@@ -15094,7 +15149,7 @@ lib/sql/functions/value.md
|
|
|
15094
15149
|
|
|
15095
15150
|
> **value**(`val`): `object`
|
|
15096
15151
|
|
|
15097
|
-
Defined in: [lib/sql.ts:
|
|
15152
|
+
Defined in: [lib/sql.ts:1477](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1477)
|
|
15098
15153
|
|
|
15099
15154
|
创建字面量值对象,用于 where 条件中 v[0] 需要是值而非字段名的场景
|
|
15100
15155
|
例:[value('hello'), 'IN', column('tags')]
|
|
@@ -15562,10 +15617,14 @@ Defined in: [lib/ssh/sftp.ts:442](https://github.com/maiyunnet/kebab/blob/master
|
|
|
15562
15617
|
|
|
15563
15618
|
#### Param
|
|
15564
15619
|
|
|
15620
|
+
**path**
|
|
15621
|
+
|
|
15565
15622
|
文件路径
|
|
15566
15623
|
|
|
15567
15624
|
#### Param
|
|
15568
15625
|
|
|
15626
|
+
**options**
|
|
15627
|
+
|
|
15569
15628
|
编码或选项
|
|
15570
15629
|
|
|
15571
15630
|
#### Call Signature
|
|
@@ -18027,7 +18086,7 @@ Defined in: [lib/undici/formdata.ts:37](https://github.com/maiyunnet/kebab/blob/
|
|
|
18027
18086
|
|
|
18028
18087
|
> **new FormData**(`options?`): `FormData`
|
|
18029
18088
|
|
|
18030
|
-
Defined in: node\_modules/@types/node/stream.d.ts:
|
|
18089
|
+
Defined in: node\_modules/@types/node/stream.d.ts:81
|
|
18031
18090
|
|
|
18032
18091
|
#### Parameters
|
|
18033
18092
|
|
|
@@ -21155,10 +21214,14 @@ Defined in: [lib/zip.ts:350](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
21155
21214
|
|
|
21156
21215
|
#### Param
|
|
21157
21216
|
|
|
21217
|
+
**path**
|
|
21218
|
+
|
|
21158
21219
|
文件路径
|
|
21159
21220
|
|
|
21160
21221
|
#### Param
|
|
21161
21222
|
|
|
21223
|
+
**type**
|
|
21224
|
+
|
|
21162
21225
|
返回类型
|
|
21163
21226
|
|
|
21164
21227
|
#### Call Signature
|
|
@@ -21335,10 +21398,14 @@ string
|
|
|
21335
21398
|
|
|
21336
21399
|
#### Param
|
|
21337
21400
|
|
|
21401
|
+
**path**
|
|
21402
|
+
|
|
21338
21403
|
文件夹路径
|
|
21339
21404
|
|
|
21340
21405
|
#### Param
|
|
21341
21406
|
|
|
21407
|
+
**opt**
|
|
21408
|
+
|
|
21342
21409
|
选项
|
|
21343
21410
|
|
|
21344
21411
|
#### Call Signature
|
|
@@ -23114,12 +23181,24 @@ Defined in: [sys/ctr.ts:1102](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23114
23181
|
|
|
23115
23182
|
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
23116
23183
|
|
|
23184
|
+
###### maxFieldSize?
|
|
23185
|
+
|
|
23186
|
+
`number`
|
|
23187
|
+
|
|
23188
|
+
单个字段(非文件)最大字节数,默认 1 MB
|
|
23189
|
+
|
|
23117
23190
|
###### maxFileSize?
|
|
23118
23191
|
|
|
23119
23192
|
`number`
|
|
23120
23193
|
|
|
23121
23194
|
单个文件最大字节数
|
|
23122
23195
|
|
|
23196
|
+
###### timeout?
|
|
23197
|
+
|
|
23198
|
+
`number`
|
|
23199
|
+
|
|
23200
|
+
整体请求超时时间(毫秒),默认 5 分钟,设为 0 禁用超时
|
|
23201
|
+
|
|
23123
23202
|
#### Returns
|
|
23124
23203
|
|
|
23125
23204
|
`Promise`\<`boolean`\>
|
|
@@ -23962,6 +24041,12 @@ Defined in: [sys/mod.ts:116](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
23962
24041
|
|
|
23963
24042
|
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
23964
24043
|
|
|
24044
|
+
###### hint?
|
|
24045
|
+
|
|
24046
|
+
`string`
|
|
24047
|
+
|
|
24048
|
+
MySQL 优化器 Hint,如 `INDEX(\`t\` \`idx_xx\`)`,注入到 SELECT 后
|
|
24049
|
+
|
|
23965
24050
|
###### index?
|
|
23966
24051
|
|
|
23967
24052
|
`string` \| `string`[]
|
|
@@ -24136,7 +24221,7 @@ Defined in: [sys/mod.ts:68](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
24136
24221
|
|
|
24137
24222
|
> `protected` **\_keyGenerator**(): `string`
|
|
24138
24223
|
|
|
24139
|
-
Defined in: [sys/mod.ts:
|
|
24224
|
+
Defined in: [sys/mod.ts:1843](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1843)
|
|
24140
24225
|
|
|
24141
24226
|
当 _key 不为空时,则依据继承此方法的方法自动生成填充 key
|
|
24142
24227
|
|
|
@@ -24152,13 +24237,15 @@ Defined in: [sys/mod.ts:1797](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24152
24237
|
|
|
24153
24238
|
#### Param
|
|
24154
24239
|
|
|
24240
|
+
**key**
|
|
24241
|
+
|
|
24155
24242
|
是否以某个字段为主键
|
|
24156
24243
|
|
|
24157
24244
|
#### Call Signature
|
|
24158
24245
|
|
|
24159
24246
|
> **all**(): `Promise`\<`false` \| [`Rows`](Rows.md)\<`Mod`\>\>
|
|
24160
24247
|
|
|
24161
|
-
Defined in: [sys/mod.ts:
|
|
24248
|
+
Defined in: [sys/mod.ts:1157](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1157)
|
|
24162
24249
|
|
|
24163
24250
|
##### Returns
|
|
24164
24251
|
|
|
@@ -24168,7 +24255,7 @@ Defined in: [sys/mod.ts:1139](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24168
24255
|
|
|
24169
24256
|
> **all**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Mod`\>\>
|
|
24170
24257
|
|
|
24171
|
-
Defined in: [sys/mod.ts:
|
|
24258
|
+
Defined in: [sys/mod.ts:1158](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1158)
|
|
24172
24259
|
|
|
24173
24260
|
##### Parameters
|
|
24174
24261
|
|
|
@@ -24188,13 +24275,15 @@ Defined in: [sys/mod.ts:1140](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24188
24275
|
|
|
24189
24276
|
#### Param
|
|
24190
24277
|
|
|
24278
|
+
**key**
|
|
24279
|
+
|
|
24191
24280
|
是否以某个字段为主键
|
|
24192
24281
|
|
|
24193
24282
|
#### Call Signature
|
|
24194
24283
|
|
|
24195
24284
|
> **allArray**(): `Promise`\<`false` \| `Record`\<`string`, `any`\>[]\>
|
|
24196
24285
|
|
|
24197
|
-
Defined in: [sys/mod.ts:
|
|
24286
|
+
Defined in: [sys/mod.ts:1336](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1336)
|
|
24198
24287
|
|
|
24199
24288
|
##### Returns
|
|
24200
24289
|
|
|
@@ -24204,7 +24293,7 @@ Defined in: [sys/mod.ts:1318](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24204
24293
|
|
|
24205
24294
|
> **allArray**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Record`\<`string`, `any`\>\>\>
|
|
24206
24295
|
|
|
24207
|
-
Defined in: [sys/mod.ts:
|
|
24296
|
+
Defined in: [sys/mod.ts:1337](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1337)
|
|
24208
24297
|
|
|
24209
24298
|
##### Parameters
|
|
24210
24299
|
|
|
@@ -24222,7 +24311,7 @@ Defined in: [sys/mod.ts:1319](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24222
24311
|
|
|
24223
24312
|
> **append**(`sql`): `this`
|
|
24224
24313
|
|
|
24225
|
-
Defined in: [sys/mod.ts:
|
|
24314
|
+
Defined in: [sys/mod.ts:1752](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1752)
|
|
24226
24315
|
|
|
24227
24316
|
在 sql 最后追加字符串
|
|
24228
24317
|
|
|
@@ -24242,7 +24331,7 @@ Defined in: [sys/mod.ts:1706](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24242
24331
|
|
|
24243
24332
|
> **by**(`c`, `d?`): `this`
|
|
24244
24333
|
|
|
24245
|
-
Defined in: [sys/mod.ts:
|
|
24334
|
+
Defined in: [sys/mod.ts:1708](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1708)
|
|
24246
24335
|
|
|
24247
24336
|
ORDER BY
|
|
24248
24337
|
|
|
@@ -24270,7 +24359,7 @@ ORDER BY
|
|
|
24270
24359
|
|
|
24271
24360
|
> **contain**(`contain`): `this`
|
|
24272
24361
|
|
|
24273
|
-
Defined in: [sys/mod.ts:
|
|
24362
|
+
Defined in: [sys/mod.ts:1761](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1761)
|
|
24274
24363
|
|
|
24275
24364
|
设置闭包含数据
|
|
24276
24365
|
|
|
@@ -24298,7 +24387,7 @@ Defined in: [sys/mod.ts:1715](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24298
24387
|
|
|
24299
24388
|
> **count**(): `Promise`\<`number`\>
|
|
24300
24389
|
|
|
24301
|
-
Defined in: [sys/mod.ts:
|
|
24390
|
+
Defined in: [sys/mod.ts:1544](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1544)
|
|
24302
24391
|
|
|
24303
24392
|
根据当前条件,筛选出当前条目该有的数据条数
|
|
24304
24393
|
|
|
@@ -24312,7 +24401,7 @@ Defined in: [sys/mod.ts:1526](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24312
24401
|
|
|
24313
24402
|
> **countSql**(): `string`
|
|
24314
24403
|
|
|
24315
|
-
Defined in: [sys/mod.ts:
|
|
24404
|
+
Defined in: [sys/mod.ts:1565](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1565)
|
|
24316
24405
|
|
|
24317
24406
|
获取当前条件下的 count 的 SQL 语句
|
|
24318
24407
|
|
|
@@ -24326,7 +24415,7 @@ Defined in: [sys/mod.ts:1547](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24326
24415
|
|
|
24327
24416
|
> **create**(): `Promise`\<`boolean` \| `null`\>
|
|
24328
24417
|
|
|
24329
|
-
Defined in: [sys/mod.ts:
|
|
24418
|
+
Defined in: [sys/mod.ts:839](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L839)
|
|
24330
24419
|
|
|
24331
24420
|
创建数据
|
|
24332
24421
|
|
|
@@ -24342,7 +24431,7 @@ true-成功,false-报错,null-唯一键非 _$key 键冲突
|
|
|
24342
24431
|
|
|
24343
24432
|
> **crossJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24344
24433
|
|
|
24345
|
-
Defined in: [sys/mod.ts:
|
|
24434
|
+
Defined in: [sys/mod.ts:1640](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1640)
|
|
24346
24435
|
|
|
24347
24436
|
cross join 方法
|
|
24348
24437
|
|
|
@@ -24384,13 +24473,15 @@ ON 信息
|
|
|
24384
24473
|
|
|
24385
24474
|
#### Param
|
|
24386
24475
|
|
|
24476
|
+
**all**
|
|
24477
|
+
|
|
24387
24478
|
是否获取完全的情况,默认不获取,只返回扫描情况
|
|
24388
24479
|
|
|
24389
24480
|
#### Call Signature
|
|
24390
24481
|
|
|
24391
24482
|
> **explain**(`all?`): `Promise`\<`string` \| `false`\>
|
|
24392
24483
|
|
|
24393
|
-
Defined in: [sys/mod.ts:
|
|
24484
|
+
Defined in: [sys/mod.ts:1462](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1462)
|
|
24394
24485
|
|
|
24395
24486
|
##### Parameters
|
|
24396
24487
|
|
|
@@ -24406,7 +24497,7 @@ Defined in: [sys/mod.ts:1444](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24406
24497
|
|
|
24407
24498
|
> **explain**(`all`): `Promise`\<`false` \| `Record`\<`string`, `any`\>\>
|
|
24408
24499
|
|
|
24409
|
-
Defined in: [sys/mod.ts:
|
|
24500
|
+
Defined in: [sys/mod.ts:1463](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1463)
|
|
24410
24501
|
|
|
24411
24502
|
##### Parameters
|
|
24412
24503
|
|
|
@@ -24424,7 +24515,7 @@ Defined in: [sys/mod.ts:1445](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24424
24515
|
|
|
24425
24516
|
> **filter**(`s`): `this`
|
|
24426
24517
|
|
|
24427
|
-
Defined in: [sys/mod.ts:
|
|
24518
|
+
Defined in: [sys/mod.ts:1686](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1686)
|
|
24428
24519
|
|
|
24429
24520
|
筛选器
|
|
24430
24521
|
|
|
@@ -24448,17 +24539,21 @@ Defined in: [sys/mod.ts:1640](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24448
24539
|
|
|
24449
24540
|
#### Param
|
|
24450
24541
|
|
|
24542
|
+
**lock**
|
|
24543
|
+
|
|
24451
24544
|
是否加锁
|
|
24452
24545
|
|
|
24453
24546
|
#### Param
|
|
24454
24547
|
|
|
24548
|
+
**array**
|
|
24549
|
+
|
|
24455
24550
|
是否返回原生对象
|
|
24456
24551
|
|
|
24457
24552
|
#### Call Signature
|
|
24458
24553
|
|
|
24459
24554
|
> **first**(`lock`, `array`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24460
24555
|
|
|
24461
|
-
Defined in: [sys/mod.ts:
|
|
24556
|
+
Defined in: [sys/mod.ts:1046](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1046)
|
|
24462
24557
|
|
|
24463
24558
|
##### Parameters
|
|
24464
24559
|
|
|
@@ -24478,7 +24573,7 @@ Defined in: [sys/mod.ts:1028](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24478
24573
|
|
|
24479
24574
|
> **first**(`lock?`, `array?`): `Promise`\<`false` \| `Mod` & `Record`\<`string`, `any`\> \| `null`\>
|
|
24480
24575
|
|
|
24481
|
-
Defined in: [sys/mod.ts:
|
|
24576
|
+
Defined in: [sys/mod.ts:1050](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1050)
|
|
24482
24577
|
|
|
24483
24578
|
##### Parameters
|
|
24484
24579
|
|
|
@@ -24500,7 +24595,7 @@ Defined in: [sys/mod.ts:1032](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24500
24595
|
|
|
24501
24596
|
> **firstArray**(`lock?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24502
24597
|
|
|
24503
|
-
Defined in: [sys/mod.ts:
|
|
24598
|
+
Defined in: [sys/mod.ts:1090](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1090)
|
|
24504
24599
|
|
|
24505
24600
|
获取数据库第一个原生对象
|
|
24506
24601
|
|
|
@@ -24522,7 +24617,7 @@ Defined in: [sys/mod.ts:1072](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24522
24617
|
|
|
24523
24618
|
> **format**(`sql?`, `data?`): `string`
|
|
24524
24619
|
|
|
24525
|
-
Defined in: [sys/mod.ts:
|
|
24620
|
+
Defined in: [sys/mod.ts:1788](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1788)
|
|
24526
24621
|
|
|
24527
24622
|
获取带 data 的 sql 语句
|
|
24528
24623
|
|
|
@@ -24550,7 +24645,7 @@ sql 语句
|
|
|
24550
24645
|
|
|
24551
24646
|
> **fullJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24552
24647
|
|
|
24553
|
-
Defined in: [sys/mod.ts:
|
|
24648
|
+
Defined in: [sys/mod.ts:1628](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1628)
|
|
24554
24649
|
|
|
24555
24650
|
full join 方法
|
|
24556
24651
|
|
|
@@ -24590,7 +24685,7 @@ ON 信息
|
|
|
24590
24685
|
|
|
24591
24686
|
> **get**(`n`): `any`
|
|
24592
24687
|
|
|
24593
|
-
Defined in: [sys/mod.ts:
|
|
24688
|
+
Defined in: [sys/mod.ts:831](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L831)
|
|
24594
24689
|
|
|
24595
24690
|
获取一个字段值
|
|
24596
24691
|
|
|
@@ -24612,7 +24707,7 @@ Defined in: [sys/mod.ts:813](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24612
24707
|
|
|
24613
24708
|
> **getData**(): `any`[]
|
|
24614
24709
|
|
|
24615
|
-
Defined in: [sys/mod.ts:
|
|
24710
|
+
Defined in: [sys/mod.ts:1779](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1779)
|
|
24616
24711
|
|
|
24617
24712
|
获取全部 data
|
|
24618
24713
|
|
|
@@ -24626,7 +24721,7 @@ Defined in: [sys/mod.ts:1733](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24626
24721
|
|
|
24627
24722
|
> **getSql**(): `string`
|
|
24628
24723
|
|
|
24629
|
-
Defined in: [sys/mod.ts:
|
|
24724
|
+
Defined in: [sys/mod.ts:1772](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1772)
|
|
24630
24725
|
|
|
24631
24726
|
获取 sql 语句
|
|
24632
24727
|
|
|
@@ -24640,7 +24735,7 @@ Defined in: [sys/mod.ts:1726](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24640
24735
|
|
|
24641
24736
|
> **group**(`c`): `this`
|
|
24642
24737
|
|
|
24643
|
-
Defined in: [sys/mod.ts:
|
|
24738
|
+
Defined in: [sys/mod.ts:1717](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1717)
|
|
24644
24739
|
|
|
24645
24740
|
GROUP BY
|
|
24646
24741
|
|
|
@@ -24662,7 +24757,7 @@ GROUP BY
|
|
|
24662
24757
|
|
|
24663
24758
|
> **having**(`s`): `this`
|
|
24664
24759
|
|
|
24665
|
-
Defined in: [sys/mod.ts:
|
|
24760
|
+
Defined in: [sys/mod.ts:1677](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1677)
|
|
24666
24761
|
|
|
24667
24762
|
筛选器
|
|
24668
24763
|
|
|
@@ -24680,11 +24775,56 @@ Defined in: [sys/mod.ts:1631](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24680
24775
|
|
|
24681
24776
|
***
|
|
24682
24777
|
|
|
24778
|
+
### hint()
|
|
24779
|
+
|
|
24780
|
+
> **hint**(`h`): `this`
|
|
24781
|
+
|
|
24782
|
+
Defined in: [sys/mod.ts:1668](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1668)
|
|
24783
|
+
|
|
24784
|
+
设置 MySQL 优化器 Hint
|
|
24785
|
+
内容会以 Optimizer Hint 注释语法注入到 SELECT 关键字后
|
|
24786
|
+
必须在查询入口调用之后、执行方法之前链式调用
|
|
24787
|
+
|
|
24788
|
+
#### Parameters
|
|
24789
|
+
|
|
24790
|
+
##### h
|
|
24791
|
+
|
|
24792
|
+
`string`
|
|
24793
|
+
|
|
24794
|
+
Hint 内容
|
|
24795
|
+
|
|
24796
|
+
#### Returns
|
|
24797
|
+
|
|
24798
|
+
`this`
|
|
24799
|
+
|
|
24800
|
+
#### Example
|
|
24801
|
+
|
|
24802
|
+
```ts
|
|
24803
|
+
// 强制走指定索引(最常用)
|
|
24804
|
+
.hint("INDEX(`supply_date_0_0` `idx_supply_date_query`)")
|
|
24805
|
+
|
|
24806
|
+
// 指定某表不用某索引
|
|
24807
|
+
.hint("NO_INDEX(`supply_date_0_0` `idx_old`)")
|
|
24808
|
+
|
|
24809
|
+
// 指定 JOIN 顺序和索引
|
|
24810
|
+
.hint("JOIN_ORDER(`a` `b`) INDEX(`a` `idx_a`) INDEX(`b` `idx_b`)")
|
|
24811
|
+
|
|
24812
|
+
// 指定 JOIN 中某表使用的索引
|
|
24813
|
+
.hint("JOIN_INDEX(`supply_date_0_0` `idx_supply_date_query`)")
|
|
24814
|
+
|
|
24815
|
+
// 多表多索引组合
|
|
24816
|
+
.hint("INDEX(`t1` `idx_a`) JOIN_INDEX(`t2` `idx_b`)")
|
|
24817
|
+
|
|
24818
|
+
// 官方文档: https://dev.mysql.com/doc/refman/8.0/en/optimizer-hints.html
|
|
24819
|
+
```
|
|
24820
|
+
|
|
24821
|
+
***
|
|
24822
|
+
|
|
24683
24823
|
### innerJoin()
|
|
24684
24824
|
|
|
24685
24825
|
> **innerJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24686
24826
|
|
|
24687
|
-
Defined in: [sys/mod.ts:
|
|
24827
|
+
Defined in: [sys/mod.ts:1616](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1616)
|
|
24688
24828
|
|
|
24689
24829
|
inner join 方法
|
|
24690
24830
|
|
|
@@ -24724,7 +24864,7 @@ ON 信息
|
|
|
24724
24864
|
|
|
24725
24865
|
> **join**(`f`, `s?`, `type?`, `index?`, `pre?`): `this`
|
|
24726
24866
|
|
|
24727
|
-
Defined in: [sys/mod.ts:
|
|
24867
|
+
Defined in: [sys/mod.ts:1580](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1580)
|
|
24728
24868
|
|
|
24729
24869
|
#### Parameters
|
|
24730
24870
|
|
|
@@ -24768,7 +24908,7 @@ ON 信息
|
|
|
24768
24908
|
|
|
24769
24909
|
> **langText**(`col`, `lang`): `string`
|
|
24770
24910
|
|
|
24771
|
-
Defined in: [sys/mod.ts:
|
|
24911
|
+
Defined in: [sys/mod.ts:1823](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1823)
|
|
24772
24912
|
|
|
24773
24913
|
获取字段的可用语种文本
|
|
24774
24914
|
|
|
@@ -24796,7 +24936,7 @@ Defined in: [sys/mod.ts:1777](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24796
24936
|
|
|
24797
24937
|
> **leftJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24798
24938
|
|
|
24799
|
-
Defined in: [sys/mod.ts:
|
|
24939
|
+
Defined in: [sys/mod.ts:1592](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1592)
|
|
24800
24940
|
|
|
24801
24941
|
left join 方法
|
|
24802
24942
|
|
|
@@ -24836,7 +24976,7 @@ ON 信息
|
|
|
24836
24976
|
|
|
24837
24977
|
> **limit**(`a`, `b?`): `this`
|
|
24838
24978
|
|
|
24839
|
-
Defined in: [sys/mod.ts:
|
|
24979
|
+
Defined in: [sys/mod.ts:1730](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1730)
|
|
24840
24980
|
|
|
24841
24981
|
LIMIT
|
|
24842
24982
|
|
|
@@ -24864,7 +25004,7 @@ LIMIT
|
|
|
24864
25004
|
|
|
24865
25005
|
> **page**(`count`, `page?`): `this`
|
|
24866
25006
|
|
|
24867
|
-
Defined in: [sys/mod.ts:
|
|
25007
|
+
Defined in: [sys/mod.ts:1741](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1741)
|
|
24868
25008
|
|
|
24869
25009
|
分页
|
|
24870
25010
|
|
|
@@ -24892,7 +25032,7 @@ Defined in: [sys/mod.ts:1695](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24892
25032
|
|
|
24893
25033
|
> **refresh**(`lock?`): `Promise`\<`boolean` \| `null`\>
|
|
24894
25034
|
|
|
24895
|
-
Defined in: [sys/mod.ts:
|
|
25035
|
+
Defined in: [sys/mod.ts:959](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L959)
|
|
24896
25036
|
|
|
24897
25037
|
刷新当前模型获取最新数据
|
|
24898
25038
|
|
|
@@ -24914,7 +25054,7 @@ Defined in: [sys/mod.ts:941](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24914
25054
|
|
|
24915
25055
|
> **remove**(): `Promise`\<`boolean`\>
|
|
24916
25056
|
|
|
24917
|
-
Defined in: [sys/mod.ts:
|
|
25057
|
+
Defined in: [sys/mod.ts:1024](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1024)
|
|
24918
25058
|
|
|
24919
25059
|
移除本条目
|
|
24920
25060
|
|
|
@@ -24928,7 +25068,7 @@ Defined in: [sys/mod.ts:1006](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24928
25068
|
|
|
24929
25069
|
> **rightJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24930
25070
|
|
|
24931
|
-
Defined in: [sys/mod.ts:
|
|
25071
|
+
Defined in: [sys/mod.ts:1604](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1604)
|
|
24932
25072
|
|
|
24933
25073
|
right join 方法
|
|
24934
25074
|
|
|
@@ -24968,7 +25108,7 @@ ON 信息
|
|
|
24968
25108
|
|
|
24969
25109
|
> **save**(`where?`): `Promise`\<`boolean`\>
|
|
24970
25110
|
|
|
24971
|
-
Defined in: [sys/mod.ts:
|
|
25111
|
+
Defined in: [sys/mod.ts:991](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L991)
|
|
24972
25112
|
|
|
24973
25113
|
更新 set 的数据到数据库,有未保存数据时才保存
|
|
24974
25114
|
|
|
@@ -24992,17 +25132,21 @@ Defined in: [sys/mod.ts:973](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24992
25132
|
|
|
24993
25133
|
#### Param
|
|
24994
25134
|
|
|
25135
|
+
**n**
|
|
25136
|
+
|
|
24995
25137
|
字符串或键/值
|
|
24996
25138
|
|
|
24997
25139
|
#### Param
|
|
24998
25140
|
|
|
25141
|
+
**v**
|
|
25142
|
+
|
|
24999
25143
|
可能是数字
|
|
25000
25144
|
|
|
25001
25145
|
#### Call Signature
|
|
25002
25146
|
|
|
25003
25147
|
> **set**\<`T`, `TK`\>(`n`): `void`
|
|
25004
25148
|
|
|
25005
|
-
Defined in: [sys/mod.ts:
|
|
25149
|
+
Defined in: [sys/mod.ts:792](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L792)
|
|
25006
25150
|
|
|
25007
25151
|
##### Type Parameters
|
|
25008
25152
|
|
|
@@ -25028,7 +25172,7 @@ Defined in: [sys/mod.ts:774](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25028
25172
|
|
|
25029
25173
|
> **set**\<`T`, `TK`\>(`n`, `v`): `void`
|
|
25030
25174
|
|
|
25031
|
-
Defined in: [sys/mod.ts:
|
|
25175
|
+
Defined in: [sys/mod.ts:793](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L793)
|
|
25032
25176
|
|
|
25033
25177
|
##### Type Parameters
|
|
25034
25178
|
|
|
@@ -25060,7 +25204,7 @@ Defined in: [sys/mod.ts:775](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25060
25204
|
|
|
25061
25205
|
> **toArray**\<`TC`\>(): [`TOnlyProperties`](../type-aliases/TOnlyProperties.md)\<`InstanceType`\<`TC`\>\> & `Record`\<`string`, `any`\>
|
|
25062
25206
|
|
|
25063
|
-
Defined in: [sys/mod.ts:
|
|
25207
|
+
Defined in: [sys/mod.ts:1795](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1795)
|
|
25064
25208
|
|
|
25065
25209
|
获取值对象,获取的是新创建的数组
|
|
25066
25210
|
|
|
@@ -25080,7 +25224,7 @@ Defined in: [sys/mod.ts:1749](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25080
25224
|
|
|
25081
25225
|
> **total**(`f?`): `Promise`\<`number`\>
|
|
25082
25226
|
|
|
25083
|
-
Defined in: [sys/mod.ts:
|
|
25227
|
+
Defined in: [sys/mod.ts:1520](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1520)
|
|
25084
25228
|
|
|
25085
25229
|
获取总条数,自动抛弃 LIMIT,仅用于获取数据的情况(select)
|
|
25086
25230
|
|
|
@@ -25100,7 +25244,7 @@ Defined in: [sys/mod.ts:1502](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25100
25244
|
|
|
25101
25245
|
> **union**(`f`, `type?`): `this`
|
|
25102
25246
|
|
|
25103
|
-
Defined in: [sys/mod.ts:
|
|
25247
|
+
Defined in: [sys/mod.ts:1101](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1101)
|
|
25104
25248
|
|
|
25105
25249
|
联合查询表数据
|
|
25106
25250
|
|
|
@@ -25128,7 +25272,7 @@ Defined in: [sys/mod.ts:1083](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25128
25272
|
|
|
25129
25273
|
> **unionAll**(`f`): `this`
|
|
25130
25274
|
|
|
25131
|
-
Defined in: [sys/mod.ts:
|
|
25275
|
+
Defined in: [sys/mod.ts:1131](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1131)
|
|
25132
25276
|
|
|
25133
25277
|
所有联合查询表数据
|
|
25134
25278
|
|
|
@@ -25150,7 +25294,7 @@ Defined in: [sys/mod.ts:1113](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25150
25294
|
|
|
25151
25295
|
> **unsaved**(): `boolean`
|
|
25152
25296
|
|
|
25153
|
-
Defined in: [sys/mod.ts:
|
|
25297
|
+
Defined in: [sys/mod.ts:1814](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1814)
|
|
25154
25298
|
|
|
25155
25299
|
当前是否设置了未保存 --=
|
|
25156
25300
|
|
|
@@ -25164,7 +25308,7 @@ Defined in: [sys/mod.ts:1768](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25164
25308
|
|
|
25165
25309
|
> **updates**(): `Record`\<`string`, `any`\>
|
|
25166
25310
|
|
|
25167
|
-
Defined in: [sys/mod.ts:
|
|
25311
|
+
Defined in: [sys/mod.ts:1803](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1803)
|
|
25168
25312
|
|
|
25169
25313
|
获取当前设置要提交的数据
|
|
25170
25314
|
|
|
@@ -25178,7 +25322,7 @@ Defined in: [sys/mod.ts:1757](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25178
25322
|
|
|
25179
25323
|
> **upsert**(`conflict`): `Promise`\<`boolean`\>
|
|
25180
25324
|
|
|
25181
|
-
Defined in: [sys/mod.ts:
|
|
25325
|
+
Defined in: [sys/mod.ts:929](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L929)
|
|
25182
25326
|
|
|
25183
25327
|
插入数据,如果存在则更新(UPSERT)
|
|
25184
25328
|
|
|
@@ -25200,7 +25344,7 @@ Defined in: [sys/mod.ts:911](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25200
25344
|
|
|
25201
25345
|
> **where**(`s`): `this`
|
|
25202
25346
|
|
|
25203
|
-
Defined in: [sys/mod.ts:
|
|
25347
|
+
Defined in: [sys/mod.ts:1697](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1697)
|
|
25204
25348
|
|
|
25205
25349
|
是 filter 的别名
|
|
25206
25350
|
|
|
@@ -25222,7 +25366,7 @@ Defined in: [sys/mod.ts:1651](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25222
25366
|
|
|
25223
25367
|
> `static` **column**(`field`): `object`
|
|
25224
25368
|
|
|
25225
|
-
Defined in: [sys/mod.ts:
|
|
25369
|
+
Defined in: [sys/mod.ts:181](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L181)
|
|
25226
25370
|
|
|
25227
25371
|
创建字段对象
|
|
25228
25372
|
|
|
@@ -25254,7 +25398,7 @@ Defined in: [sys/mod.ts:175](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25254
25398
|
|
|
25255
25399
|
> `static` **find**\<`T`\>(`db`, `val`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25256
25400
|
|
|
25257
|
-
Defined in: [sys/mod.ts:
|
|
25401
|
+
Defined in: [sys/mod.ts:607](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L607)
|
|
25258
25402
|
|
|
25259
25403
|
根据主键(或 key 字段)获取对象
|
|
25260
25404
|
|
|
@@ -25286,6 +25430,10 @@ Defined in: [sys/mod.ts:597](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25286
25430
|
|
|
25287
25431
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25288
25432
|
|
|
25433
|
+
###### hint?
|
|
25434
|
+
|
|
25435
|
+
`string`
|
|
25436
|
+
|
|
25289
25437
|
###### index?
|
|
25290
25438
|
|
|
25291
25439
|
`string` \| `string`[]
|
|
@@ -25314,7 +25462,7 @@ Defined in: [sys/mod.ts:597](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25314
25462
|
|
|
25315
25463
|
> `static` **getCreate**\<`T`\>(`db`, `opt?`): `T`
|
|
25316
25464
|
|
|
25317
|
-
Defined in: [sys/mod.ts:
|
|
25465
|
+
Defined in: [sys/mod.ts:589](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L589)
|
|
25318
25466
|
|
|
25319
25467
|
获取创建对象,通常用于新建数据库条目
|
|
25320
25468
|
|
|
@@ -25358,7 +25506,7 @@ Defined in: [sys/mod.ts:579](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25358
25506
|
|
|
25359
25507
|
> `static` **insert**(`db`, `cs`, `vs?`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
25360
25508
|
|
|
25361
|
-
Defined in: [sys/mod.ts:
|
|
25509
|
+
Defined in: [sys/mod.ts:210](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L210)
|
|
25362
25510
|
|
|
25363
25511
|
添加一个序列(允许超过 65536 的占位符会被拆分多次执行)
|
|
25364
25512
|
|
|
@@ -25412,7 +25560,7 @@ Defined in: [sys/mod.ts:204](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25412
25560
|
|
|
25413
25561
|
> `static` **insertSql**(`db`, `cs`, `vs?`, `opt?`): `string`
|
|
25414
25562
|
|
|
25415
|
-
Defined in: [sys/mod.ts:
|
|
25563
|
+
Defined in: [sys/mod.ts:270](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L270)
|
|
25416
25564
|
|
|
25417
25565
|
获取添加一个序列的模拟 SQL
|
|
25418
25566
|
|
|
@@ -25464,21 +25612,27 @@ Defined in: [sys/mod.ts:264](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25464
25612
|
|
|
25465
25613
|
### json()
|
|
25466
25614
|
|
|
25467
|
-
> `static` **json
|
|
25615
|
+
> `static` **json**\<`T`\>(`obj`): `T`
|
|
25468
25616
|
|
|
25469
|
-
Defined in: [sys/mod.ts:
|
|
25617
|
+
Defined in: [sys/mod.ts:199](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L199)
|
|
25470
25618
|
|
|
25471
25619
|
创建 JSON 字符串对象,用于 PGSQL 的 jsonb 字段
|
|
25472
25620
|
|
|
25621
|
+
#### Type Parameters
|
|
25622
|
+
|
|
25623
|
+
##### T
|
|
25624
|
+
|
|
25625
|
+
`T`
|
|
25626
|
+
|
|
25473
25627
|
#### Parameters
|
|
25474
25628
|
|
|
25475
25629
|
##### obj
|
|
25476
25630
|
|
|
25477
|
-
`
|
|
25631
|
+
`T`
|
|
25478
25632
|
|
|
25479
25633
|
#### Returns
|
|
25480
25634
|
|
|
25481
|
-
`
|
|
25635
|
+
`T`
|
|
25482
25636
|
|
|
25483
25637
|
***
|
|
25484
25638
|
|
|
@@ -25488,21 +25642,27 @@ Defined in: [sys/mod.ts:193](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25488
25642
|
|
|
25489
25643
|
#### Param
|
|
25490
25644
|
|
|
25645
|
+
**db**
|
|
25646
|
+
|
|
25491
25647
|
数据库对象
|
|
25492
25648
|
|
|
25493
25649
|
#### Param
|
|
25494
25650
|
|
|
25651
|
+
**s**
|
|
25652
|
+
|
|
25495
25653
|
筛选条件数组或字符串
|
|
25496
25654
|
|
|
25497
25655
|
#### Param
|
|
25498
25656
|
|
|
25657
|
+
**opt**
|
|
25658
|
+
|
|
25499
25659
|
选项(opt.pre: MySQL 表前缀/PostgreSQL Schema 名;lock 需确保 where 条件命中索引,否则可能退化为表锁)
|
|
25500
25660
|
|
|
25501
25661
|
#### Call Signature
|
|
25502
25662
|
|
|
25503
25663
|
> `static` **one**(`db`, `s`, `opt`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25504
25664
|
|
|
25505
|
-
Defined in: [sys/mod.ts:
|
|
25665
|
+
Defined in: [sys/mod.ts:636](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L636)
|
|
25506
25666
|
|
|
25507
25667
|
##### Parameters
|
|
25508
25668
|
|
|
@@ -25528,6 +25688,10 @@ Defined in: [sys/mod.ts:624](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25528
25688
|
|
|
25529
25689
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25530
25690
|
|
|
25691
|
+
###### hint?
|
|
25692
|
+
|
|
25693
|
+
`string`
|
|
25694
|
+
|
|
25531
25695
|
###### index?
|
|
25532
25696
|
|
|
25533
25697
|
`string` \| `string`[]
|
|
@@ -25552,7 +25716,7 @@ Defined in: [sys/mod.ts:624](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25552
25716
|
|
|
25553
25717
|
> `static` **one**\<`T`\>(`db`, `s`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25554
25718
|
|
|
25555
|
-
Defined in: [sys/mod.ts:
|
|
25719
|
+
Defined in: [sys/mod.ts:650](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L650)
|
|
25556
25720
|
|
|
25557
25721
|
##### Type Parameters
|
|
25558
25722
|
|
|
@@ -25584,6 +25748,10 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25584
25748
|
|
|
25585
25749
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25586
25750
|
|
|
25751
|
+
###### hint?
|
|
25752
|
+
|
|
25753
|
+
`string`
|
|
25754
|
+
|
|
25587
25755
|
###### index?
|
|
25588
25756
|
|
|
25589
25757
|
`string` \| `string`[]
|
|
@@ -25610,7 +25778,7 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25610
25778
|
|
|
25611
25779
|
> `static` **oneArray**(`db`, `s`, `opt?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25612
25780
|
|
|
25613
|
-
Defined in: [sys/mod.ts:
|
|
25781
|
+
Defined in: [sys/mod.ts:731](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L731)
|
|
25614
25782
|
|
|
25615
25783
|
通过 where 条件筛选单条数据返回原生对象
|
|
25616
25784
|
|
|
@@ -25636,6 +25804,10 @@ Defined in: [sys/mod.ts:714](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25636
25804
|
|
|
25637
25805
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25638
25806
|
|
|
25807
|
+
###### hint?
|
|
25808
|
+
|
|
25809
|
+
`string`
|
|
25810
|
+
|
|
25639
25811
|
###### index?
|
|
25640
25812
|
|
|
25641
25813
|
`string` \| `string`[]
|
|
@@ -25662,7 +25834,7 @@ Defined in: [sys/mod.ts:714](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25662
25834
|
|
|
25663
25835
|
> `static` **primarys**(`db`, `where?`, `opt?`): `Promise`\<`false` \| `any`[]\>
|
|
25664
25836
|
|
|
25665
|
-
Defined in: [sys/mod.ts:
|
|
25837
|
+
Defined in: [sys/mod.ts:753](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L753)
|
|
25666
25838
|
|
|
25667
25839
|
根据 where 条件获取主键值列表
|
|
25668
25840
|
|
|
@@ -25706,7 +25878,7 @@ where 条件
|
|
|
25706
25878
|
|
|
25707
25879
|
> `static` **removeByWhere**(`db`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
25708
25880
|
|
|
25709
|
-
Defined in: [sys/mod.ts:
|
|
25881
|
+
Defined in: [sys/mod.ts:296](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L296)
|
|
25710
25882
|
|
|
25711
25883
|
根据条件移除条目
|
|
25712
25884
|
|
|
@@ -25758,7 +25930,7 @@ Defined in: [sys/mod.ts:290](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25758
25930
|
|
|
25759
25931
|
> `static` **removeByWhereSql**(`db`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
25760
25932
|
|
|
25761
|
-
Defined in: [sys/mod.ts:
|
|
25933
|
+
Defined in: [sys/mod.ts:340](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L340)
|
|
25762
25934
|
|
|
25763
25935
|
根据条件移除条目(仅获取 SQL 对象)
|
|
25764
25936
|
|
|
@@ -25810,7 +25982,7 @@ Defined in: [sys/mod.ts:334](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25810
25982
|
|
|
25811
25983
|
> `static` **select**\<`T`\>(`db`, `c`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
25812
25984
|
|
|
25813
|
-
Defined in: [sys/mod.ts:
|
|
25985
|
+
Defined in: [sys/mod.ts:526](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L526)
|
|
25814
25986
|
|
|
25815
25987
|
select 自定字段
|
|
25816
25988
|
|
|
@@ -25858,6 +26030,10 @@ select 自定字段
|
|
|
25858
26030
|
|
|
25859
26031
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25860
26032
|
|
|
26033
|
+
###### hint?
|
|
26034
|
+
|
|
26035
|
+
`string`
|
|
26036
|
+
|
|
25861
26037
|
###### index?
|
|
25862
26038
|
|
|
25863
26039
|
`string` \| `string`[]
|
|
@@ -25876,7 +26052,7 @@ select 自定字段
|
|
|
25876
26052
|
|
|
25877
26053
|
> `static` **toArrayByRecord**\<`T`\>(`obj`): `Record`\<`string`, `Record`\<`string`, `any`\>\>
|
|
25878
26054
|
|
|
25879
|
-
Defined in: [sys/mod.ts:
|
|
26055
|
+
Defined in: [sys/mod.ts:780](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L780)
|
|
25880
26056
|
|
|
25881
26057
|
将 key val 组成的数据列表转换为原生对象模式,获取的是新创建的数组
|
|
25882
26058
|
|
|
@@ -25904,7 +26080,7 @@ Defined in: [sys/mod.ts:762](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25904
26080
|
|
|
25905
26081
|
> `static` **updateByWhere**(`db`, `data`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
25906
26082
|
|
|
25907
|
-
Defined in: [sys/mod.ts:
|
|
26083
|
+
Defined in: [sys/mod.ts:373](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L373)
|
|
25908
26084
|
|
|
25909
26085
|
根据条件更新数据
|
|
25910
26086
|
|
|
@@ -25962,7 +26138,7 @@ Defined in: [sys/mod.ts:367](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25962
26138
|
|
|
25963
26139
|
> `static` **updateByWhereSql**(`db`, `data`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
25964
26140
|
|
|
25965
|
-
Defined in: [sys/mod.ts:
|
|
26141
|
+
Defined in: [sys/mod.ts:419](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L419)
|
|
25966
26142
|
|
|
25967
26143
|
根据条件更新数据(仅获取 SQL 对象)
|
|
25968
26144
|
|
|
@@ -26020,7 +26196,7 @@ Defined in: [sys/mod.ts:413](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26020
26196
|
|
|
26021
26197
|
> `static` **updateList**(`db`, `data`, `key`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
26022
26198
|
|
|
26023
|
-
Defined in: [sys/mod.ts:
|
|
26199
|
+
Defined in: [sys/mod.ts:456](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L456)
|
|
26024
26200
|
|
|
26025
26201
|
批量更新数据
|
|
26026
26202
|
|
|
@@ -26077,7 +26253,7 @@ Defined in: [sys/mod.ts:450](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26077
26253
|
|
|
26078
26254
|
> `static` **value**(`val`): `object`
|
|
26079
26255
|
|
|
26080
|
-
Defined in: [sys/mod.ts:
|
|
26256
|
+
Defined in: [sys/mod.ts:190](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L190)
|
|
26081
26257
|
|
|
26082
26258
|
创建字面量值对象,用于 where 条件中 v[0] 需要是值而非字段名的场景
|
|
26083
26259
|
|
|
@@ -26109,7 +26285,7 @@ Defined in: [sys/mod.ts:184](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26109
26285
|
|
|
26110
26286
|
> `static` **where**\<`T`\>(`db`, `s?`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
26111
26287
|
|
|
26112
|
-
Defined in: [sys/mod.ts:
|
|
26288
|
+
Defined in: [sys/mod.ts:558](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L558)
|
|
26113
26289
|
|
|
26114
26290
|
通过 where 条件获取模型
|
|
26115
26291
|
|
|
@@ -26157,6 +26333,10 @@ Defined in: [sys/mod.ts:550](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26157
26333
|
|
|
26158
26334
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
26159
26335
|
|
|
26336
|
+
###### hint?
|
|
26337
|
+
|
|
26338
|
+
`string`
|
|
26339
|
+
|
|
26160
26340
|
###### index?
|
|
26161
26341
|
|
|
26162
26342
|
`string` \| `string`[]
|
|
@@ -26374,7 +26554,7 @@ sys/mod/interfaces/IModUnionItem.md
|
|
|
26374
26554
|
|
|
26375
26555
|
# Interface: IModUnionItem
|
|
26376
26556
|
|
|
26377
|
-
Defined in: [sys/mod.ts:
|
|
26557
|
+
Defined in: [sys/mod.ts:1857](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1857)
|
|
26378
26558
|
|
|
26379
26559
|
## Properties
|
|
26380
26560
|
|
|
@@ -26382,7 +26562,7 @@ Defined in: [sys/mod.ts:1811](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26382
26562
|
|
|
26383
26563
|
> **field**: `string`
|
|
26384
26564
|
|
|
26385
|
-
Defined in: [sys/mod.ts:
|
|
26565
|
+
Defined in: [sys/mod.ts:1858](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1858)
|
|
26386
26566
|
|
|
26387
26567
|
***
|
|
26388
26568
|
|
|
@@ -26390,7 +26570,7 @@ Defined in: [sys/mod.ts:1812](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26390
26570
|
|
|
26391
26571
|
> `optional` **where?**: `any`
|
|
26392
26572
|
|
|
26393
|
-
Defined in: [sys/mod.ts:
|
|
26573
|
+
Defined in: [sys/mod.ts:1859](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1859)
|
|
26394
26574
|
|
|
26395
26575
|
sys/mod/interfaces/IRows.md
|
|
26396
26576
|
---
|
|
@@ -26403,7 +26583,7 @@ sys/mod/interfaces/IRows.md
|
|
|
26403
26583
|
|
|
26404
26584
|
# Interface: IRows\<T\>
|
|
26405
26585
|
|
|
26406
|
-
Defined in: [sys/mod.ts:
|
|
26586
|
+
Defined in: [sys/mod.ts:1851](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1851)
|
|
26407
26587
|
|
|
26408
26588
|
## Extends
|
|
26409
26589
|
|
|
@@ -26421,7 +26601,7 @@ Defined in: [sys/mod.ts:1805](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26421
26601
|
|
|
26422
26602
|
> `readonly` **length**: `number`
|
|
26423
26603
|
|
|
26424
|
-
Defined in: [sys/mod.ts:
|
|
26604
|
+
Defined in: [sys/mod.ts:1852](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1852)
|
|
26425
26605
|
|
|
26426
26606
|
## Methods
|
|
26427
26607
|
|
|
@@ -26429,7 +26609,7 @@ Defined in: [sys/mod.ts:1806](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26429
26609
|
|
|
26430
26610
|
> **item**(`index`): `T`
|
|
26431
26611
|
|
|
26432
|
-
Defined in: [sys/mod.ts:
|
|
26612
|
+
Defined in: [sys/mod.ts:1853](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1853)
|
|
26433
26613
|
|
|
26434
26614
|
#### Parameters
|
|
26435
26615
|
|
|
@@ -26447,7 +26627,7 @@ Defined in: [sys/mod.ts:1807](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26447
26627
|
|
|
26448
26628
|
> **toArray**(): `Record`\<`string`, `any`\>[]
|
|
26449
26629
|
|
|
26450
|
-
Defined in: [sys/mod.ts:
|
|
26630
|
+
Defined in: [sys/mod.ts:1854](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1854)
|
|
26451
26631
|
|
|
26452
26632
|
#### Returns
|
|
26453
26633
|
|
|
@@ -26554,12 +26734,24 @@ Defined in: [sys/route.ts:980](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
26554
26734
|
|
|
26555
26735
|
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
26556
26736
|
|
|
26737
|
+
#### maxFieldSize?
|
|
26738
|
+
|
|
26739
|
+
`number`
|
|
26740
|
+
|
|
26741
|
+
单个字段(非文件)最大字节数,默认 1 MB
|
|
26742
|
+
|
|
26557
26743
|
#### maxFileSize?
|
|
26558
26744
|
|
|
26559
26745
|
`number`
|
|
26560
26746
|
|
|
26561
26747
|
单个文件最大字节数
|
|
26562
26748
|
|
|
26749
|
+
#### timeout?
|
|
26750
|
+
|
|
26751
|
+
`number`
|
|
26752
|
+
|
|
26753
|
+
整体请求超时时间(毫秒),默认 5 分钟,设为 0 禁用超时
|
|
26754
|
+
|
|
26563
26755
|
## Returns
|
|
26564
26756
|
|
|
26565
26757
|
`Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|