@maiyunnet/kebab 9.14.0 → 9.14.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/doc/kebab-rag.md +428 -232
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/core.d.ts +17 -0
- package/lib/core.js +163 -7
- package/lib/db/pool.js +3 -2
- package/lib/sql.d.ts +26 -0
- package/lib/sql.js +34 -1
- package/lib/text.d.ts +2 -9
- package/lib/text.js +5 -6
- package/package.json +1 -1
- package/sys/ctr.d.ts +4 -0
- package/sys/mod.d.ts +32 -0
- package/sys/mod.js +37 -1
- package/sys/route.d.ts +4 -0
- package/sys/route.js +63 -0
- package/www/example/ctr/test.d.ts +2 -0
- package/www/example/ctr/test.js +36 -0
- package/www/example/stc/chunk-FG5CKGYR.js +81 -0
- 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.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/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.14.
|
|
1363
|
+
> `const` **VER**: `"9.14.2"` = `'9.14.2'`
|
|
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:1333](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1333)
|
|
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:1367](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1367)
|
|
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:1380](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1380)
|
|
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:615](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L615)
|
|
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:677](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L677)
|
|
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:1245](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1245)
|
|
3558
3558
|
|
|
3559
3559
|
获取日志内容为一个数组
|
|
3560
3560
|
|
|
@@ -3610,6 +3610,44 @@ Defined in: [lib/core.ts:1083](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
3610
3610
|
|
|
3611
3611
|
`Promise`\<`false` \| \{ `list`: `any`[] \| `string`[][]; `total`: `number`; \}\>
|
|
3612
3612
|
|
|
3613
|
+
lib/core/functions/ipLimit.md
|
|
3614
|
+
---
|
|
3615
|
+
|
|
3616
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
3617
|
+
|
|
3618
|
+
***
|
|
3619
|
+
|
|
3620
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / ipLimit
|
|
3621
|
+
|
|
3622
|
+
# Function: ipLimit()
|
|
3623
|
+
|
|
3624
|
+
> **ipLimit**(`ip`, `mask?`): `string`
|
|
3625
|
+
|
|
3626
|
+
Defined in: [lib/core.ts:443](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L443)
|
|
3627
|
+
|
|
3628
|
+
截取 IP 的限速段
|
|
3629
|
+
IPv4 原样返回;IPv6 截取前 mask 位(默认 /64),防止同一人使用大量 IPv6 地址绕过限速
|
|
3630
|
+
|
|
3631
|
+
## Parameters
|
|
3632
|
+
|
|
3633
|
+
### ip
|
|
3634
|
+
|
|
3635
|
+
`string`
|
|
3636
|
+
|
|
3637
|
+
IP 地址
|
|
3638
|
+
|
|
3639
|
+
### mask?
|
|
3640
|
+
|
|
3641
|
+
`number` = `64`
|
|
3642
|
+
|
|
3643
|
+
IPv6 前缀长度,0-128 的整数,默认 64
|
|
3644
|
+
|
|
3645
|
+
## Returns
|
|
3646
|
+
|
|
3647
|
+
`string`
|
|
3648
|
+
|
|
3649
|
+
限速段,如 192.168.1.1、2001:db8:1234:5678::
|
|
3650
|
+
|
|
3613
3651
|
lib/core/functions/ip.md
|
|
3614
3652
|
---
|
|
3615
3653
|
|
|
@@ -3654,7 +3692,7 @@ lib/core/functions/ips.md
|
|
|
3654
3692
|
|
|
3655
3693
|
> **ips**(`ctr`): `object`
|
|
3656
3694
|
|
|
3657
|
-
Defined in: [lib/core.ts:
|
|
3695
|
+
Defined in: [lib/core.ts:384](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L384)
|
|
3658
3696
|
|
|
3659
3697
|
获取 CF 和 X 的 IP
|
|
3660
3698
|
|
|
@@ -3689,7 +3727,7 @@ lib/core/functions/loadEnv.md
|
|
|
3689
3727
|
|
|
3690
3728
|
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3691
3729
|
|
|
3692
|
-
Defined in: [lib/core.ts:
|
|
3730
|
+
Defined in: [lib/core.ts:1432](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1432)
|
|
3693
3731
|
|
|
3694
3732
|
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3695
3733
|
|
|
@@ -3718,7 +3756,7 @@ lib/core/functions/log.md
|
|
|
3718
3756
|
|
|
3719
3757
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3720
3758
|
|
|
3721
|
-
Defined in: [lib/core.ts:
|
|
3759
|
+
Defined in: [lib/core.ts:1132](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1132)
|
|
3722
3760
|
|
|
3723
3761
|
写入文件日志
|
|
3724
3762
|
|
|
@@ -3759,7 +3797,7 @@ lib/core/functions/ls.md
|
|
|
3759
3797
|
|
|
3760
3798
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3761
3799
|
|
|
3762
|
-
Defined in: [lib/core.ts:
|
|
3800
|
+
Defined in: [lib/core.ts:1294](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1294)
|
|
3763
3801
|
|
|
3764
3802
|
获取目录内文件/文件夹列表
|
|
3765
3803
|
|
|
@@ -3865,7 +3903,7 @@ lib/core/functions/objectSort.md
|
|
|
3865
3903
|
|
|
3866
3904
|
> **objectSort**\<`T`\>(`o`): `T`
|
|
3867
3905
|
|
|
3868
|
-
Defined in: [lib/core.ts:
|
|
3906
|
+
Defined in: [lib/core.ts:596](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L596)
|
|
3869
3907
|
|
|
3870
3908
|
将对象进行升序排列
|
|
3871
3909
|
|
|
@@ -3900,7 +3938,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3900
3938
|
|
|
3901
3939
|
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3902
3940
|
|
|
3903
|
-
Defined in: [lib/core.ts:
|
|
3941
|
+
Defined in: [lib/core.ts:634](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L634)
|
|
3904
3942
|
|
|
3905
3943
|
调用前自行创建 passThrough,并且调用 pipe 绑定到应该绑定的对象,然后再调用本函数
|
|
3906
3944
|
|
|
@@ -4039,6 +4077,50 @@ Defined in: [lib/core.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4039
4077
|
|
|
4040
4078
|
`string`
|
|
4041
4079
|
|
|
4080
|
+
lib/core/functions/realIPLimit.md
|
|
4081
|
+
---
|
|
4082
|
+
|
|
4083
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
4084
|
+
|
|
4085
|
+
***
|
|
4086
|
+
|
|
4087
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / realIPLimit
|
|
4088
|
+
|
|
4089
|
+
# Function: realIPLimit()
|
|
4090
|
+
|
|
4091
|
+
> **realIPLimit**(`ctr`, `name?`, `mask?`): `string`
|
|
4092
|
+
|
|
4093
|
+
Defined in: [lib/core.ts:463](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L463)
|
|
4094
|
+
|
|
4095
|
+
获取安全 IP 的限速段(用于 ratelimit 库的 key)
|
|
4096
|
+
IPv4 原样返回;IPv6 截取前 mask 位(默认 /64)
|
|
4097
|
+
|
|
4098
|
+
## Parameters
|
|
4099
|
+
|
|
4100
|
+
### ctr
|
|
4101
|
+
|
|
4102
|
+
[`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
4103
|
+
|
|
4104
|
+
Ctr 实例
|
|
4105
|
+
|
|
4106
|
+
### name?
|
|
4107
|
+
|
|
4108
|
+
`string` = `''`
|
|
4109
|
+
|
|
4110
|
+
输入安全的 header
|
|
4111
|
+
|
|
4112
|
+
### mask?
|
|
4113
|
+
|
|
4114
|
+
`number` = `64`
|
|
4115
|
+
|
|
4116
|
+
IPv6 前缀长度,0-128 的整数,默认 64
|
|
4117
|
+
|
|
4118
|
+
## Returns
|
|
4119
|
+
|
|
4120
|
+
`string`
|
|
4121
|
+
|
|
4122
|
+
限速段,如 192.168.1.1、2001:db8:1234:5678::
|
|
4123
|
+
|
|
4042
4124
|
lib/core/functions/realIP.md
|
|
4043
4125
|
---
|
|
4044
4126
|
|
|
@@ -4052,7 +4134,7 @@ lib/core/functions/realIP.md
|
|
|
4052
4134
|
|
|
4053
4135
|
> **realIP**(`ctr`, `name?`): `string`
|
|
4054
4136
|
|
|
4055
|
-
Defined in: [lib/core.ts:
|
|
4137
|
+
Defined in: [lib/core.ts:424](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L424)
|
|
4056
4138
|
|
|
4057
4139
|
获取直连 IP(安全 IP)
|
|
4058
4140
|
|
|
@@ -4085,7 +4167,7 @@ lib/core/functions/removeGlobal.md
|
|
|
4085
4167
|
|
|
4086
4168
|
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4087
4169
|
|
|
4088
|
-
Defined in: [lib/core.ts:
|
|
4170
|
+
Defined in: [lib/core.ts:949](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L949)
|
|
4089
4171
|
|
|
4090
4172
|
移除某个跨线程/跨内网服务器全局变量
|
|
4091
4173
|
|
|
@@ -4120,7 +4202,7 @@ lib/core/functions/resolveEnvVars.md
|
|
|
4120
4202
|
|
|
4121
4203
|
> **resolveEnvVars**(`obj`): `void`
|
|
4122
4204
|
|
|
4123
|
-
Defined in: [lib/core.ts:
|
|
4205
|
+
Defined in: [lib/core.ts:1462](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1462)
|
|
4124
4206
|
|
|
4125
4207
|
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
4126
4208
|
|
|
@@ -4149,7 +4231,7 @@ lib/core/functions/sendNpm.md
|
|
|
4149
4231
|
|
|
4150
4232
|
> **sendNpm**(`path`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4151
4233
|
|
|
4152
|
-
Defined in: [lib/core.ts:
|
|
4234
|
+
Defined in: [lib/core.ts:848](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L848)
|
|
4153
4235
|
|
|
4154
4236
|
向本机或局域网 RPC 发送 npm install 操作
|
|
4155
4237
|
|
|
@@ -4184,7 +4266,7 @@ lib/core/functions/sendPackage.md
|
|
|
4184
4266
|
|
|
4185
4267
|
> **sendPackage**(`content`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4186
4268
|
|
|
4187
|
-
Defined in: [lib/core.ts:
|
|
4269
|
+
Defined in: [lib/core.ts:1072](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1072)
|
|
4188
4270
|
|
|
4189
4271
|
向本机或局域网 RPC 发送 package.json 更新操作
|
|
4190
4272
|
|
|
@@ -4219,7 +4301,7 @@ lib/core/functions/sendPm2.md
|
|
|
4219
4301
|
|
|
4220
4302
|
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4221
4303
|
|
|
4222
|
-
Defined in: [lib/core.ts:
|
|
4304
|
+
Defined in: [lib/core.ts:800](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L800)
|
|
4223
4305
|
|
|
4224
4306
|
向本机或局域网 RPC 发送 PM2 操作
|
|
4225
4307
|
|
|
@@ -4260,7 +4342,7 @@ lib/core/functions/sendProject.md
|
|
|
4260
4342
|
|
|
4261
4343
|
> **sendProject**(`path`, `key`, `value`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4262
4344
|
|
|
4263
|
-
Defined in: [lib/core.ts:
|
|
4345
|
+
Defined in: [lib/core.ts:1024](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1024)
|
|
4264
4346
|
|
|
4265
4347
|
向本机或局域网 RPC 发送项目配置更新操作
|
|
4266
4348
|
|
|
@@ -4307,7 +4389,7 @@ lib/core/functions/sendReload.md
|
|
|
4307
4389
|
|
|
4308
4390
|
> **sendReload**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4309
4391
|
|
|
4310
|
-
Defined in: [lib/core.ts:
|
|
4392
|
+
Defined in: [lib/core.ts:697](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L697)
|
|
4311
4393
|
|
|
4312
4394
|
向主进程(或局域网同代码机子)发送广播将进行 reload 操作,等待回传
|
|
4313
4395
|
主要作用除代码热更新以外的其他情况
|
|
@@ -4335,7 +4417,7 @@ lib/core/functions/sendRestart.md
|
|
|
4335
4417
|
|
|
4336
4418
|
> **sendRestart**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4337
4419
|
|
|
4338
|
-
Defined in: [lib/core.ts:
|
|
4420
|
+
Defined in: [lib/core.ts:746](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L746)
|
|
4339
4421
|
|
|
4340
4422
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
4341
4423
|
主要用作不间断的代码热更新
|
|
@@ -4410,7 +4492,7 @@ lib/core/functions/setGlobal.md
|
|
|
4410
4492
|
|
|
4411
4493
|
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4412
4494
|
|
|
4413
|
-
Defined in: [lib/core.ts:
|
|
4495
|
+
Defined in: [lib/core.ts:899](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L899)
|
|
4414
4496
|
|
|
4415
4497
|
设置跨线程/指定的局域网主机的全局变量
|
|
4416
4498
|
|
|
@@ -4451,7 +4533,7 @@ lib/core/functions/sleep.md
|
|
|
4451
4533
|
|
|
4452
4534
|
> **sleep**(`ms`): `Promise`\<`void`\>
|
|
4453
4535
|
|
|
4454
|
-
Defined in: [lib/core.ts:
|
|
4536
|
+
Defined in: [lib/core.ts:584](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L584)
|
|
4455
4537
|
|
|
4456
4538
|
间隔一段时间
|
|
4457
4539
|
|
|
@@ -4509,7 +4591,7 @@ lib/core/functions/updateCode.md
|
|
|
4509
4591
|
|
|
4510
4592
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4511
4593
|
|
|
4512
|
-
Defined in: [lib/core.ts:
|
|
4594
|
+
Defined in: [lib/core.ts:964](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L964)
|
|
4513
4595
|
|
|
4514
4596
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
4515
4597
|
|
|
@@ -4562,7 +4644,7 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4562
4644
|
|
|
4563
4645
|
> **writeEventStreamHead**(`res`): `void`
|
|
4564
4646
|
|
|
4565
|
-
Defined in: [lib/core.ts:
|
|
4647
|
+
Defined in: [lib/core.ts:1402](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1402)
|
|
4566
4648
|
|
|
4567
4649
|
## Parameters
|
|
4568
4650
|
|
|
@@ -4587,7 +4669,7 @@ lib/core/functions/writeHead.md
|
|
|
4587
4669
|
|
|
4588
4670
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4589
4671
|
|
|
4590
|
-
Defined in: [lib/core.ts:
|
|
4672
|
+
Defined in: [lib/core.ts:1391](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1391)
|
|
4591
4673
|
|
|
4592
4674
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4593
4675
|
|
|
@@ -4628,7 +4710,7 @@ lib/core/functions/write.md
|
|
|
4628
4710
|
|
|
4629
4711
|
> **write**(`res`, `data`): `void`
|
|
4630
4712
|
|
|
4631
|
-
Defined in: [lib/core.ts:
|
|
4713
|
+
Defined in: [lib/core.ts:1414](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1414)
|
|
4632
4714
|
|
|
4633
4715
|
向 res 发送数据
|
|
4634
4716
|
|
|
@@ -4698,6 +4780,7 @@ lib/core/index.md
|
|
|
4698
4780
|
- [exec](functions/exec.md)
|
|
4699
4781
|
- [getLog](functions/getLog.md)
|
|
4700
4782
|
- [ip](functions/ip.md)
|
|
4783
|
+
- [ipLimit](functions/ipLimit.md)
|
|
4701
4784
|
- [ips](functions/ips.md)
|
|
4702
4785
|
- [loadEnv](functions/loadEnv.md)
|
|
4703
4786
|
- [log](functions/log.md)
|
|
@@ -4709,6 +4792,7 @@ lib/core/index.md
|
|
|
4709
4792
|
- [rand](functions/rand.md)
|
|
4710
4793
|
- [random](functions/random.md)
|
|
4711
4794
|
- [realIP](functions/realIP.md)
|
|
4795
|
+
- [realIPLimit](functions/realIPLimit.md)
|
|
4712
4796
|
- [removeGlobal](functions/removeGlobal.md)
|
|
4713
4797
|
- [resolveEnvVars](functions/resolveEnvVars.md)
|
|
4714
4798
|
- [sendNpm](functions/sendNpm.md)
|
|
@@ -4800,7 +4884,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4800
4884
|
|
|
4801
4885
|
# Interface: ILogOptions
|
|
4802
4886
|
|
|
4803
|
-
Defined in: [lib/core.ts:
|
|
4887
|
+
Defined in: [lib/core.ts:1115](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1115)
|
|
4804
4888
|
|
|
4805
4889
|
log 设置的选项
|
|
4806
4890
|
|
|
@@ -4810,7 +4894,7 @@ log 设置的选项
|
|
|
4810
4894
|
|
|
4811
4895
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4812
4896
|
|
|
4813
|
-
Defined in: [lib/core.ts:
|
|
4897
|
+
Defined in: [lib/core.ts:1121](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1121)
|
|
4814
4898
|
|
|
4815
4899
|
***
|
|
4816
4900
|
|
|
@@ -4818,7 +4902,7 @@ Defined in: [lib/core.ts:959](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4818
4902
|
|
|
4819
4903
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4820
4904
|
|
|
4821
|
-
Defined in: [lib/core.ts:
|
|
4905
|
+
Defined in: [lib/core.ts:1120](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1120)
|
|
4822
4906
|
|
|
4823
4907
|
***
|
|
4824
4908
|
|
|
@@ -4826,7 +4910,7 @@ Defined in: [lib/core.ts:958](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4826
4910
|
|
|
4827
4911
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4828
4912
|
|
|
4829
|
-
Defined in: [lib/core.ts:
|
|
4913
|
+
Defined in: [lib/core.ts:1123](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1123)
|
|
4830
4914
|
|
|
4831
4915
|
***
|
|
4832
4916
|
|
|
@@ -4834,7 +4918,7 @@ Defined in: [lib/core.ts:961](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4834
4918
|
|
|
4835
4919
|
> `optional` **hostname?**: `string`
|
|
4836
4920
|
|
|
4837
|
-
Defined in: [lib/core.ts:
|
|
4921
|
+
Defined in: [lib/core.ts:1118](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1118)
|
|
4838
4922
|
|
|
4839
4923
|
***
|
|
4840
4924
|
|
|
@@ -4842,7 +4926,7 @@ Defined in: [lib/core.ts:956](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4842
4926
|
|
|
4843
4927
|
> `optional` **path?**: `string`
|
|
4844
4928
|
|
|
4845
|
-
Defined in: [lib/core.ts:
|
|
4929
|
+
Defined in: [lib/core.ts:1116](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1116)
|
|
4846
4930
|
|
|
4847
4931
|
***
|
|
4848
4932
|
|
|
@@ -4850,7 +4934,7 @@ Defined in: [lib/core.ts:954](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4850
4934
|
|
|
4851
4935
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4852
4936
|
|
|
4853
|
-
Defined in: [lib/core.ts:
|
|
4937
|
+
Defined in: [lib/core.ts:1119](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1119)
|
|
4854
4938
|
|
|
4855
4939
|
***
|
|
4856
4940
|
|
|
@@ -4858,7 +4942,7 @@ Defined in: [lib/core.ts:957](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4858
4942
|
|
|
4859
4943
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4860
4944
|
|
|
4861
|
-
Defined in: [lib/core.ts:
|
|
4945
|
+
Defined in: [lib/core.ts:1122](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1122)
|
|
4862
4946
|
|
|
4863
4947
|
***
|
|
4864
4948
|
|
|
@@ -4866,7 +4950,7 @@ Defined in: [lib/core.ts:960](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4866
4950
|
|
|
4867
4951
|
> `optional` **urlFull?**: `string`
|
|
4868
4952
|
|
|
4869
|
-
Defined in: [lib/core.ts:
|
|
4953
|
+
Defined in: [lib/core.ts:1117](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1117)
|
|
4870
4954
|
|
|
4871
4955
|
lib/core/type-aliases/TPm2Action.md
|
|
4872
4956
|
---
|
|
@@ -4881,7 +4965,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4881
4965
|
|
|
4882
4966
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4883
4967
|
|
|
4884
|
-
Defined in: [lib/core.ts:
|
|
4968
|
+
Defined in: [lib/core.ts:792](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L792)
|
|
4885
4969
|
|
|
4886
4970
|
PM2 操作类型
|
|
4887
4971
|
|
|
@@ -4955,7 +5039,7 @@ lib/core/variables/global.md
|
|
|
4955
5039
|
|
|
4956
5040
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
4957
5041
|
|
|
4958
|
-
Defined in: [lib/core.ts:
|
|
5042
|
+
Defined in: [lib/core.ts:891](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L891)
|
|
4959
5043
|
|
|
4960
5044
|
跨进程全局变量
|
|
4961
5045
|
|
|
@@ -5125,7 +5209,7 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
5125
5209
|
|
|
5126
5210
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
5127
5211
|
|
|
5128
|
-
Defined in: [lib/core.ts:
|
|
5212
|
+
Defined in: [lib/core.ts:400](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L400)
|
|
5129
5213
|
|
|
5130
5214
|
使用的是 Cloudflare
|
|
5131
5215
|
|
|
@@ -5142,7 +5226,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
5142
5226
|
|
|
5143
5227
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
5144
5228
|
|
|
5145
|
-
Defined in: [lib/core.ts:
|
|
5229
|
+
Defined in: [lib/core.ts:398](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L398)
|
|
5146
5230
|
|
|
5147
5231
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
5148
5232
|
|
|
@@ -7439,7 +7523,7 @@ lib/db/pool/classes/Pool.md
|
|
|
7439
7523
|
|
|
7440
7524
|
# Class: Pool
|
|
7441
7525
|
|
|
7442
|
-
Defined in: [lib/db/pool.ts:
|
|
7526
|
+
Defined in: [lib/db/pool.ts:116](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L116)
|
|
7443
7527
|
|
|
7444
7528
|
数据库连接池对象
|
|
7445
7529
|
|
|
@@ -7449,7 +7533,7 @@ Defined in: [lib/db/pool.ts:115](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7449
7533
|
|
|
7450
7534
|
> **new Pool**(`etc`, `opt`): `Pool`
|
|
7451
7535
|
|
|
7452
|
-
Defined in: [lib/db/pool.ts:
|
|
7536
|
+
Defined in: [lib/db/pool.ts:127](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L127)
|
|
7453
7537
|
|
|
7454
7538
|
#### Parameters
|
|
7455
7539
|
|
|
@@ -7475,7 +7559,7 @@ Defined in: [lib/db/pool.ts:126](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7475
7559
|
|
|
7476
7560
|
> **beginTransaction**(`ctr`): `Promise`\<[`Transaction`](../../tran/classes/Transaction.md) \| `null`\>
|
|
7477
7561
|
|
|
7478
|
-
Defined in: [lib/db/pool.ts:
|
|
7562
|
+
Defined in: [lib/db/pool.ts:195](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L195)
|
|
7479
7563
|
|
|
7480
7564
|
开启事务,返回事务对象并锁定连接,别人任何人不可用,有 ctr 的话必传 this,独立执行时可传 null
|
|
7481
7565
|
|
|
@@ -7495,7 +7579,7 @@ Defined in: [lib/db/pool.ts:194](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7495
7579
|
|
|
7496
7580
|
> **execute**(`sql`, `values?`): `Promise`\<[`IPacket`](../../interfaces/IPacket.md)\>
|
|
7497
7581
|
|
|
7498
|
-
Defined in: [lib/db/pool.ts:
|
|
7582
|
+
Defined in: [lib/db/pool.ts:175](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L175)
|
|
7499
7583
|
|
|
7500
7584
|
执行一条 SQL 并获得影响行数对象 packet,连接失败抛出错误
|
|
7501
7585
|
|
|
@@ -7523,7 +7607,7 @@ Defined in: [lib/db/pool.ts:174](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7523
7607
|
|
|
7524
7608
|
> **getName**(): `string`
|
|
7525
7609
|
|
|
7526
|
-
Defined in: [lib/db/pool.ts:
|
|
7610
|
+
Defined in: [lib/db/pool.ts:141](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L141)
|
|
7527
7611
|
|
|
7528
7612
|
获取当前连接的数据库名称
|
|
7529
7613
|
|
|
@@ -7537,7 +7621,7 @@ Defined in: [lib/db/pool.ts:140](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7537
7621
|
|
|
7538
7622
|
> **getQueries**(): `number`
|
|
7539
7623
|
|
|
7540
|
-
Defined in: [lib/db/pool.ts:
|
|
7624
|
+
Defined in: [lib/db/pool.ts:327](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L327)
|
|
7541
7625
|
|
|
7542
7626
|
获取 SQL 执行次数
|
|
7543
7627
|
|
|
@@ -7551,7 +7635,7 @@ Defined in: [lib/db/pool.ts:326](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7551
7635
|
|
|
7552
7636
|
> **getService**(): [`ESERVICE`](../../enumerations/ESERVICE.md)
|
|
7553
7637
|
|
|
7554
|
-
Defined in: [lib/db/pool.ts:
|
|
7638
|
+
Defined in: [lib/db/pool.ts:136](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L136)
|
|
7555
7639
|
|
|
7556
7640
|
获取当前连接的服务商
|
|
7557
7641
|
|
|
@@ -7565,7 +7649,7 @@ Defined in: [lib/db/pool.ts:135](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
7565
7649
|
|
|
7566
7650
|
> **query**(`sql`, `values?`): `Promise`\<[`IData`](../../interfaces/IData.md)\>
|
|
7567
7651
|
|
|
7568
|
-
Defined in: [lib/db/pool.ts:
|
|
7652
|
+
Defined in: [lib/db/pool.ts:151](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L151)
|
|
7569
7653
|
|
|
7570
7654
|
执行一条 SQL,无视顺序和相同连接,随用随取
|
|
7571
7655
|
|
|
@@ -13963,7 +14047,7 @@ Defined in: [lib/sql.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
13963
14047
|
|
|
13964
14048
|
> **new Sql**(`opt`): `Sql`
|
|
13965
14049
|
|
|
13966
|
-
Defined in: [lib/sql.ts:
|
|
14050
|
+
Defined in: [lib/sql.ts:72](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L72)
|
|
13967
14051
|
|
|
13968
14052
|
#### Parameters
|
|
13969
14053
|
|
|
@@ -14005,7 +14089,7 @@ Defined in: [lib/sql.ts:69](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14005
14089
|
|
|
14006
14090
|
> **append**(`sql`): `this`
|
|
14007
14091
|
|
|
14008
|
-
Defined in: [lib/sql.ts:
|
|
14092
|
+
Defined in: [lib/sql.ts:1041](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1041)
|
|
14009
14093
|
|
|
14010
14094
|
在 sql 最后追加字符串
|
|
14011
14095
|
|
|
@@ -14025,7 +14109,7 @@ Defined in: [lib/sql.ts:1006](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
14025
14109
|
|
|
14026
14110
|
> **by**(`c`, `d?`): `this`
|
|
14027
14111
|
|
|
14028
|
-
Defined in: [lib/sql.ts:
|
|
14112
|
+
Defined in: [lib/sql.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L793)
|
|
14029
14113
|
|
|
14030
14114
|
ORDER BY
|
|
14031
14115
|
|
|
@@ -14053,7 +14137,7 @@ ORDER BY
|
|
|
14053
14137
|
|
|
14054
14138
|
> **copy**(`f?`, `opt?`): `Sql`
|
|
14055
14139
|
|
|
14056
|
-
Defined in: [lib/sql.ts:
|
|
14140
|
+
Defined in: [lib/sql.ts:861](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L861)
|
|
14057
14141
|
|
|
14058
14142
|
创建一个本对象的一个新的 sql 对象拷贝
|
|
14059
14143
|
|
|
@@ -14081,7 +14165,7 @@ Defined in: [lib/sql.ts:830](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14081
14165
|
|
|
14082
14166
|
> **crossJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14083
14167
|
|
|
14084
|
-
Defined in: [lib/sql.ts:
|
|
14168
|
+
Defined in: [lib/sql.ts:522](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L522)
|
|
14085
14169
|
|
|
14086
14170
|
cross join 方法
|
|
14087
14171
|
|
|
@@ -14121,7 +14205,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14121
14205
|
|
|
14122
14206
|
> **delete**(`f`): `this`
|
|
14123
14207
|
|
|
14124
|
-
Defined in: [lib/sql.ts:
|
|
14208
|
+
Defined in: [lib/sql.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L410)
|
|
14125
14209
|
|
|
14126
14210
|
'xx'
|
|
14127
14211
|
|
|
@@ -14143,7 +14227,7 @@ Defined in: [lib/sql.ts:379](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14143
14227
|
|
|
14144
14228
|
> **field**(`str`, `pre?`, `suf?`): `string`
|
|
14145
14229
|
|
|
14146
|
-
Defined in: [lib/sql.ts:
|
|
14230
|
+
Defined in: [lib/sql.ts:1052](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1052)
|
|
14147
14231
|
|
|
14148
14232
|
对字段进行包裹
|
|
14149
14233
|
|
|
@@ -14175,7 +14259,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅请在 field 表名时
|
|
|
14175
14259
|
|
|
14176
14260
|
> **format**(`sql?`, `data?`): `string`
|
|
14177
14261
|
|
|
14178
|
-
Defined in: [lib/sql.ts:
|
|
14262
|
+
Defined in: [lib/sql.ts:1031](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1031)
|
|
14179
14263
|
|
|
14180
14264
|
获取带 data 的 sql 语句
|
|
14181
14265
|
|
|
@@ -14199,7 +14283,7 @@ Defined in: [lib/sql.ts:996](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14199
14283
|
|
|
14200
14284
|
> **fullJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14201
14285
|
|
|
14202
|
-
Defined in: [lib/sql.ts:
|
|
14286
|
+
Defined in: [lib/sql.ts:511](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L511)
|
|
14203
14287
|
|
|
14204
14288
|
full join 方法
|
|
14205
14289
|
|
|
@@ -14239,7 +14323,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14239
14323
|
|
|
14240
14324
|
> **getData**(): [`DbValue`](../../../index/type-aliases/DbValue.md)[]
|
|
14241
14325
|
|
|
14242
|
-
Defined in: [lib/sql.ts:
|
|
14326
|
+
Defined in: [lib/sql.ts:1015](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1015)
|
|
14243
14327
|
|
|
14244
14328
|
获取全部 data
|
|
14245
14329
|
|
|
@@ -14253,7 +14337,7 @@ Defined in: [lib/sql.ts:980](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14253
14337
|
|
|
14254
14338
|
> **getPre**(): `string`
|
|
14255
14339
|
|
|
14256
|
-
Defined in: [lib/sql.ts:
|
|
14340
|
+
Defined in: [lib/sql.ts:1022](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1022)
|
|
14257
14341
|
|
|
14258
14342
|
获取定义的 pre
|
|
14259
14343
|
|
|
@@ -14267,7 +14351,7 @@ Defined in: [lib/sql.ts:987](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14267
14351
|
|
|
14268
14352
|
> **getSql**(): `string`
|
|
14269
14353
|
|
|
14270
|
-
Defined in: [lib/sql.ts:
|
|
14354
|
+
Defined in: [lib/sql.ts:995](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L995)
|
|
14271
14355
|
|
|
14272
14356
|
获取 sql 语句
|
|
14273
14357
|
|
|
@@ -14281,7 +14365,7 @@ Defined in: [lib/sql.ts:964](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14281
14365
|
|
|
14282
14366
|
> **group**(`c`): `this`
|
|
14283
14367
|
|
|
14284
|
-
Defined in: [lib/sql.ts:
|
|
14368
|
+
Defined in: [lib/sql.ts:817](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L817)
|
|
14285
14369
|
|
|
14286
14370
|
GROUP BY
|
|
14287
14371
|
|
|
@@ -14303,7 +14387,7 @@ GROUP BY
|
|
|
14303
14387
|
|
|
14304
14388
|
> **having**(`s?`): `this`
|
|
14305
14389
|
|
|
14306
|
-
Defined in: [lib/sql.ts:
|
|
14390
|
+
Defined in: [lib/sql.ts:529](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L529)
|
|
14307
14391
|
|
|
14308
14392
|
having 后置筛选器,用法类似 where
|
|
14309
14393
|
|
|
@@ -14319,11 +14403,56 @@ having 后置筛选器,用法类似 where
|
|
|
14319
14403
|
|
|
14320
14404
|
***
|
|
14321
14405
|
|
|
14406
|
+
### hint()
|
|
14407
|
+
|
|
14408
|
+
> **hint**(`h`): `this`
|
|
14409
|
+
|
|
14410
|
+
Defined in: [lib/sql.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L118)
|
|
14411
|
+
|
|
14412
|
+
设置 MySQL 优化器 Hint
|
|
14413
|
+
会以 Optimizer Hint 注释语法注入到 SELECT 关键字后
|
|
14414
|
+
传入 hint 内容即可,无需包裹注释符号
|
|
14415
|
+
|
|
14416
|
+
#### Parameters
|
|
14417
|
+
|
|
14418
|
+
##### h
|
|
14419
|
+
|
|
14420
|
+
`string`
|
|
14421
|
+
|
|
14422
|
+
Hint 内容
|
|
14423
|
+
|
|
14424
|
+
#### Returns
|
|
14425
|
+
|
|
14426
|
+
`this`
|
|
14427
|
+
|
|
14428
|
+
#### Example
|
|
14429
|
+
|
|
14430
|
+
```ts
|
|
14431
|
+
// --- 强制走指定索引(最常用)
|
|
14432
|
+
INDEX(`supply_date_0_0` `idx_supply_date_query`)
|
|
14433
|
+
|
|
14434
|
+
// --- 指定某表不用某索引
|
|
14435
|
+
NO_INDEX(`supply_date_0_0` `idx_old`)
|
|
14436
|
+
|
|
14437
|
+
// --- 指定 JOIN 顺序和索引
|
|
14438
|
+
JOIN_ORDER(`a` `b`) INDEX(`a` `idx_a`) INDEX(`b` `idx_b`)
|
|
14439
|
+
|
|
14440
|
+
// --- 指定 JOIN 中某表使用的索引
|
|
14441
|
+
JOIN_INDEX(`supply_date_0_0` `idx_supply_date_query`)
|
|
14442
|
+
|
|
14443
|
+
// --- 多表多索引组合
|
|
14444
|
+
INDEX(`t1` `idx_a`) JOIN_INDEX(`t2` `idx_b`)
|
|
14445
|
+
|
|
14446
|
+
// --- 官方文档: https://dev.mysql.com/doc/refman/8.0/en/optimizer-hints.html
|
|
14447
|
+
```
|
|
14448
|
+
|
|
14449
|
+
***
|
|
14450
|
+
|
|
14322
14451
|
### innerJoin()
|
|
14323
14452
|
|
|
14324
14453
|
> **innerJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14325
14454
|
|
|
14326
|
-
Defined in: [lib/sql.ts:
|
|
14455
|
+
Defined in: [lib/sql.ts:500](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L500)
|
|
14327
14456
|
|
|
14328
14457
|
inner join 方法
|
|
14329
14458
|
|
|
@@ -14363,7 +14492,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14363
14492
|
|
|
14364
14493
|
> **insert**(`table`, `ignore?`): `this`
|
|
14365
14494
|
|
|
14366
|
-
Defined in: [lib/sql.ts:
|
|
14495
|
+
Defined in: [lib/sql.ts:130](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L130)
|
|
14367
14496
|
|
|
14368
14497
|
插入数据前导
|
|
14369
14498
|
|
|
@@ -14391,7 +14520,7 @@ Defined in: [lib/sql.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14391
14520
|
|
|
14392
14521
|
> **join**(`f`, `s?`, `type?`, `suf?`, `pre?`): `this`
|
|
14393
14522
|
|
|
14394
|
-
Defined in: [lib/sql.ts:
|
|
14523
|
+
Defined in: [lib/sql.ts:452](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L452)
|
|
14395
14524
|
|
|
14396
14525
|
join 方法
|
|
14397
14526
|
|
|
@@ -14437,7 +14566,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14437
14566
|
|
|
14438
14567
|
> **leftJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14439
14568
|
|
|
14440
|
-
Defined in: [lib/sql.ts:
|
|
14569
|
+
Defined in: [lib/sql.ts:478](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L478)
|
|
14441
14570
|
|
|
14442
14571
|
left join 方法
|
|
14443
14572
|
|
|
@@ -14477,7 +14606,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14477
14606
|
|
|
14478
14607
|
> **limit**(`a`, `b?`): `this`
|
|
14479
14608
|
|
|
14480
|
-
Defined in: [lib/sql.ts:
|
|
14609
|
+
Defined in: [lib/sql.ts:837](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L837)
|
|
14481
14610
|
|
|
14482
14611
|
LIMIT(limit、offset, limit)
|
|
14483
14612
|
|
|
@@ -14505,7 +14634,7 @@ LIMIT(limit、offset, limit)
|
|
|
14505
14634
|
|
|
14506
14635
|
> **lock**(): `this`
|
|
14507
14636
|
|
|
14508
|
-
Defined in: [lib/sql.ts:
|
|
14637
|
+
Defined in: [lib/sql.ts:852](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L852)
|
|
14509
14638
|
|
|
14510
14639
|
追加消极锁,通常不建议使用
|
|
14511
14640
|
|
|
@@ -14519,7 +14648,7 @@ Defined in: [lib/sql.ts:821](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14519
14648
|
|
|
14520
14649
|
> **rightJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
14521
14650
|
|
|
14522
|
-
Defined in: [lib/sql.ts:
|
|
14651
|
+
Defined in: [lib/sql.ts:489](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L489)
|
|
14523
14652
|
|
|
14524
14653
|
right join 方法
|
|
14525
14654
|
|
|
@@ -14559,7 +14688,7 @@ MySQL 时为表前缀,PostgreSQL 时为 Schema 名,仅在 join 非默认前
|
|
|
14559
14688
|
|
|
14560
14689
|
> **select**(`c`, `f`): `this`
|
|
14561
14690
|
|
|
14562
|
-
Defined in: [lib/sql.ts:
|
|
14691
|
+
Defined in: [lib/sql.ts:301](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L301)
|
|
14563
14692
|
|
|
14564
14693
|
'*', 'xx'
|
|
14565
14694
|
|
|
@@ -14587,7 +14716,7 @@ Defined in: [lib/sql.ts:270](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14587
14716
|
|
|
14588
14717
|
> **union**(`lsql`, `type?`): `this`
|
|
14589
14718
|
|
|
14590
|
-
Defined in: [lib/sql.ts:
|
|
14719
|
+
Defined in: [lib/sql.ts:422](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L422)
|
|
14591
14720
|
|
|
14592
14721
|
联查另一个 sql 对象
|
|
14593
14722
|
|
|
@@ -14615,7 +14744,7 @@ sql 对象
|
|
|
14615
14744
|
|
|
14616
14745
|
> **unionAll**(`lsql`): `this`
|
|
14617
14746
|
|
|
14618
|
-
Defined in: [lib/sql.ts:
|
|
14747
|
+
Defined in: [lib/sql.ts:440](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L440)
|
|
14619
14748
|
|
|
14620
14749
|
所有联查另一个 sql 对象
|
|
14621
14750
|
|
|
@@ -14637,7 +14766,7 @@ sql 对象
|
|
|
14637
14766
|
|
|
14638
14767
|
> **update**(`f`, `s`): `this`
|
|
14639
14768
|
|
|
14640
|
-
Defined in: [lib/sql.ts:
|
|
14769
|
+
Defined in: [lib/sql.ts:342](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L342)
|
|
14641
14770
|
|
|
14642
14771
|
UPDATE SQL 方法
|
|
14643
14772
|
|
|
@@ -14665,7 +14794,7 @@ UPDATE SQL 方法
|
|
|
14665
14794
|
|
|
14666
14795
|
> **updateByValues**(`table`, `key`, `cols`, `rows`): `this`
|
|
14667
14796
|
|
|
14668
|
-
Defined in: [lib/sql.ts:
|
|
14797
|
+
Defined in: [lib/sql.ts:246](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L246)
|
|
14669
14798
|
|
|
14670
14799
|
批量 UPDATE,以子查询作为数据源,纯更新语义(不会插入新行)
|
|
14671
14800
|
MySQL: UPDATE t INNER JOIN (SELECT col AS alias ... UNION ALL SELECT ...) AS tmp ON t.key=tmp.key SET t.c=tmp.c
|
|
@@ -14708,7 +14837,7 @@ PostgreSQL: UPDATE t SET c=tmp.c FROM (VALUES ($1,...)) AS tmp(cols) WHERE t.key
|
|
|
14708
14837
|
|
|
14709
14838
|
> **upsert**(`data`, `conflict?`): `this`
|
|
14710
14839
|
|
|
14711
|
-
Defined in: [lib/sql.ts:
|
|
14840
|
+
Defined in: [lib/sql.ts:207](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L207)
|
|
14712
14841
|
|
|
14713
14842
|
如果存在则更新不存在则插入(UPSERT)
|
|
14714
14843
|
|
|
@@ -14736,7 +14865,7 @@ Defined in: [lib/sql.ts:176](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14736
14865
|
|
|
14737
14866
|
> **values**(`cs`, `vs?`): `this`
|
|
14738
14867
|
|
|
14739
|
-
Defined in: [lib/sql.ts:
|
|
14868
|
+
Defined in: [lib/sql.ts:149](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L149)
|
|
14740
14869
|
|
|
14741
14870
|
实际插入数据的数据
|
|
14742
14871
|
|
|
@@ -14764,7 +14893,7 @@ Defined in: [lib/sql.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
14764
14893
|
|
|
14765
14894
|
> **where**(`s`): `this`
|
|
14766
14895
|
|
|
14767
|
-
Defined in: [lib/sql.ts:
|
|
14896
|
+
Defined in: [lib/sql.ts:563](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L563)
|
|
14768
14897
|
|
|
14769
14898
|
筛选器
|
|
14770
14899
|
1. 'city': 'bj', 'type': '2'
|
|
@@ -14907,7 +15036,7 @@ lib/sql/functions/aoMix.md
|
|
|
14907
15036
|
|
|
14908
15037
|
> **aoMix**(`arr`): `Record`\<`string`, `string` \| `number` \| [`Json`](../../../index/type-aliases/Json.md)\>
|
|
14909
15038
|
|
|
14910
|
-
Defined in: [lib/sql.ts:
|
|
15039
|
+
Defined in: [lib/sql.ts:1437](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1437)
|
|
14911
15040
|
|
|
14912
15041
|
将数组兑换为组合的对象(Array/Object mix)
|
|
14913
15042
|
|
|
@@ -14936,7 +15065,7 @@ lib/sql/functions/column.md
|
|
|
14936
15065
|
|
|
14937
15066
|
> **column**(`field`): `object`
|
|
14938
15067
|
|
|
14939
|
-
Defined in: [lib/sql.ts:
|
|
15068
|
+
Defined in: [lib/sql.ts:1458](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1458)
|
|
14940
15069
|
|
|
14941
15070
|
创建字段对象
|
|
14942
15071
|
|
|
@@ -14975,7 +15104,7 @@ lib/sql/functions/format.md
|
|
|
14975
15104
|
|
|
14976
15105
|
> **format**(`sql`, `data`, `service?`): `string`
|
|
14977
15106
|
|
|
14978
|
-
Defined in: [lib/sql.ts:
|
|
15107
|
+
Defined in: [lib/sql.ts:1399](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1399)
|
|
14979
15108
|
|
|
14980
15109
|
返回代入后的完整 SQL 字符串,这并不安全不能直接执行,只是用来调试打印 sql 语句
|
|
14981
15110
|
|
|
@@ -15016,7 +15145,7 @@ lib/sql/functions/get.md
|
|
|
15016
15145
|
|
|
15017
15146
|
> **get**(`opt`): [`Sql`](../classes/Sql.md)
|
|
15018
15147
|
|
|
15019
|
-
Defined in: [lib/sql.ts:
|
|
15148
|
+
Defined in: [lib/sql.ts:1371](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1371)
|
|
15020
15149
|
|
|
15021
15150
|
创建 sql 对象
|
|
15022
15151
|
|
|
@@ -15069,7 +15198,7 @@ lib/sql/functions/json.md
|
|
|
15069
15198
|
|
|
15070
15199
|
> **json**\<`T`\>(`obj`): `T`
|
|
15071
15200
|
|
|
15072
|
-
Defined in: [lib/sql.ts:
|
|
15201
|
+
Defined in: [lib/sql.ts:1496](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1496)
|
|
15073
15202
|
|
|
15074
15203
|
将对象转换为 JSON 字符串并避开类型检查,用于适配 PostgreSQL 的 jsonb 字段
|
|
15075
15204
|
|
|
@@ -15104,7 +15233,7 @@ lib/sql/functions/value.md
|
|
|
15104
15233
|
|
|
15105
15234
|
> **value**(`val`): `object`
|
|
15106
15235
|
|
|
15107
|
-
Defined in: [lib/sql.ts:
|
|
15236
|
+
Defined in: [lib/sql.ts:1477](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1477)
|
|
15108
15237
|
|
|
15109
15238
|
创建字面量值对象,用于 where 条件中 v[0] 需要是值而非字段名的场景
|
|
15110
15239
|
例:[value('hello'), 'IN', column('tags')]
|
|
@@ -16248,7 +16377,7 @@ lib/text/functions/csvescape.md
|
|
|
16248
16377
|
|
|
16249
16378
|
> **csvescape**(`str`): `string`
|
|
16250
16379
|
|
|
16251
|
-
Defined in: [lib/text.ts:
|
|
16380
|
+
Defined in: [lib/text.ts:511](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L511)
|
|
16252
16381
|
|
|
16253
16382
|
CSV 特殊字符转换为实体字符
|
|
16254
16383
|
|
|
@@ -16275,7 +16404,7 @@ lib/text/functions/getFileExt.md
|
|
|
16275
16404
|
|
|
16276
16405
|
> **getFileExt**(`path`): `string`
|
|
16277
16406
|
|
|
16278
|
-
Defined in: [lib/text.ts:
|
|
16407
|
+
Defined in: [lib/text.ts:552](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L552)
|
|
16279
16408
|
|
|
16280
16409
|
获取文件后缀
|
|
16281
16410
|
|
|
@@ -16304,7 +16433,7 @@ lib/text/functions/getFileNameExt.md
|
|
|
16304
16433
|
|
|
16305
16434
|
> **getFileNameExt**(`path`): `object`
|
|
16306
16435
|
|
|
16307
|
-
Defined in: [lib/text.ts:
|
|
16436
|
+
Defined in: [lib/text.ts:565](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L565)
|
|
16308
16437
|
|
|
16309
16438
|
获取文件名和后缀
|
|
16310
16439
|
|
|
@@ -16341,7 +16470,7 @@ lib/text/functions/getFilename.md
|
|
|
16341
16470
|
|
|
16342
16471
|
> **getFilename**(`path`, `ext?`): `string`
|
|
16343
16472
|
|
|
16344
|
-
Defined in: [lib/text.ts:
|
|
16473
|
+
Defined in: [lib/text.ts:532](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L532)
|
|
16345
16474
|
|
|
16346
16475
|
获取文件名
|
|
16347
16476
|
|
|
@@ -16376,7 +16505,7 @@ lib/text/functions/htmlescape.md
|
|
|
16376
16505
|
|
|
16377
16506
|
> **htmlescape**(`html`): `string`
|
|
16378
16507
|
|
|
16379
|
-
Defined in: [lib/text.ts:
|
|
16508
|
+
Defined in: [lib/text.ts:502](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L502)
|
|
16380
16509
|
|
|
16381
16510
|
HTML 特殊字符转换为实体字符
|
|
16382
16511
|
|
|
@@ -16405,7 +16534,7 @@ lib/text/functions/int2str.md
|
|
|
16405
16534
|
|
|
16406
16535
|
> **int2str**(`int`, `digits?`, `decimal?`): `string`
|
|
16407
16536
|
|
|
16408
|
-
Defined in: [lib/text.ts:
|
|
16537
|
+
Defined in: [lib/text.ts:765](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L765)
|
|
16409
16538
|
|
|
16410
16539
|
为解决精度问题,将整数转换为小数字符串
|
|
16411
16540
|
以下几个示例都是当 digits 为 3、decimal 为 2 时
|
|
@@ -16451,7 +16580,7 @@ lib/text/functions/isAscii.md
|
|
|
16451
16580
|
|
|
16452
16581
|
> **isAscii**(`text`): `boolean`
|
|
16453
16582
|
|
|
16454
|
-
Defined in: [lib/text.ts:
|
|
16583
|
+
Defined in: [lib/text.ts:270](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L270)
|
|
16455
16584
|
|
|
16456
16585
|
判断是否在 ascii 字符集内,仅可输入部分
|
|
16457
16586
|
|
|
@@ -16480,7 +16609,7 @@ lib/text/functions/isDomain.md
|
|
|
16480
16609
|
|
|
16481
16610
|
> **isDomain**(`domain`): `boolean`
|
|
16482
16611
|
|
|
16483
|
-
Defined in: [lib/text.ts:
|
|
16612
|
+
Defined in: [lib/text.ts:259](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L259)
|
|
16484
16613
|
|
|
16485
16614
|
判断是否是域名
|
|
16486
16615
|
|
|
@@ -16511,7 +16640,7 @@ lib/text/functions/isEMail.md
|
|
|
16511
16640
|
|
|
16512
16641
|
> **isEMail**(`email`): `boolean`
|
|
16513
16642
|
|
|
16514
|
-
Defined in: [lib/text.ts:
|
|
16643
|
+
Defined in: [lib/text.ts:232](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L232)
|
|
16515
16644
|
|
|
16516
16645
|
是否是邮件地址
|
|
16517
16646
|
|
|
@@ -16538,7 +16667,7 @@ lib/text/functions/isFalsy.md
|
|
|
16538
16667
|
|
|
16539
16668
|
> **isFalsy**(`val`): `val is TFalsy`
|
|
16540
16669
|
|
|
16541
|
-
Defined in: [lib/text.ts:
|
|
16670
|
+
Defined in: [lib/text.ts:716](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L716)
|
|
16542
16671
|
|
|
16543
16672
|
判断一个值是否是虚假的(为 null/undefined/空字符串/false/0)
|
|
16544
16673
|
|
|
@@ -16567,7 +16696,7 @@ lib/text/functions/isIdCardCN.md
|
|
|
16567
16696
|
|
|
16568
16697
|
> **isIdCardCN**(`idcard`): `boolean`
|
|
16569
16698
|
|
|
16570
|
-
Defined in: [lib/text.ts:
|
|
16699
|
+
Defined in: [lib/text.ts:382](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L382)
|
|
16571
16700
|
|
|
16572
16701
|
是否是中国大陆身份证号码
|
|
16573
16702
|
|
|
@@ -16596,9 +16725,9 @@ lib/text/functions/isIPv4.md
|
|
|
16596
16725
|
|
|
16597
16726
|
> **isIPv4**(`ip`): `boolean`
|
|
16598
16727
|
|
|
16599
|
-
Defined in: [lib/text.ts:
|
|
16728
|
+
Defined in: [lib/text.ts:240](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L240)
|
|
16600
16729
|
|
|
16601
|
-
是否是 IPv4
|
|
16730
|
+
是否是 IPv4(基于 Node 原生 net.isIP,严格校验)
|
|
16602
16731
|
|
|
16603
16732
|
## Parameters
|
|
16604
16733
|
|
|
@@ -16623,9 +16752,9 @@ lib/text/functions/isIPv6.md
|
|
|
16623
16752
|
|
|
16624
16753
|
> **isIPv6**(`ip`): `boolean`
|
|
16625
16754
|
|
|
16626
|
-
Defined in: [lib/text.ts:
|
|
16755
|
+
Defined in: [lib/text.ts:248](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L248)
|
|
16627
16756
|
|
|
16628
|
-
是否是 IPv6
|
|
16757
|
+
是否是 IPv6(基于 Node 原生 net.isIP,严格校验)
|
|
16629
16758
|
|
|
16630
16759
|
## Parameters
|
|
16631
16760
|
|
|
@@ -16650,7 +16779,7 @@ lib/text/functions/isPhoneCN.md
|
|
|
16650
16779
|
|
|
16651
16780
|
> **isPhoneCN**(`p`): `boolean`
|
|
16652
16781
|
|
|
16653
|
-
Defined in: [lib/text.ts:
|
|
16782
|
+
Defined in: [lib/text.ts:374](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L374)
|
|
16654
16783
|
|
|
16655
16784
|
判断手机号是否是 11 位,不做真实性校验
|
|
16656
16785
|
|
|
@@ -16679,7 +16808,7 @@ lib/text/functions/isRealPath.md
|
|
|
16679
16808
|
|
|
16680
16809
|
> **isRealPath**(`path`): `boolean`
|
|
16681
16810
|
|
|
16682
|
-
Defined in: [lib/text.ts:
|
|
16811
|
+
Defined in: [lib/text.ts:519](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L519)
|
|
16683
16812
|
|
|
16684
16813
|
判断是否是绝对路径,是返回 true,相对路径返回 false
|
|
16685
16814
|
|
|
@@ -16708,7 +16837,7 @@ lib/text/functions/isTruthy.md
|
|
|
16708
16837
|
|
|
16709
16838
|
> **isTruthy**\<`T`\>(`val`): `val is Exclude<T, TFalsy>`
|
|
16710
16839
|
|
|
16711
|
-
Defined in: [lib/text.ts:
|
|
16840
|
+
Defined in: [lib/text.ts:724](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L724)
|
|
16712
16841
|
|
|
16713
16842
|
判断一个值是否是真实的(不为 null/undefined/空字符串/false/0)
|
|
16714
16843
|
|
|
@@ -16743,7 +16872,7 @@ lib/text/functions/logicalOr.md
|
|
|
16743
16872
|
|
|
16744
16873
|
> **logicalOr**\<`T`, `T2`\>(`v1`, `v2`): `T` *extends* [`TFalsy`](../type-aliases/TFalsy.md) ? `T2` : `T`
|
|
16745
16874
|
|
|
16746
|
-
Defined in: [lib/text.ts:
|
|
16875
|
+
Defined in: [lib/text.ts:733](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L733)
|
|
16747
16876
|
|
|
16748
16877
|
类似 || 运算符的效果
|
|
16749
16878
|
|
|
@@ -16788,7 +16917,7 @@ lib/text/functions/match.md
|
|
|
16788
16917
|
|
|
16789
16918
|
> **match**(`str`, `regs`): `boolean`
|
|
16790
16919
|
|
|
16791
|
-
Defined in: [lib/text.ts:
|
|
16920
|
+
Defined in: [lib/text.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L359)
|
|
16792
16921
|
|
|
16793
16922
|
传入正则进行匹配 str 是否有一项满足
|
|
16794
16923
|
|
|
@@ -16823,7 +16952,7 @@ lib/text/functions/nlReplace.md
|
|
|
16823
16952
|
|
|
16824
16953
|
> **nlReplace**(`str`, `to?`): `string`
|
|
16825
16954
|
|
|
16826
|
-
Defined in: [lib/text.ts:
|
|
16955
|
+
Defined in: [lib/text.ts:279](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L279)
|
|
16827
16956
|
|
|
16828
16957
|
换行替换为别的
|
|
16829
16958
|
|
|
@@ -16858,7 +16987,7 @@ lib/text/functions/parseDomain.md
|
|
|
16858
16987
|
|
|
16859
16988
|
> **parseDomain**(`domain`): `Promise`\<[`IDomain`](../interfaces/IDomain.md)\>
|
|
16860
16989
|
|
|
16861
|
-
Defined in: [lib/text.ts:
|
|
16990
|
+
Defined in: [lib/text.ts:302](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L302)
|
|
16862
16991
|
|
|
16863
16992
|
解析域名并获取 tld/sld/domain/sub
|
|
16864
16993
|
|
|
@@ -16887,7 +17016,7 @@ lib/text/functions/parseHost.md
|
|
|
16887
17016
|
|
|
16888
17017
|
> **parseHost**(`host`): `object`
|
|
16889
17018
|
|
|
16890
|
-
Defined in: [lib/text.ts:
|
|
17019
|
+
Defined in: [lib/text.ts:30](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L30)
|
|
16891
17020
|
|
|
16892
17021
|
解析主机名和端口号
|
|
16893
17022
|
|
|
@@ -16928,7 +17057,7 @@ lib/text/functions/parseJson.md
|
|
|
16928
17057
|
|
|
16929
17058
|
> **parseJson**\<`T`\>(`str`): `false` \| `T`
|
|
16930
17059
|
|
|
16931
|
-
Defined in: [lib/text.ts:
|
|
17060
|
+
Defined in: [lib/text.ts:627](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L627)
|
|
16932
17061
|
|
|
16933
17062
|
将字符串解析为对象,返回 false 代表解析失败,支持 BigInt
|
|
16934
17063
|
|
|
@@ -16963,7 +17092,7 @@ lib/text/functions/parseUrl.md
|
|
|
16963
17092
|
|
|
16964
17093
|
> **parseUrl**(`url`): [`IUrlParse`](../../../index/interfaces/IUrlParse.md)
|
|
16965
17094
|
|
|
16966
|
-
Defined in: [lib/text.ts:
|
|
17095
|
+
Defined in: [lib/text.ts:56](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L56)
|
|
16967
17096
|
|
|
16968
17097
|
格式化一段 URL
|
|
16969
17098
|
|
|
@@ -16990,7 +17119,7 @@ lib/text/functions/queryParse.md
|
|
|
16990
17119
|
|
|
16991
17120
|
> **queryParse**(`query`): `Record`\<`string`, `string` \| `string`[]\>
|
|
16992
17121
|
|
|
16993
|
-
Defined in: [lib/text.ts:
|
|
17122
|
+
Defined in: [lib/text.ts:459](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L459)
|
|
16994
17123
|
|
|
16995
17124
|
将 query string 转换为对象
|
|
16996
17125
|
|
|
@@ -17021,7 +17150,7 @@ lib/text/functions/queryStringify.md
|
|
|
17021
17150
|
|
|
17022
17151
|
> **queryStringify**(`query`, `encode?`): `string`
|
|
17023
17152
|
|
|
17024
|
-
Defined in: [lib/text.ts:
|
|
17153
|
+
Defined in: [lib/text.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L410)
|
|
17025
17154
|
|
|
17026
17155
|
将对象转换为 query string
|
|
17027
17156
|
|
|
@@ -17047,7 +17176,7 @@ Defined in: [lib/text.ts:413](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17047
17176
|
|
|
17048
17177
|
> **queryStringify**(`query`, `options`): `string`
|
|
17049
17178
|
|
|
17050
|
-
Defined in: [lib/text.ts:
|
|
17179
|
+
Defined in: [lib/text.ts:416](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L416)
|
|
17051
17180
|
|
|
17052
17181
|
将对象转换为 query string
|
|
17053
17182
|
|
|
@@ -17092,7 +17221,7 @@ lib/text/functions/sizeFormat.md
|
|
|
17092
17221
|
|
|
17093
17222
|
> **sizeFormat**(`size`, `spliter?`): `string`
|
|
17094
17223
|
|
|
17095
|
-
Defined in: [lib/text.ts:
|
|
17224
|
+
Defined in: [lib/text.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L16)
|
|
17096
17225
|
|
|
17097
17226
|
将文件大小格式化为带单位的字符串
|
|
17098
17227
|
|
|
@@ -17127,7 +17256,7 @@ lib/text/functions/str2int.md
|
|
|
17127
17256
|
|
|
17128
17257
|
> **str2int**(`str`, `digits?`): `number`
|
|
17129
17258
|
|
|
17130
|
-
Defined in: [lib/text.ts:
|
|
17259
|
+
Defined in: [lib/text.ts:747](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L747)
|
|
17131
17260
|
|
|
17132
17261
|
为解决精度问题,将字符串数字转换为整数显示
|
|
17133
17262
|
以下几个示例都是当 digits 为 2 时
|
|
@@ -17167,7 +17296,7 @@ lib/text/functions/stringifyBuffer.md
|
|
|
17167
17296
|
|
|
17168
17297
|
> **stringifyBuffer**(`buf`): `string`
|
|
17169
17298
|
|
|
17170
|
-
Defined in: [lib/text.ts:
|
|
17299
|
+
Defined in: [lib/text.ts:670](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L670)
|
|
17171
17300
|
|
|
17172
17301
|
输出文本格式的 buffer
|
|
17173
17302
|
|
|
@@ -17196,7 +17325,7 @@ lib/text/functions/stringifyJson.md
|
|
|
17196
17325
|
|
|
17197
17326
|
> **stringifyJson**(`obj`, `space?`): `string`
|
|
17198
17327
|
|
|
17199
|
-
Defined in: [lib/text.ts:
|
|
17328
|
+
Defined in: [lib/text.ts:657](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L657)
|
|
17200
17329
|
|
|
17201
17330
|
将对象转换为 json 字符串,返回 false 代表解析失败,支持 BigInt
|
|
17202
17331
|
|
|
@@ -17231,7 +17360,7 @@ lib/text/functions/stringifyResult.md
|
|
|
17231
17360
|
|
|
17232
17361
|
> **stringifyResult**(`rtn`): `string`
|
|
17233
17362
|
|
|
17234
|
-
Defined in: [lib/text.ts:
|
|
17363
|
+
Defined in: [lib/text.ts:587](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L587)
|
|
17235
17364
|
|
|
17236
17365
|
将普通的返回 JSON 对象序列化为字符串
|
|
17237
17366
|
|
|
@@ -17260,7 +17389,7 @@ lib/text/functions/trimJson.md
|
|
|
17260
17389
|
|
|
17261
17390
|
> **trimJson**(`json`): `any`
|
|
17262
17391
|
|
|
17263
|
-
Defined in: [lib/text.ts:
|
|
17392
|
+
Defined in: [lib/text.ts:678](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L678)
|
|
17264
17393
|
|
|
17265
17394
|
递归删除 json 中的字符串首尾空格,会返回一个新的对象
|
|
17266
17395
|
|
|
@@ -17287,7 +17416,7 @@ lib/text/functions/urlAtom.md
|
|
|
17287
17416
|
|
|
17288
17417
|
> **urlAtom**(`url`): `string`
|
|
17289
17418
|
|
|
17290
|
-
Defined in: [lib/text.ts:
|
|
17419
|
+
Defined in: [lib/text.ts:213](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L213)
|
|
17291
17420
|
|
|
17292
17421
|
将路径中的 ../ ./ 都按规范妥善处理
|
|
17293
17422
|
|
|
@@ -17316,7 +17445,7 @@ lib/text/functions/urlResolve.md
|
|
|
17316
17445
|
|
|
17317
17446
|
> **urlResolve**(`from`, `to`, `limit?`): `string`
|
|
17318
17447
|
|
|
17319
|
-
Defined in: [lib/text.ts:
|
|
17448
|
+
Defined in: [lib/text.ts:147](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L147)
|
|
17320
17449
|
|
|
17321
17450
|
将相对路径根据基准路径进行转换
|
|
17322
17451
|
|
|
@@ -17368,8 +17497,6 @@ lib/text/index.md
|
|
|
17368
17497
|
- [REGEXP\_ASCII](variables/REGEXP_ASCII.md)
|
|
17369
17498
|
- [REGEXP\_DOMAIN](variables/REGEXP_DOMAIN.md)
|
|
17370
17499
|
- [REGEXP\_EMAIL](variables/REGEXP_EMAIL.md)
|
|
17371
|
-
- [REGEXP\_IPV4](variables/REGEXP_IPV4.md)
|
|
17372
|
-
- [REGEXP\_IPV6](variables/REGEXP_IPV6.md)
|
|
17373
17500
|
|
|
17374
17501
|
## Functions
|
|
17375
17502
|
|
|
@@ -17418,7 +17545,7 @@ lib/text/interfaces/IDomain.md
|
|
|
17418
17545
|
|
|
17419
17546
|
# Interface: IDomain
|
|
17420
17547
|
|
|
17421
|
-
Defined in: [lib/text.ts:
|
|
17548
|
+
Defined in: [lib/text.ts:291](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L291)
|
|
17422
17549
|
|
|
17423
17550
|
解析后的 domain
|
|
17424
17551
|
|
|
@@ -17428,7 +17555,7 @@ Defined in: [lib/text.ts:294](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17428
17555
|
|
|
17429
17556
|
> **domain**: `string` \| `null`
|
|
17430
17557
|
|
|
17431
|
-
Defined in: [lib/text.ts:
|
|
17558
|
+
Defined in: [lib/text.ts:294](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L294)
|
|
17432
17559
|
|
|
17433
17560
|
***
|
|
17434
17561
|
|
|
@@ -17436,7 +17563,7 @@ Defined in: [lib/text.ts:297](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17436
17563
|
|
|
17437
17564
|
> **sld**: `string` \| `null`
|
|
17438
17565
|
|
|
17439
|
-
Defined in: [lib/text.ts:
|
|
17566
|
+
Defined in: [lib/text.ts:293](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L293)
|
|
17440
17567
|
|
|
17441
17568
|
***
|
|
17442
17569
|
|
|
@@ -17444,7 +17571,7 @@ Defined in: [lib/text.ts:296](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17444
17571
|
|
|
17445
17572
|
> **sub**: `string` \| `null`
|
|
17446
17573
|
|
|
17447
|
-
Defined in: [lib/text.ts:
|
|
17574
|
+
Defined in: [lib/text.ts:295](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L295)
|
|
17448
17575
|
|
|
17449
17576
|
***
|
|
17450
17577
|
|
|
@@ -17452,7 +17579,7 @@ Defined in: [lib/text.ts:298](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
17452
17579
|
|
|
17453
17580
|
> **tld**: `string` \| `null`
|
|
17454
17581
|
|
|
17455
|
-
Defined in: [lib/text.ts:
|
|
17582
|
+
Defined in: [lib/text.ts:292](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L292)
|
|
17456
17583
|
|
|
17457
17584
|
lib/text/type-aliases/TFalsy.md
|
|
17458
17585
|
---
|
|
@@ -17467,7 +17594,7 @@ lib/text/type-aliases/TFalsy.md
|
|
|
17467
17594
|
|
|
17468
17595
|
> **TFalsy** = `false` \| `""` \| `0` \| `null` \| `undefined` \| *typeof* `NaN`
|
|
17469
17596
|
|
|
17470
|
-
Defined in: [lib/text.ts:
|
|
17597
|
+
Defined in: [lib/text.ts:710](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L710)
|
|
17471
17598
|
|
|
17472
17599
|
虚假值类型
|
|
17473
17600
|
|
|
@@ -17484,7 +17611,7 @@ lib/text/variables/REGEXP_ASCII.md
|
|
|
17484
17611
|
|
|
17485
17612
|
> `const` **REGEXP\_ASCII**: `RegExp`
|
|
17486
17613
|
|
|
17487
|
-
Defined in: [lib/text.ts:
|
|
17614
|
+
Defined in: [lib/text.ts:264](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L264)
|
|
17488
17615
|
|
|
17489
17616
|
可打印的 ascii 字符集
|
|
17490
17617
|
|
|
@@ -17501,7 +17628,7 @@ lib/text/variables/REGEXP_DOMAIN.md
|
|
|
17501
17628
|
|
|
17502
17629
|
> `const` **REGEXP\_DOMAIN**: `RegExp`
|
|
17503
17630
|
|
|
17504
|
-
Defined in: [lib/text.ts:
|
|
17631
|
+
Defined in: [lib/text.ts:252](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L252)
|
|
17505
17632
|
|
|
17506
17633
|
lib/text/variables/REGEXP_EMAIL.md
|
|
17507
17634
|
---
|
|
@@ -17516,37 +17643,7 @@ lib/text/variables/REGEXP_EMAIL.md
|
|
|
17516
17643
|
|
|
17517
17644
|
> `const` **REGEXP\_EMAIL**: `RegExp`
|
|
17518
17645
|
|
|
17519
|
-
Defined in: [lib/text.ts:
|
|
17520
|
-
|
|
17521
|
-
lib/text/variables/REGEXP_IPV4.md
|
|
17522
|
-
---
|
|
17523
|
-
|
|
17524
|
-
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17525
|
-
|
|
17526
|
-
***
|
|
17527
|
-
|
|
17528
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_IPV4
|
|
17529
|
-
|
|
17530
|
-
# Variable: REGEXP\_IPV4
|
|
17531
|
-
|
|
17532
|
-
> `const` **REGEXP\_IPV4**: `RegExp`
|
|
17533
|
-
|
|
17534
|
-
Defined in: [lib/text.ts:235](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L235)
|
|
17535
|
-
|
|
17536
|
-
lib/text/variables/REGEXP_IPV6.md
|
|
17537
|
-
---
|
|
17538
|
-
|
|
17539
|
-
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
17540
|
-
|
|
17541
|
-
***
|
|
17542
|
-
|
|
17543
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/text](../index.md) / REGEXP\_IPV6
|
|
17544
|
-
|
|
17545
|
-
# Variable: REGEXP\_IPV6
|
|
17546
|
-
|
|
17547
|
-
> `const` **REGEXP\_IPV6**: `RegExp`
|
|
17548
|
-
|
|
17549
|
-
Defined in: [lib/text.ts:245](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L245)
|
|
17646
|
+
Defined in: [lib/text.ts:226](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L226)
|
|
17550
17647
|
|
|
17551
17648
|
lib/time/classes/Time.md
|
|
17552
17649
|
---
|
|
@@ -23136,12 +23233,24 @@ Defined in: [sys/ctr.ts:1102](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23136
23233
|
|
|
23137
23234
|
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
23138
23235
|
|
|
23236
|
+
###### maxFieldSize?
|
|
23237
|
+
|
|
23238
|
+
`number`
|
|
23239
|
+
|
|
23240
|
+
单个字段(非文件)最大字节数,默认 1 MB
|
|
23241
|
+
|
|
23139
23242
|
###### maxFileSize?
|
|
23140
23243
|
|
|
23141
23244
|
`number`
|
|
23142
23245
|
|
|
23143
23246
|
单个文件最大字节数
|
|
23144
23247
|
|
|
23248
|
+
###### timeout?
|
|
23249
|
+
|
|
23250
|
+
`number`
|
|
23251
|
+
|
|
23252
|
+
整体请求超时时间(毫秒),默认 5 分钟,设为 0 禁用超时
|
|
23253
|
+
|
|
23145
23254
|
#### Returns
|
|
23146
23255
|
|
|
23147
23256
|
`Promise`\<`boolean`\>
|
|
@@ -23984,6 +24093,12 @@ Defined in: [sys/mod.ts:116](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
23984
24093
|
|
|
23985
24094
|
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
23986
24095
|
|
|
24096
|
+
###### hint?
|
|
24097
|
+
|
|
24098
|
+
`string`
|
|
24099
|
+
|
|
24100
|
+
MySQL 优化器 Hint,如 `INDEX(\`t\` \`idx_xx\`)`,注入到 SELECT 后
|
|
24101
|
+
|
|
23987
24102
|
###### index?
|
|
23988
24103
|
|
|
23989
24104
|
`string` \| `string`[]
|
|
@@ -24158,7 +24273,7 @@ Defined in: [sys/mod.ts:68](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
24158
24273
|
|
|
24159
24274
|
> `protected` **\_keyGenerator**(): `string`
|
|
24160
24275
|
|
|
24161
|
-
Defined in: [sys/mod.ts:
|
|
24276
|
+
Defined in: [sys/mod.ts:1843](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1843)
|
|
24162
24277
|
|
|
24163
24278
|
当 _key 不为空时,则依据继承此方法的方法自动生成填充 key
|
|
24164
24279
|
|
|
@@ -24182,7 +24297,7 @@ Defined in: [sys/mod.ts:1797](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24182
24297
|
|
|
24183
24298
|
> **all**(): `Promise`\<`false` \| [`Rows`](Rows.md)\<`Mod`\>\>
|
|
24184
24299
|
|
|
24185
|
-
Defined in: [sys/mod.ts:
|
|
24300
|
+
Defined in: [sys/mod.ts:1157](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1157)
|
|
24186
24301
|
|
|
24187
24302
|
##### Returns
|
|
24188
24303
|
|
|
@@ -24192,7 +24307,7 @@ Defined in: [sys/mod.ts:1139](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24192
24307
|
|
|
24193
24308
|
> **all**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Mod`\>\>
|
|
24194
24309
|
|
|
24195
|
-
Defined in: [sys/mod.ts:
|
|
24310
|
+
Defined in: [sys/mod.ts:1158](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1158)
|
|
24196
24311
|
|
|
24197
24312
|
##### Parameters
|
|
24198
24313
|
|
|
@@ -24220,7 +24335,7 @@ Defined in: [sys/mod.ts:1140](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24220
24335
|
|
|
24221
24336
|
> **allArray**(): `Promise`\<`false` \| `Record`\<`string`, `any`\>[]\>
|
|
24222
24337
|
|
|
24223
|
-
Defined in: [sys/mod.ts:
|
|
24338
|
+
Defined in: [sys/mod.ts:1336](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1336)
|
|
24224
24339
|
|
|
24225
24340
|
##### Returns
|
|
24226
24341
|
|
|
@@ -24230,7 +24345,7 @@ Defined in: [sys/mod.ts:1318](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24230
24345
|
|
|
24231
24346
|
> **allArray**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Record`\<`string`, `any`\>\>\>
|
|
24232
24347
|
|
|
24233
|
-
Defined in: [sys/mod.ts:
|
|
24348
|
+
Defined in: [sys/mod.ts:1337](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1337)
|
|
24234
24349
|
|
|
24235
24350
|
##### Parameters
|
|
24236
24351
|
|
|
@@ -24248,7 +24363,7 @@ Defined in: [sys/mod.ts:1319](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24248
24363
|
|
|
24249
24364
|
> **append**(`sql`): `this`
|
|
24250
24365
|
|
|
24251
|
-
Defined in: [sys/mod.ts:
|
|
24366
|
+
Defined in: [sys/mod.ts:1752](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1752)
|
|
24252
24367
|
|
|
24253
24368
|
在 sql 最后追加字符串
|
|
24254
24369
|
|
|
@@ -24268,7 +24383,7 @@ Defined in: [sys/mod.ts:1706](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24268
24383
|
|
|
24269
24384
|
> **by**(`c`, `d?`): `this`
|
|
24270
24385
|
|
|
24271
|
-
Defined in: [sys/mod.ts:
|
|
24386
|
+
Defined in: [sys/mod.ts:1708](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1708)
|
|
24272
24387
|
|
|
24273
24388
|
ORDER BY
|
|
24274
24389
|
|
|
@@ -24296,7 +24411,7 @@ ORDER BY
|
|
|
24296
24411
|
|
|
24297
24412
|
> **contain**(`contain`): `this`
|
|
24298
24413
|
|
|
24299
|
-
Defined in: [sys/mod.ts:
|
|
24414
|
+
Defined in: [sys/mod.ts:1761](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1761)
|
|
24300
24415
|
|
|
24301
24416
|
设置闭包含数据
|
|
24302
24417
|
|
|
@@ -24324,7 +24439,7 @@ Defined in: [sys/mod.ts:1715](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24324
24439
|
|
|
24325
24440
|
> **count**(): `Promise`\<`number`\>
|
|
24326
24441
|
|
|
24327
|
-
Defined in: [sys/mod.ts:
|
|
24442
|
+
Defined in: [sys/mod.ts:1544](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1544)
|
|
24328
24443
|
|
|
24329
24444
|
根据当前条件,筛选出当前条目该有的数据条数
|
|
24330
24445
|
|
|
@@ -24338,7 +24453,7 @@ Defined in: [sys/mod.ts:1526](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24338
24453
|
|
|
24339
24454
|
> **countSql**(): `string`
|
|
24340
24455
|
|
|
24341
|
-
Defined in: [sys/mod.ts:
|
|
24456
|
+
Defined in: [sys/mod.ts:1565](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1565)
|
|
24342
24457
|
|
|
24343
24458
|
获取当前条件下的 count 的 SQL 语句
|
|
24344
24459
|
|
|
@@ -24352,7 +24467,7 @@ Defined in: [sys/mod.ts:1547](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24352
24467
|
|
|
24353
24468
|
> **create**(): `Promise`\<`boolean` \| `null`\>
|
|
24354
24469
|
|
|
24355
|
-
Defined in: [sys/mod.ts:
|
|
24470
|
+
Defined in: [sys/mod.ts:839](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L839)
|
|
24356
24471
|
|
|
24357
24472
|
创建数据
|
|
24358
24473
|
|
|
@@ -24368,7 +24483,7 @@ true-成功,false-报错,null-唯一键非 _$key 键冲突
|
|
|
24368
24483
|
|
|
24369
24484
|
> **crossJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24370
24485
|
|
|
24371
|
-
Defined in: [sys/mod.ts:
|
|
24486
|
+
Defined in: [sys/mod.ts:1640](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1640)
|
|
24372
24487
|
|
|
24373
24488
|
cross join 方法
|
|
24374
24489
|
|
|
@@ -24418,7 +24533,7 @@ ON 信息
|
|
|
24418
24533
|
|
|
24419
24534
|
> **explain**(`all?`): `Promise`\<`string` \| `false`\>
|
|
24420
24535
|
|
|
24421
|
-
Defined in: [sys/mod.ts:
|
|
24536
|
+
Defined in: [sys/mod.ts:1462](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1462)
|
|
24422
24537
|
|
|
24423
24538
|
##### Parameters
|
|
24424
24539
|
|
|
@@ -24434,7 +24549,7 @@ Defined in: [sys/mod.ts:1444](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24434
24549
|
|
|
24435
24550
|
> **explain**(`all`): `Promise`\<`false` \| `Record`\<`string`, `any`\>\>
|
|
24436
24551
|
|
|
24437
|
-
Defined in: [sys/mod.ts:
|
|
24552
|
+
Defined in: [sys/mod.ts:1463](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1463)
|
|
24438
24553
|
|
|
24439
24554
|
##### Parameters
|
|
24440
24555
|
|
|
@@ -24452,7 +24567,7 @@ Defined in: [sys/mod.ts:1445](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24452
24567
|
|
|
24453
24568
|
> **filter**(`s`): `this`
|
|
24454
24569
|
|
|
24455
|
-
Defined in: [sys/mod.ts:
|
|
24570
|
+
Defined in: [sys/mod.ts:1686](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1686)
|
|
24456
24571
|
|
|
24457
24572
|
筛选器
|
|
24458
24573
|
|
|
@@ -24490,7 +24605,7 @@ Defined in: [sys/mod.ts:1640](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24490
24605
|
|
|
24491
24606
|
> **first**(`lock`, `array`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24492
24607
|
|
|
24493
|
-
Defined in: [sys/mod.ts:
|
|
24608
|
+
Defined in: [sys/mod.ts:1046](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1046)
|
|
24494
24609
|
|
|
24495
24610
|
##### Parameters
|
|
24496
24611
|
|
|
@@ -24510,7 +24625,7 @@ Defined in: [sys/mod.ts:1028](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24510
24625
|
|
|
24511
24626
|
> **first**(`lock?`, `array?`): `Promise`\<`false` \| `Mod` & `Record`\<`string`, `any`\> \| `null`\>
|
|
24512
24627
|
|
|
24513
|
-
Defined in: [sys/mod.ts:
|
|
24628
|
+
Defined in: [sys/mod.ts:1050](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1050)
|
|
24514
24629
|
|
|
24515
24630
|
##### Parameters
|
|
24516
24631
|
|
|
@@ -24532,7 +24647,7 @@ Defined in: [sys/mod.ts:1032](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24532
24647
|
|
|
24533
24648
|
> **firstArray**(`lock?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24534
24649
|
|
|
24535
|
-
Defined in: [sys/mod.ts:
|
|
24650
|
+
Defined in: [sys/mod.ts:1090](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1090)
|
|
24536
24651
|
|
|
24537
24652
|
获取数据库第一个原生对象
|
|
24538
24653
|
|
|
@@ -24554,7 +24669,7 @@ Defined in: [sys/mod.ts:1072](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24554
24669
|
|
|
24555
24670
|
> **format**(`sql?`, `data?`): `string`
|
|
24556
24671
|
|
|
24557
|
-
Defined in: [sys/mod.ts:
|
|
24672
|
+
Defined in: [sys/mod.ts:1788](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1788)
|
|
24558
24673
|
|
|
24559
24674
|
获取带 data 的 sql 语句
|
|
24560
24675
|
|
|
@@ -24582,7 +24697,7 @@ sql 语句
|
|
|
24582
24697
|
|
|
24583
24698
|
> **fullJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24584
24699
|
|
|
24585
|
-
Defined in: [sys/mod.ts:
|
|
24700
|
+
Defined in: [sys/mod.ts:1628](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1628)
|
|
24586
24701
|
|
|
24587
24702
|
full join 方法
|
|
24588
24703
|
|
|
@@ -24622,7 +24737,7 @@ ON 信息
|
|
|
24622
24737
|
|
|
24623
24738
|
> **get**(`n`): `any`
|
|
24624
24739
|
|
|
24625
|
-
Defined in: [sys/mod.ts:
|
|
24740
|
+
Defined in: [sys/mod.ts:831](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L831)
|
|
24626
24741
|
|
|
24627
24742
|
获取一个字段值
|
|
24628
24743
|
|
|
@@ -24644,7 +24759,7 @@ Defined in: [sys/mod.ts:813](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24644
24759
|
|
|
24645
24760
|
> **getData**(): `any`[]
|
|
24646
24761
|
|
|
24647
|
-
Defined in: [sys/mod.ts:
|
|
24762
|
+
Defined in: [sys/mod.ts:1779](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1779)
|
|
24648
24763
|
|
|
24649
24764
|
获取全部 data
|
|
24650
24765
|
|
|
@@ -24658,7 +24773,7 @@ Defined in: [sys/mod.ts:1733](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24658
24773
|
|
|
24659
24774
|
> **getSql**(): `string`
|
|
24660
24775
|
|
|
24661
|
-
Defined in: [sys/mod.ts:
|
|
24776
|
+
Defined in: [sys/mod.ts:1772](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1772)
|
|
24662
24777
|
|
|
24663
24778
|
获取 sql 语句
|
|
24664
24779
|
|
|
@@ -24672,7 +24787,7 @@ Defined in: [sys/mod.ts:1726](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24672
24787
|
|
|
24673
24788
|
> **group**(`c`): `this`
|
|
24674
24789
|
|
|
24675
|
-
Defined in: [sys/mod.ts:
|
|
24790
|
+
Defined in: [sys/mod.ts:1717](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1717)
|
|
24676
24791
|
|
|
24677
24792
|
GROUP BY
|
|
24678
24793
|
|
|
@@ -24694,7 +24809,7 @@ GROUP BY
|
|
|
24694
24809
|
|
|
24695
24810
|
> **having**(`s`): `this`
|
|
24696
24811
|
|
|
24697
|
-
Defined in: [sys/mod.ts:
|
|
24812
|
+
Defined in: [sys/mod.ts:1677](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1677)
|
|
24698
24813
|
|
|
24699
24814
|
筛选器
|
|
24700
24815
|
|
|
@@ -24712,11 +24827,56 @@ Defined in: [sys/mod.ts:1631](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24712
24827
|
|
|
24713
24828
|
***
|
|
24714
24829
|
|
|
24830
|
+
### hint()
|
|
24831
|
+
|
|
24832
|
+
> **hint**(`h`): `this`
|
|
24833
|
+
|
|
24834
|
+
Defined in: [sys/mod.ts:1668](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1668)
|
|
24835
|
+
|
|
24836
|
+
设置 MySQL 优化器 Hint
|
|
24837
|
+
内容会以 Optimizer Hint 注释语法注入到 SELECT 关键字后
|
|
24838
|
+
必须在查询入口调用之后、执行方法之前链式调用
|
|
24839
|
+
|
|
24840
|
+
#### Parameters
|
|
24841
|
+
|
|
24842
|
+
##### h
|
|
24843
|
+
|
|
24844
|
+
`string`
|
|
24845
|
+
|
|
24846
|
+
Hint 内容
|
|
24847
|
+
|
|
24848
|
+
#### Returns
|
|
24849
|
+
|
|
24850
|
+
`this`
|
|
24851
|
+
|
|
24852
|
+
#### Example
|
|
24853
|
+
|
|
24854
|
+
```ts
|
|
24855
|
+
// 强制走指定索引(最常用)
|
|
24856
|
+
.hint("INDEX(`supply_date_0_0` `idx_supply_date_query`)")
|
|
24857
|
+
|
|
24858
|
+
// 指定某表不用某索引
|
|
24859
|
+
.hint("NO_INDEX(`supply_date_0_0` `idx_old`)")
|
|
24860
|
+
|
|
24861
|
+
// 指定 JOIN 顺序和索引
|
|
24862
|
+
.hint("JOIN_ORDER(`a` `b`) INDEX(`a` `idx_a`) INDEX(`b` `idx_b`)")
|
|
24863
|
+
|
|
24864
|
+
// 指定 JOIN 中某表使用的索引
|
|
24865
|
+
.hint("JOIN_INDEX(`supply_date_0_0` `idx_supply_date_query`)")
|
|
24866
|
+
|
|
24867
|
+
// 多表多索引组合
|
|
24868
|
+
.hint("INDEX(`t1` `idx_a`) JOIN_INDEX(`t2` `idx_b`)")
|
|
24869
|
+
|
|
24870
|
+
// 官方文档: https://dev.mysql.com/doc/refman/8.0/en/optimizer-hints.html
|
|
24871
|
+
```
|
|
24872
|
+
|
|
24873
|
+
***
|
|
24874
|
+
|
|
24715
24875
|
### innerJoin()
|
|
24716
24876
|
|
|
24717
24877
|
> **innerJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24718
24878
|
|
|
24719
|
-
Defined in: [sys/mod.ts:
|
|
24879
|
+
Defined in: [sys/mod.ts:1616](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1616)
|
|
24720
24880
|
|
|
24721
24881
|
inner join 方法
|
|
24722
24882
|
|
|
@@ -24756,7 +24916,7 @@ ON 信息
|
|
|
24756
24916
|
|
|
24757
24917
|
> **join**(`f`, `s?`, `type?`, `index?`, `pre?`): `this`
|
|
24758
24918
|
|
|
24759
|
-
Defined in: [sys/mod.ts:
|
|
24919
|
+
Defined in: [sys/mod.ts:1580](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1580)
|
|
24760
24920
|
|
|
24761
24921
|
#### Parameters
|
|
24762
24922
|
|
|
@@ -24800,7 +24960,7 @@ ON 信息
|
|
|
24800
24960
|
|
|
24801
24961
|
> **langText**(`col`, `lang`): `string`
|
|
24802
24962
|
|
|
24803
|
-
Defined in: [sys/mod.ts:
|
|
24963
|
+
Defined in: [sys/mod.ts:1823](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1823)
|
|
24804
24964
|
|
|
24805
24965
|
获取字段的可用语种文本
|
|
24806
24966
|
|
|
@@ -24828,7 +24988,7 @@ Defined in: [sys/mod.ts:1777](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24828
24988
|
|
|
24829
24989
|
> **leftJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24830
24990
|
|
|
24831
|
-
Defined in: [sys/mod.ts:
|
|
24991
|
+
Defined in: [sys/mod.ts:1592](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1592)
|
|
24832
24992
|
|
|
24833
24993
|
left join 方法
|
|
24834
24994
|
|
|
@@ -24868,7 +25028,7 @@ ON 信息
|
|
|
24868
25028
|
|
|
24869
25029
|
> **limit**(`a`, `b?`): `this`
|
|
24870
25030
|
|
|
24871
|
-
Defined in: [sys/mod.ts:
|
|
25031
|
+
Defined in: [sys/mod.ts:1730](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1730)
|
|
24872
25032
|
|
|
24873
25033
|
LIMIT
|
|
24874
25034
|
|
|
@@ -24896,7 +25056,7 @@ LIMIT
|
|
|
24896
25056
|
|
|
24897
25057
|
> **page**(`count`, `page?`): `this`
|
|
24898
25058
|
|
|
24899
|
-
Defined in: [sys/mod.ts:
|
|
25059
|
+
Defined in: [sys/mod.ts:1741](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1741)
|
|
24900
25060
|
|
|
24901
25061
|
分页
|
|
24902
25062
|
|
|
@@ -24924,7 +25084,7 @@ Defined in: [sys/mod.ts:1695](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24924
25084
|
|
|
24925
25085
|
> **refresh**(`lock?`): `Promise`\<`boolean` \| `null`\>
|
|
24926
25086
|
|
|
24927
|
-
Defined in: [sys/mod.ts:
|
|
25087
|
+
Defined in: [sys/mod.ts:959](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L959)
|
|
24928
25088
|
|
|
24929
25089
|
刷新当前模型获取最新数据
|
|
24930
25090
|
|
|
@@ -24946,7 +25106,7 @@ Defined in: [sys/mod.ts:941](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24946
25106
|
|
|
24947
25107
|
> **remove**(): `Promise`\<`boolean`\>
|
|
24948
25108
|
|
|
24949
|
-
Defined in: [sys/mod.ts:
|
|
25109
|
+
Defined in: [sys/mod.ts:1024](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1024)
|
|
24950
25110
|
|
|
24951
25111
|
移除本条目
|
|
24952
25112
|
|
|
@@ -24960,7 +25120,7 @@ Defined in: [sys/mod.ts:1006](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24960
25120
|
|
|
24961
25121
|
> **rightJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24962
25122
|
|
|
24963
|
-
Defined in: [sys/mod.ts:
|
|
25123
|
+
Defined in: [sys/mod.ts:1604](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1604)
|
|
24964
25124
|
|
|
24965
25125
|
right join 方法
|
|
24966
25126
|
|
|
@@ -25000,7 +25160,7 @@ ON 信息
|
|
|
25000
25160
|
|
|
25001
25161
|
> **save**(`where?`): `Promise`\<`boolean`\>
|
|
25002
25162
|
|
|
25003
|
-
Defined in: [sys/mod.ts:
|
|
25163
|
+
Defined in: [sys/mod.ts:991](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L991)
|
|
25004
25164
|
|
|
25005
25165
|
更新 set 的数据到数据库,有未保存数据时才保存
|
|
25006
25166
|
|
|
@@ -25038,7 +25198,7 @@ Defined in: [sys/mod.ts:973](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25038
25198
|
|
|
25039
25199
|
> **set**\<`T`, `TK`\>(`n`): `void`
|
|
25040
25200
|
|
|
25041
|
-
Defined in: [sys/mod.ts:
|
|
25201
|
+
Defined in: [sys/mod.ts:792](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L792)
|
|
25042
25202
|
|
|
25043
25203
|
##### Type Parameters
|
|
25044
25204
|
|
|
@@ -25064,7 +25224,7 @@ Defined in: [sys/mod.ts:774](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25064
25224
|
|
|
25065
25225
|
> **set**\<`T`, `TK`\>(`n`, `v`): `void`
|
|
25066
25226
|
|
|
25067
|
-
Defined in: [sys/mod.ts:
|
|
25227
|
+
Defined in: [sys/mod.ts:793](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L793)
|
|
25068
25228
|
|
|
25069
25229
|
##### Type Parameters
|
|
25070
25230
|
|
|
@@ -25096,7 +25256,7 @@ Defined in: [sys/mod.ts:775](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25096
25256
|
|
|
25097
25257
|
> **toArray**\<`TC`\>(): [`TOnlyProperties`](../type-aliases/TOnlyProperties.md)\<`InstanceType`\<`TC`\>\> & `Record`\<`string`, `any`\>
|
|
25098
25258
|
|
|
25099
|
-
Defined in: [sys/mod.ts:
|
|
25259
|
+
Defined in: [sys/mod.ts:1795](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1795)
|
|
25100
25260
|
|
|
25101
25261
|
获取值对象,获取的是新创建的数组
|
|
25102
25262
|
|
|
@@ -25116,7 +25276,7 @@ Defined in: [sys/mod.ts:1749](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25116
25276
|
|
|
25117
25277
|
> **total**(`f?`): `Promise`\<`number`\>
|
|
25118
25278
|
|
|
25119
|
-
Defined in: [sys/mod.ts:
|
|
25279
|
+
Defined in: [sys/mod.ts:1520](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1520)
|
|
25120
25280
|
|
|
25121
25281
|
获取总条数,自动抛弃 LIMIT,仅用于获取数据的情况(select)
|
|
25122
25282
|
|
|
@@ -25136,7 +25296,7 @@ Defined in: [sys/mod.ts:1502](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25136
25296
|
|
|
25137
25297
|
> **union**(`f`, `type?`): `this`
|
|
25138
25298
|
|
|
25139
|
-
Defined in: [sys/mod.ts:
|
|
25299
|
+
Defined in: [sys/mod.ts:1101](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1101)
|
|
25140
25300
|
|
|
25141
25301
|
联合查询表数据
|
|
25142
25302
|
|
|
@@ -25164,7 +25324,7 @@ Defined in: [sys/mod.ts:1083](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25164
25324
|
|
|
25165
25325
|
> **unionAll**(`f`): `this`
|
|
25166
25326
|
|
|
25167
|
-
Defined in: [sys/mod.ts:
|
|
25327
|
+
Defined in: [sys/mod.ts:1131](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1131)
|
|
25168
25328
|
|
|
25169
25329
|
所有联合查询表数据
|
|
25170
25330
|
|
|
@@ -25186,7 +25346,7 @@ Defined in: [sys/mod.ts:1113](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25186
25346
|
|
|
25187
25347
|
> **unsaved**(): `boolean`
|
|
25188
25348
|
|
|
25189
|
-
Defined in: [sys/mod.ts:
|
|
25349
|
+
Defined in: [sys/mod.ts:1814](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1814)
|
|
25190
25350
|
|
|
25191
25351
|
当前是否设置了未保存 --=
|
|
25192
25352
|
|
|
@@ -25200,7 +25360,7 @@ Defined in: [sys/mod.ts:1768](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25200
25360
|
|
|
25201
25361
|
> **updates**(): `Record`\<`string`, `any`\>
|
|
25202
25362
|
|
|
25203
|
-
Defined in: [sys/mod.ts:
|
|
25363
|
+
Defined in: [sys/mod.ts:1803](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1803)
|
|
25204
25364
|
|
|
25205
25365
|
获取当前设置要提交的数据
|
|
25206
25366
|
|
|
@@ -25214,7 +25374,7 @@ Defined in: [sys/mod.ts:1757](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25214
25374
|
|
|
25215
25375
|
> **upsert**(`conflict`): `Promise`\<`boolean`\>
|
|
25216
25376
|
|
|
25217
|
-
Defined in: [sys/mod.ts:
|
|
25377
|
+
Defined in: [sys/mod.ts:929](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L929)
|
|
25218
25378
|
|
|
25219
25379
|
插入数据,如果存在则更新(UPSERT)
|
|
25220
25380
|
|
|
@@ -25236,7 +25396,7 @@ Defined in: [sys/mod.ts:911](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25236
25396
|
|
|
25237
25397
|
> **where**(`s`): `this`
|
|
25238
25398
|
|
|
25239
|
-
Defined in: [sys/mod.ts:
|
|
25399
|
+
Defined in: [sys/mod.ts:1697](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1697)
|
|
25240
25400
|
|
|
25241
25401
|
是 filter 的别名
|
|
25242
25402
|
|
|
@@ -25258,7 +25418,7 @@ Defined in: [sys/mod.ts:1651](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25258
25418
|
|
|
25259
25419
|
> `static` **column**(`field`): `object`
|
|
25260
25420
|
|
|
25261
|
-
Defined in: [sys/mod.ts:
|
|
25421
|
+
Defined in: [sys/mod.ts:181](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L181)
|
|
25262
25422
|
|
|
25263
25423
|
创建字段对象
|
|
25264
25424
|
|
|
@@ -25290,7 +25450,7 @@ Defined in: [sys/mod.ts:175](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25290
25450
|
|
|
25291
25451
|
> `static` **find**\<`T`\>(`db`, `val`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25292
25452
|
|
|
25293
|
-
Defined in: [sys/mod.ts:
|
|
25453
|
+
Defined in: [sys/mod.ts:607](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L607)
|
|
25294
25454
|
|
|
25295
25455
|
根据主键(或 key 字段)获取对象
|
|
25296
25456
|
|
|
@@ -25322,6 +25482,10 @@ Defined in: [sys/mod.ts:597](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25322
25482
|
|
|
25323
25483
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25324
25484
|
|
|
25485
|
+
###### hint?
|
|
25486
|
+
|
|
25487
|
+
`string`
|
|
25488
|
+
|
|
25325
25489
|
###### index?
|
|
25326
25490
|
|
|
25327
25491
|
`string` \| `string`[]
|
|
@@ -25350,7 +25514,7 @@ Defined in: [sys/mod.ts:597](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25350
25514
|
|
|
25351
25515
|
> `static` **getCreate**\<`T`\>(`db`, `opt?`): `T`
|
|
25352
25516
|
|
|
25353
|
-
Defined in: [sys/mod.ts:
|
|
25517
|
+
Defined in: [sys/mod.ts:589](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L589)
|
|
25354
25518
|
|
|
25355
25519
|
获取创建对象,通常用于新建数据库条目
|
|
25356
25520
|
|
|
@@ -25394,7 +25558,7 @@ Defined in: [sys/mod.ts:579](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25394
25558
|
|
|
25395
25559
|
> `static` **insert**(`db`, `cs`, `vs?`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
25396
25560
|
|
|
25397
|
-
Defined in: [sys/mod.ts:
|
|
25561
|
+
Defined in: [sys/mod.ts:210](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L210)
|
|
25398
25562
|
|
|
25399
25563
|
添加一个序列(允许超过 65536 的占位符会被拆分多次执行)
|
|
25400
25564
|
|
|
@@ -25448,7 +25612,7 @@ Defined in: [sys/mod.ts:204](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25448
25612
|
|
|
25449
25613
|
> `static` **insertSql**(`db`, `cs`, `vs?`, `opt?`): `string`
|
|
25450
25614
|
|
|
25451
|
-
Defined in: [sys/mod.ts:
|
|
25615
|
+
Defined in: [sys/mod.ts:270](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L270)
|
|
25452
25616
|
|
|
25453
25617
|
获取添加一个序列的模拟 SQL
|
|
25454
25618
|
|
|
@@ -25502,7 +25666,7 @@ Defined in: [sys/mod.ts:264](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25502
25666
|
|
|
25503
25667
|
> `static` **json**\<`T`\>(`obj`): `T`
|
|
25504
25668
|
|
|
25505
|
-
Defined in: [sys/mod.ts:
|
|
25669
|
+
Defined in: [sys/mod.ts:199](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L199)
|
|
25506
25670
|
|
|
25507
25671
|
创建 JSON 字符串对象,用于 PGSQL 的 jsonb 字段
|
|
25508
25672
|
|
|
@@ -25550,7 +25714,7 @@ Defined in: [sys/mod.ts:193](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25550
25714
|
|
|
25551
25715
|
> `static` **one**(`db`, `s`, `opt`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25552
25716
|
|
|
25553
|
-
Defined in: [sys/mod.ts:
|
|
25717
|
+
Defined in: [sys/mod.ts:636](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L636)
|
|
25554
25718
|
|
|
25555
25719
|
##### Parameters
|
|
25556
25720
|
|
|
@@ -25576,6 +25740,10 @@ Defined in: [sys/mod.ts:624](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25576
25740
|
|
|
25577
25741
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25578
25742
|
|
|
25743
|
+
###### hint?
|
|
25744
|
+
|
|
25745
|
+
`string`
|
|
25746
|
+
|
|
25579
25747
|
###### index?
|
|
25580
25748
|
|
|
25581
25749
|
`string` \| `string`[]
|
|
@@ -25600,7 +25768,7 @@ Defined in: [sys/mod.ts:624](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25600
25768
|
|
|
25601
25769
|
> `static` **one**\<`T`\>(`db`, `s`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25602
25770
|
|
|
25603
|
-
Defined in: [sys/mod.ts:
|
|
25771
|
+
Defined in: [sys/mod.ts:650](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L650)
|
|
25604
25772
|
|
|
25605
25773
|
##### Type Parameters
|
|
25606
25774
|
|
|
@@ -25632,6 +25800,10 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25632
25800
|
|
|
25633
25801
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25634
25802
|
|
|
25803
|
+
###### hint?
|
|
25804
|
+
|
|
25805
|
+
`string`
|
|
25806
|
+
|
|
25635
25807
|
###### index?
|
|
25636
25808
|
|
|
25637
25809
|
`string` \| `string`[]
|
|
@@ -25658,7 +25830,7 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25658
25830
|
|
|
25659
25831
|
> `static` **oneArray**(`db`, `s`, `opt?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25660
25832
|
|
|
25661
|
-
Defined in: [sys/mod.ts:
|
|
25833
|
+
Defined in: [sys/mod.ts:731](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L731)
|
|
25662
25834
|
|
|
25663
25835
|
通过 where 条件筛选单条数据返回原生对象
|
|
25664
25836
|
|
|
@@ -25684,6 +25856,10 @@ Defined in: [sys/mod.ts:714](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25684
25856
|
|
|
25685
25857
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25686
25858
|
|
|
25859
|
+
###### hint?
|
|
25860
|
+
|
|
25861
|
+
`string`
|
|
25862
|
+
|
|
25687
25863
|
###### index?
|
|
25688
25864
|
|
|
25689
25865
|
`string` \| `string`[]
|
|
@@ -25710,7 +25886,7 @@ Defined in: [sys/mod.ts:714](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25710
25886
|
|
|
25711
25887
|
> `static` **primarys**(`db`, `where?`, `opt?`): `Promise`\<`false` \| `any`[]\>
|
|
25712
25888
|
|
|
25713
|
-
Defined in: [sys/mod.ts:
|
|
25889
|
+
Defined in: [sys/mod.ts:753](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L753)
|
|
25714
25890
|
|
|
25715
25891
|
根据 where 条件获取主键值列表
|
|
25716
25892
|
|
|
@@ -25754,7 +25930,7 @@ where 条件
|
|
|
25754
25930
|
|
|
25755
25931
|
> `static` **removeByWhere**(`db`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
25756
25932
|
|
|
25757
|
-
Defined in: [sys/mod.ts:
|
|
25933
|
+
Defined in: [sys/mod.ts:296](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L296)
|
|
25758
25934
|
|
|
25759
25935
|
根据条件移除条目
|
|
25760
25936
|
|
|
@@ -25806,7 +25982,7 @@ Defined in: [sys/mod.ts:290](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25806
25982
|
|
|
25807
25983
|
> `static` **removeByWhereSql**(`db`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
25808
25984
|
|
|
25809
|
-
Defined in: [sys/mod.ts:
|
|
25985
|
+
Defined in: [sys/mod.ts:340](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L340)
|
|
25810
25986
|
|
|
25811
25987
|
根据条件移除条目(仅获取 SQL 对象)
|
|
25812
25988
|
|
|
@@ -25858,7 +26034,7 @@ Defined in: [sys/mod.ts:334](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25858
26034
|
|
|
25859
26035
|
> `static` **select**\<`T`\>(`db`, `c`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
25860
26036
|
|
|
25861
|
-
Defined in: [sys/mod.ts:
|
|
26037
|
+
Defined in: [sys/mod.ts:526](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L526)
|
|
25862
26038
|
|
|
25863
26039
|
select 自定字段
|
|
25864
26040
|
|
|
@@ -25906,6 +26082,10 @@ select 自定字段
|
|
|
25906
26082
|
|
|
25907
26083
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
25908
26084
|
|
|
26085
|
+
###### hint?
|
|
26086
|
+
|
|
26087
|
+
`string`
|
|
26088
|
+
|
|
25909
26089
|
###### index?
|
|
25910
26090
|
|
|
25911
26091
|
`string` \| `string`[]
|
|
@@ -25924,7 +26104,7 @@ select 自定字段
|
|
|
25924
26104
|
|
|
25925
26105
|
> `static` **toArrayByRecord**\<`T`\>(`obj`): `Record`\<`string`, `Record`\<`string`, `any`\>\>
|
|
25926
26106
|
|
|
25927
|
-
Defined in: [sys/mod.ts:
|
|
26107
|
+
Defined in: [sys/mod.ts:780](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L780)
|
|
25928
26108
|
|
|
25929
26109
|
将 key val 组成的数据列表转换为原生对象模式,获取的是新创建的数组
|
|
25930
26110
|
|
|
@@ -25952,7 +26132,7 @@ Defined in: [sys/mod.ts:762](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25952
26132
|
|
|
25953
26133
|
> `static` **updateByWhere**(`db`, `data`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
25954
26134
|
|
|
25955
|
-
Defined in: [sys/mod.ts:
|
|
26135
|
+
Defined in: [sys/mod.ts:373](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L373)
|
|
25956
26136
|
|
|
25957
26137
|
根据条件更新数据
|
|
25958
26138
|
|
|
@@ -26010,7 +26190,7 @@ Defined in: [sys/mod.ts:367](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26010
26190
|
|
|
26011
26191
|
> `static` **updateByWhereSql**(`db`, `data`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
26012
26192
|
|
|
26013
|
-
Defined in: [sys/mod.ts:
|
|
26193
|
+
Defined in: [sys/mod.ts:419](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L419)
|
|
26014
26194
|
|
|
26015
26195
|
根据条件更新数据(仅获取 SQL 对象)
|
|
26016
26196
|
|
|
@@ -26068,7 +26248,7 @@ Defined in: [sys/mod.ts:413](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26068
26248
|
|
|
26069
26249
|
> `static` **updateList**(`db`, `data`, `key`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
26070
26250
|
|
|
26071
|
-
Defined in: [sys/mod.ts:
|
|
26251
|
+
Defined in: [sys/mod.ts:456](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L456)
|
|
26072
26252
|
|
|
26073
26253
|
批量更新数据
|
|
26074
26254
|
|
|
@@ -26125,7 +26305,7 @@ Defined in: [sys/mod.ts:450](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26125
26305
|
|
|
26126
26306
|
> `static` **value**(`val`): `object`
|
|
26127
26307
|
|
|
26128
|
-
Defined in: [sys/mod.ts:
|
|
26308
|
+
Defined in: [sys/mod.ts:190](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L190)
|
|
26129
26309
|
|
|
26130
26310
|
创建字面量值对象,用于 where 条件中 v[0] 需要是值而非字段名的场景
|
|
26131
26311
|
|
|
@@ -26157,7 +26337,7 @@ Defined in: [sys/mod.ts:184](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26157
26337
|
|
|
26158
26338
|
> `static` **where**\<`T`\>(`db`, `s?`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
26159
26339
|
|
|
26160
|
-
Defined in: [sys/mod.ts:
|
|
26340
|
+
Defined in: [sys/mod.ts:558](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L558)
|
|
26161
26341
|
|
|
26162
26342
|
通过 where 条件获取模型
|
|
26163
26343
|
|
|
@@ -26205,6 +26385,10 @@ Defined in: [sys/mod.ts:550](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
26205
26385
|
|
|
26206
26386
|
[`Ctr`](../../ctr/classes/Ctr.md)
|
|
26207
26387
|
|
|
26388
|
+
###### hint?
|
|
26389
|
+
|
|
26390
|
+
`string`
|
|
26391
|
+
|
|
26208
26392
|
###### index?
|
|
26209
26393
|
|
|
26210
26394
|
`string` \| `string`[]
|
|
@@ -26422,7 +26606,7 @@ sys/mod/interfaces/IModUnionItem.md
|
|
|
26422
26606
|
|
|
26423
26607
|
# Interface: IModUnionItem
|
|
26424
26608
|
|
|
26425
|
-
Defined in: [sys/mod.ts:
|
|
26609
|
+
Defined in: [sys/mod.ts:1857](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1857)
|
|
26426
26610
|
|
|
26427
26611
|
## Properties
|
|
26428
26612
|
|
|
@@ -26430,7 +26614,7 @@ Defined in: [sys/mod.ts:1811](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26430
26614
|
|
|
26431
26615
|
> **field**: `string`
|
|
26432
26616
|
|
|
26433
|
-
Defined in: [sys/mod.ts:
|
|
26617
|
+
Defined in: [sys/mod.ts:1858](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1858)
|
|
26434
26618
|
|
|
26435
26619
|
***
|
|
26436
26620
|
|
|
@@ -26438,7 +26622,7 @@ Defined in: [sys/mod.ts:1812](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26438
26622
|
|
|
26439
26623
|
> `optional` **where?**: `any`
|
|
26440
26624
|
|
|
26441
|
-
Defined in: [sys/mod.ts:
|
|
26625
|
+
Defined in: [sys/mod.ts:1859](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1859)
|
|
26442
26626
|
|
|
26443
26627
|
sys/mod/interfaces/IRows.md
|
|
26444
26628
|
---
|
|
@@ -26451,7 +26635,7 @@ sys/mod/interfaces/IRows.md
|
|
|
26451
26635
|
|
|
26452
26636
|
# Interface: IRows\<T\>
|
|
26453
26637
|
|
|
26454
|
-
Defined in: [sys/mod.ts:
|
|
26638
|
+
Defined in: [sys/mod.ts:1851](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1851)
|
|
26455
26639
|
|
|
26456
26640
|
## Extends
|
|
26457
26641
|
|
|
@@ -26469,7 +26653,7 @@ Defined in: [sys/mod.ts:1805](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26469
26653
|
|
|
26470
26654
|
> `readonly` **length**: `number`
|
|
26471
26655
|
|
|
26472
|
-
Defined in: [sys/mod.ts:
|
|
26656
|
+
Defined in: [sys/mod.ts:1852](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1852)
|
|
26473
26657
|
|
|
26474
26658
|
## Methods
|
|
26475
26659
|
|
|
@@ -26477,7 +26661,7 @@ Defined in: [sys/mod.ts:1806](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26477
26661
|
|
|
26478
26662
|
> **item**(`index`): `T`
|
|
26479
26663
|
|
|
26480
|
-
Defined in: [sys/mod.ts:
|
|
26664
|
+
Defined in: [sys/mod.ts:1853](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1853)
|
|
26481
26665
|
|
|
26482
26666
|
#### Parameters
|
|
26483
26667
|
|
|
@@ -26495,7 +26679,7 @@ Defined in: [sys/mod.ts:1807](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26495
26679
|
|
|
26496
26680
|
> **toArray**(): `Record`\<`string`, `any`\>[]
|
|
26497
26681
|
|
|
26498
|
-
Defined in: [sys/mod.ts:
|
|
26682
|
+
Defined in: [sys/mod.ts:1854](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1854)
|
|
26499
26683
|
|
|
26500
26684
|
#### Returns
|
|
26501
26685
|
|
|
@@ -26602,12 +26786,24 @@ Defined in: [sys/route.ts:980](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
26602
26786
|
|
|
26603
26787
|
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
26604
26788
|
|
|
26789
|
+
#### maxFieldSize?
|
|
26790
|
+
|
|
26791
|
+
`number`
|
|
26792
|
+
|
|
26793
|
+
单个字段(非文件)最大字节数,默认 1 MB
|
|
26794
|
+
|
|
26605
26795
|
#### maxFileSize?
|
|
26606
26796
|
|
|
26607
26797
|
`number`
|
|
26608
26798
|
|
|
26609
26799
|
单个文件最大字节数
|
|
26610
26800
|
|
|
26801
|
+
#### timeout?
|
|
26802
|
+
|
|
26803
|
+
`number`
|
|
26804
|
+
|
|
26805
|
+
整体请求超时时间(毫秒),默认 5 分钟,设为 0 禁用超时
|
|
26806
|
+
|
|
26611
26807
|
## Returns
|
|
26612
26808
|
|
|
26613
26809
|
`Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|