@maiyunnet/kebab 9.5.0 → 9.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/doc/kebab-rag.md +115 -113
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/core.d.ts +33 -9
- package/lib/core.js +38 -19
- package/package.json +1 -1
- package/sys/master.js +1 -1
- package/sys/mod.d.ts +4 -2
- package/sys/mod.js +4 -2
- package/www/example/ctr/test.js +10 -7
package/doc/kebab-rag.md
CHANGED
|
@@ -1360,7 +1360,7 @@ index/variables/VER.md
|
|
|
1360
1360
|
|
|
1361
1361
|
# Variable: VER
|
|
1362
1362
|
|
|
1363
|
-
> `const` **VER**: `"9.
|
|
1363
|
+
> `const` **VER**: `"9.6.0"` = `'9.6.0'`
|
|
1364
1364
|
|
|
1365
1365
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1366
1366
|
|
|
@@ -3258,7 +3258,7 @@ lib/core/functions/clone.md
|
|
|
3258
3258
|
|
|
3259
3259
|
> **clone**\<`T`\>(`obj`): `T`
|
|
3260
3260
|
|
|
3261
|
-
Defined in: [lib/core.ts:
|
|
3261
|
+
Defined in: [lib/core.ts:1167](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1167)
|
|
3262
3262
|
|
|
3263
3263
|
完整的克隆一份数组/对象
|
|
3264
3264
|
|
|
@@ -3322,7 +3322,7 @@ lib/core/functions/debug.md
|
|
|
3322
3322
|
|
|
3323
3323
|
> **debug**(`message?`, ...`optionalParams`): `void`
|
|
3324
3324
|
|
|
3325
|
-
Defined in: [lib/core.ts:
|
|
3325
|
+
Defined in: [lib/core.ts:1201](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1201)
|
|
3326
3326
|
|
|
3327
3327
|
打印调试信息,线上环境不会打印
|
|
3328
3328
|
|
|
@@ -3357,7 +3357,7 @@ lib/core/functions/display.md
|
|
|
3357
3357
|
|
|
3358
3358
|
> **display**(`message?`, ...`optionalParams`): `void`
|
|
3359
3359
|
|
|
3360
|
-
Defined in: [lib/core.ts:
|
|
3360
|
+
Defined in: [lib/core.ts:1214](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1214)
|
|
3361
3361
|
|
|
3362
3362
|
向控制台直接显示内容,一般情况下禁止使用
|
|
3363
3363
|
|
|
@@ -3462,7 +3462,7 @@ lib/core/functions/getLog.md
|
|
|
3462
3462
|
|
|
3463
3463
|
> **getLog**(`opt`): `Promise`\<`false` \| `any`[] \| `string`[][] \| `null`\>
|
|
3464
3464
|
|
|
3465
|
-
Defined in: [lib/core.ts:
|
|
3465
|
+
Defined in: [lib/core.ts:1074](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1074)
|
|
3466
3466
|
|
|
3467
3467
|
获取日志内容为一个数组
|
|
3468
3468
|
|
|
@@ -3603,7 +3603,7 @@ lib/core/functions/loadEnv.md
|
|
|
3603
3603
|
|
|
3604
3604
|
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3605
3605
|
|
|
3606
|
-
Defined in: [lib/core.ts:
|
|
3606
|
+
Defined in: [lib/core.ts:1266](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1266)
|
|
3607
3607
|
|
|
3608
3608
|
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3609
3609
|
|
|
@@ -3632,7 +3632,7 @@ lib/core/functions/log.md
|
|
|
3632
3632
|
|
|
3633
3633
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3634
3634
|
|
|
3635
|
-
Defined in: [lib/core.ts:
|
|
3635
|
+
Defined in: [lib/core.ts:963](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L963)
|
|
3636
3636
|
|
|
3637
3637
|
写入文件日志
|
|
3638
3638
|
|
|
@@ -3673,7 +3673,7 @@ lib/core/functions/ls.md
|
|
|
3673
3673
|
|
|
3674
3674
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3675
3675
|
|
|
3676
|
-
Defined in: [lib/core.ts:
|
|
3676
|
+
Defined in: [lib/core.ts:1128](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1128)
|
|
3677
3677
|
|
|
3678
3678
|
获取目录内文件/文件夹列表
|
|
3679
3679
|
|
|
@@ -3997,9 +3997,9 @@ lib/core/functions/removeGlobal.md
|
|
|
3997
3997
|
|
|
3998
3998
|
# Function: removeGlobal()
|
|
3999
3999
|
|
|
4000
|
-
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`string`
|
|
4000
|
+
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4001
4001
|
|
|
4002
|
-
Defined in: [lib/core.ts:
|
|
4002
|
+
Defined in: [lib/core.ts:782](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L782)
|
|
4003
4003
|
|
|
4004
4004
|
移除某个跨线程/跨内网服务器全局变量
|
|
4005
4005
|
|
|
@@ -4013,13 +4013,13 @@ Defined in: [lib/core.ts:750](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4013
4013
|
|
|
4014
4014
|
### hosts?
|
|
4015
4015
|
|
|
4016
|
-
`string`[]
|
|
4016
|
+
`string`[] \| `"config"`
|
|
4017
4017
|
|
|
4018
4018
|
局域网列表
|
|
4019
4019
|
|
|
4020
4020
|
## Returns
|
|
4021
4021
|
|
|
4022
|
-
`Promise`\<`string`
|
|
4022
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4023
4023
|
|
|
4024
4024
|
lib/core/functions/resolveEnvVars.md
|
|
4025
4025
|
---
|
|
@@ -4034,7 +4034,7 @@ lib/core/functions/resolveEnvVars.md
|
|
|
4034
4034
|
|
|
4035
4035
|
> **resolveEnvVars**(`obj`): `void`
|
|
4036
4036
|
|
|
4037
|
-
Defined in: [lib/core.ts:
|
|
4037
|
+
Defined in: [lib/core.ts:1296](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1296)
|
|
4038
4038
|
|
|
4039
4039
|
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
4040
4040
|
|
|
@@ -4061,9 +4061,9 @@ lib/core/functions/sendNpm.md
|
|
|
4061
4061
|
|
|
4062
4062
|
# Function: sendNpm()
|
|
4063
4063
|
|
|
4064
|
-
> **sendNpm**(`path`, `hosts?`): `Promise`\<`string`
|
|
4064
|
+
> **sendNpm**(`path`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4065
4065
|
|
|
4066
|
-
Defined in: [lib/core.ts:
|
|
4066
|
+
Defined in: [lib/core.ts:683](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L683)
|
|
4067
4067
|
|
|
4068
4068
|
向本机或局域网 RPC 发送 npm install 操作
|
|
4069
4069
|
|
|
@@ -4079,11 +4079,11 @@ Defined in: [lib/core.ts:663](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4079
4079
|
|
|
4080
4080
|
`string`[] \| `"config"`
|
|
4081
4081
|
|
|
4082
|
-
|
|
4082
|
+
局域网列表,不填则代表本机
|
|
4083
4083
|
|
|
4084
4084
|
## Returns
|
|
4085
4085
|
|
|
4086
|
-
`Promise`\<`string`
|
|
4086
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4087
4087
|
|
|
4088
4088
|
lib/core/functions/sendPackage.md
|
|
4089
4089
|
---
|
|
@@ -4096,9 +4096,9 @@ lib/core/functions/sendPackage.md
|
|
|
4096
4096
|
|
|
4097
4097
|
# Function: sendPackage()
|
|
4098
4098
|
|
|
4099
|
-
> **sendPackage**(`content`, `hosts?`): `Promise`\<`string`
|
|
4099
|
+
> **sendPackage**(`content`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4100
4100
|
|
|
4101
|
-
Defined in: [lib/core.ts:
|
|
4101
|
+
Defined in: [lib/core.ts:904](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L904)
|
|
4102
4102
|
|
|
4103
4103
|
向本机或局域网 RPC 发送 package.json 更新操作
|
|
4104
4104
|
|
|
@@ -4118,7 +4118,7 @@ package.json 文件内容
|
|
|
4118
4118
|
|
|
4119
4119
|
## Returns
|
|
4120
4120
|
|
|
4121
|
-
`Promise`\<`string`
|
|
4121
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4122
4122
|
|
|
4123
4123
|
lib/core/functions/sendPm2.md
|
|
4124
4124
|
---
|
|
@@ -4131,9 +4131,9 @@ lib/core/functions/sendPm2.md
|
|
|
4131
4131
|
|
|
4132
4132
|
# Function: sendPm2()
|
|
4133
4133
|
|
|
4134
|
-
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`string`
|
|
4134
|
+
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4135
4135
|
|
|
4136
|
-
Defined in: [lib/core.ts:
|
|
4136
|
+
Defined in: [lib/core.ts:636](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L636)
|
|
4137
4137
|
|
|
4138
4138
|
向本机或局域网 RPC 发送 PM2 操作
|
|
4139
4139
|
|
|
@@ -4159,7 +4159,7 @@ PM2 操作类型
|
|
|
4159
4159
|
|
|
4160
4160
|
## Returns
|
|
4161
4161
|
|
|
4162
|
-
`Promise`\<`string`
|
|
4162
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4163
4163
|
|
|
4164
4164
|
lib/core/functions/sendProject.md
|
|
4165
4165
|
---
|
|
@@ -4172,9 +4172,9 @@ lib/core/functions/sendProject.md
|
|
|
4172
4172
|
|
|
4173
4173
|
# Function: sendProject()
|
|
4174
4174
|
|
|
4175
|
-
> **sendProject**(`path`, `key`, `value`, `hosts?`): `Promise`\<`string`
|
|
4175
|
+
> **sendProject**(`path`, `key`, `value`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4176
4176
|
|
|
4177
|
-
Defined in: [lib/core.ts:
|
|
4177
|
+
Defined in: [lib/core.ts:857](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L857)
|
|
4178
4178
|
|
|
4179
4179
|
向本机或局域网 RPC 发送项目配置更新操作
|
|
4180
4180
|
|
|
@@ -4206,7 +4206,7 @@ Defined in: [lib/core.ts:822](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4206
4206
|
|
|
4207
4207
|
## Returns
|
|
4208
4208
|
|
|
4209
|
-
`Promise`\<`string`
|
|
4209
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4210
4210
|
|
|
4211
4211
|
lib/core/functions/sendReload.md
|
|
4212
4212
|
---
|
|
@@ -4219,7 +4219,7 @@ lib/core/functions/sendReload.md
|
|
|
4219
4219
|
|
|
4220
4220
|
# Function: sendReload()
|
|
4221
4221
|
|
|
4222
|
-
> **sendReload**(`hosts?`): `Promise`\<`string`
|
|
4222
|
+
> **sendReload**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4223
4223
|
|
|
4224
4224
|
Defined in: [lib/core.ts:535](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L535)
|
|
4225
4225
|
|
|
@@ -4234,7 +4234,7 @@ Defined in: [lib/core.ts:535](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4234
4234
|
|
|
4235
4235
|
## Returns
|
|
4236
4236
|
|
|
4237
|
-
`Promise`\<`string`
|
|
4237
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4238
4238
|
|
|
4239
4239
|
lib/core/functions/sendRestart.md
|
|
4240
4240
|
---
|
|
@@ -4247,9 +4247,9 @@ lib/core/functions/sendRestart.md
|
|
|
4247
4247
|
|
|
4248
4248
|
# Function: sendRestart()
|
|
4249
4249
|
|
|
4250
|
-
> **sendRestart**(`hosts?`): `Promise`\<`string`
|
|
4250
|
+
> **sendRestart**(`hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4251
4251
|
|
|
4252
|
-
Defined in: [lib/core.ts:
|
|
4252
|
+
Defined in: [lib/core.ts:583](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L583)
|
|
4253
4253
|
|
|
4254
4254
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
4255
4255
|
主要用作不间断的代码热更新
|
|
@@ -4262,7 +4262,7 @@ Defined in: [lib/core.ts:575](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4262
4262
|
|
|
4263
4263
|
## Returns
|
|
4264
4264
|
|
|
4265
|
-
`Promise`\<`string`
|
|
4265
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4266
4266
|
|
|
4267
4267
|
lib/core/functions/setCookie.md
|
|
4268
4268
|
---
|
|
@@ -4322,9 +4322,9 @@ lib/core/functions/setGlobal.md
|
|
|
4322
4322
|
|
|
4323
4323
|
# Function: setGlobal()
|
|
4324
4324
|
|
|
4325
|
-
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`string`
|
|
4325
|
+
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4326
4326
|
|
|
4327
|
-
Defined in: [lib/core.ts:
|
|
4327
|
+
Defined in: [lib/core.ts:733](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L733)
|
|
4328
4328
|
|
|
4329
4329
|
设置跨线程/指定的局域网主机的全局变量
|
|
4330
4330
|
|
|
@@ -4350,7 +4350,7 @@ Defined in: [lib/core.ts:709](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4350
4350
|
|
|
4351
4351
|
## Returns
|
|
4352
4352
|
|
|
4353
|
-
`Promise`\<`string`
|
|
4353
|
+
`Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4354
4354
|
|
|
4355
4355
|
lib/core/functions/sleep.md
|
|
4356
4356
|
---
|
|
@@ -4423,7 +4423,7 @@ lib/core/functions/updateCode.md
|
|
|
4423
4423
|
|
|
4424
4424
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
4425
4425
|
|
|
4426
|
-
Defined in: [lib/core.ts:
|
|
4426
|
+
Defined in: [lib/core.ts:797](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L797)
|
|
4427
4427
|
|
|
4428
4428
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
4429
4429
|
|
|
@@ -4476,7 +4476,7 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4476
4476
|
|
|
4477
4477
|
> **writeEventStreamHead**(`res`): `void`
|
|
4478
4478
|
|
|
4479
|
-
Defined in: [lib/core.ts:
|
|
4479
|
+
Defined in: [lib/core.ts:1236](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1236)
|
|
4480
4480
|
|
|
4481
4481
|
## Parameters
|
|
4482
4482
|
|
|
@@ -4501,7 +4501,7 @@ lib/core/functions/writeHead.md
|
|
|
4501
4501
|
|
|
4502
4502
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4503
4503
|
|
|
4504
|
-
Defined in: [lib/core.ts:
|
|
4504
|
+
Defined in: [lib/core.ts:1225](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1225)
|
|
4505
4505
|
|
|
4506
4506
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4507
4507
|
|
|
@@ -4542,7 +4542,7 @@ lib/core/functions/write.md
|
|
|
4542
4542
|
|
|
4543
4543
|
> **write**(`res`, `data`): `void`
|
|
4544
4544
|
|
|
4545
|
-
Defined in: [lib/core.ts:
|
|
4545
|
+
Defined in: [lib/core.ts:1248](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1248)
|
|
4546
4546
|
|
|
4547
4547
|
向 res 发送数据
|
|
4548
4548
|
|
|
@@ -4714,7 +4714,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4714
4714
|
|
|
4715
4715
|
# Interface: ILogOptions
|
|
4716
4716
|
|
|
4717
|
-
Defined in: [lib/core.ts:
|
|
4717
|
+
Defined in: [lib/core.ts:946](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L946)
|
|
4718
4718
|
|
|
4719
4719
|
log 设置的选项
|
|
4720
4720
|
|
|
@@ -4724,7 +4724,7 @@ log 设置的选项
|
|
|
4724
4724
|
|
|
4725
4725
|
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4726
4726
|
|
|
4727
|
-
Defined in: [lib/core.ts:
|
|
4727
|
+
Defined in: [lib/core.ts:952](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L952)
|
|
4728
4728
|
|
|
4729
4729
|
***
|
|
4730
4730
|
|
|
@@ -4732,7 +4732,7 @@ Defined in: [lib/core.ts:909](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4732
4732
|
|
|
4733
4733
|
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4734
4734
|
|
|
4735
|
-
Defined in: [lib/core.ts:
|
|
4735
|
+
Defined in: [lib/core.ts:951](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L951)
|
|
4736
4736
|
|
|
4737
4737
|
***
|
|
4738
4738
|
|
|
@@ -4740,7 +4740,7 @@ Defined in: [lib/core.ts:908](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4740
4740
|
|
|
4741
4741
|
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4742
4742
|
|
|
4743
|
-
Defined in: [lib/core.ts:
|
|
4743
|
+
Defined in: [lib/core.ts:954](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L954)
|
|
4744
4744
|
|
|
4745
4745
|
***
|
|
4746
4746
|
|
|
@@ -4748,7 +4748,7 @@ Defined in: [lib/core.ts:911](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4748
4748
|
|
|
4749
4749
|
> `optional` **hostname?**: `string`
|
|
4750
4750
|
|
|
4751
|
-
Defined in: [lib/core.ts:
|
|
4751
|
+
Defined in: [lib/core.ts:949](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L949)
|
|
4752
4752
|
|
|
4753
4753
|
***
|
|
4754
4754
|
|
|
@@ -4756,7 +4756,7 @@ Defined in: [lib/core.ts:906](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4756
4756
|
|
|
4757
4757
|
> `optional` **path?**: `string`
|
|
4758
4758
|
|
|
4759
|
-
Defined in: [lib/core.ts:
|
|
4759
|
+
Defined in: [lib/core.ts:947](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L947)
|
|
4760
4760
|
|
|
4761
4761
|
***
|
|
4762
4762
|
|
|
@@ -4764,7 +4764,7 @@ Defined in: [lib/core.ts:904](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4764
4764
|
|
|
4765
4765
|
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4766
4766
|
|
|
4767
|
-
Defined in: [lib/core.ts:
|
|
4767
|
+
Defined in: [lib/core.ts:950](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L950)
|
|
4768
4768
|
|
|
4769
4769
|
***
|
|
4770
4770
|
|
|
@@ -4772,7 +4772,7 @@ Defined in: [lib/core.ts:907](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4772
4772
|
|
|
4773
4773
|
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4774
4774
|
|
|
4775
|
-
Defined in: [lib/core.ts:
|
|
4775
|
+
Defined in: [lib/core.ts:953](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L953)
|
|
4776
4776
|
|
|
4777
4777
|
***
|
|
4778
4778
|
|
|
@@ -4780,7 +4780,7 @@ Defined in: [lib/core.ts:910](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4780
4780
|
|
|
4781
4781
|
> `optional` **urlFull?**: `string`
|
|
4782
4782
|
|
|
4783
|
-
Defined in: [lib/core.ts:
|
|
4783
|
+
Defined in: [lib/core.ts:948](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L948)
|
|
4784
4784
|
|
|
4785
4785
|
lib/core/type-aliases/TPm2Action.md
|
|
4786
4786
|
---
|
|
@@ -4795,7 +4795,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4795
4795
|
|
|
4796
4796
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4797
4797
|
|
|
4798
|
-
Defined in: [lib/core.ts:
|
|
4798
|
+
Defined in: [lib/core.ts:628](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L628)
|
|
4799
4799
|
|
|
4800
4800
|
PM2 操作类型
|
|
4801
4801
|
|
|
@@ -4869,7 +4869,7 @@ lib/core/variables/global.md
|
|
|
4869
4869
|
|
|
4870
4870
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
4871
4871
|
|
|
4872
|
-
Defined in: [lib/core.ts:
|
|
4872
|
+
Defined in: [lib/core.ts:725](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L725)
|
|
4873
4873
|
|
|
4874
4874
|
跨进程全局变量
|
|
4875
4875
|
|
|
@@ -23702,7 +23702,7 @@ Defined in: [sys/mod.ts:68](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
23702
23702
|
|
|
23703
23703
|
> `protected` **\_keyGenerator**(): `string`
|
|
23704
23704
|
|
|
23705
|
-
Defined in: [sys/mod.ts:
|
|
23705
|
+
Defined in: [sys/mod.ts:1778](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1778)
|
|
23706
23706
|
|
|
23707
23707
|
当 _key 不为空时,则依据继承此方法的方法自动生成填充 key
|
|
23708
23708
|
|
|
@@ -23724,7 +23724,7 @@ Defined in: [sys/mod.ts:1776](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23724
23724
|
|
|
23725
23725
|
> **all**(): `Promise`\<`false` \| [`Rows`](Rows.md)\<`Mod`\>\>
|
|
23726
23726
|
|
|
23727
|
-
Defined in: [sys/mod.ts:
|
|
23727
|
+
Defined in: [sys/mod.ts:1120](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1120)
|
|
23728
23728
|
|
|
23729
23729
|
##### Returns
|
|
23730
23730
|
|
|
@@ -23734,7 +23734,7 @@ Defined in: [sys/mod.ts:1118](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23734
23734
|
|
|
23735
23735
|
> **all**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Mod`\>\>
|
|
23736
23736
|
|
|
23737
|
-
Defined in: [sys/mod.ts:
|
|
23737
|
+
Defined in: [sys/mod.ts:1121](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1121)
|
|
23738
23738
|
|
|
23739
23739
|
##### Parameters
|
|
23740
23740
|
|
|
@@ -23760,7 +23760,7 @@ Defined in: [sys/mod.ts:1119](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23760
23760
|
|
|
23761
23761
|
> **allArray**(): `Promise`\<`false` \| `Record`\<`string`, `any`\>[]\>
|
|
23762
23762
|
|
|
23763
|
-
Defined in: [sys/mod.ts:
|
|
23763
|
+
Defined in: [sys/mod.ts:1299](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1299)
|
|
23764
23764
|
|
|
23765
23765
|
##### Returns
|
|
23766
23766
|
|
|
@@ -23770,7 +23770,7 @@ Defined in: [sys/mod.ts:1297](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23770
23770
|
|
|
23771
23771
|
> **allArray**(`key`): `Promise`\<`false` \| `Record`\<`string`, `Record`\<`string`, `any`\>\>\>
|
|
23772
23772
|
|
|
23773
|
-
Defined in: [sys/mod.ts:
|
|
23773
|
+
Defined in: [sys/mod.ts:1300](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1300)
|
|
23774
23774
|
|
|
23775
23775
|
##### Parameters
|
|
23776
23776
|
|
|
@@ -23788,7 +23788,7 @@ Defined in: [sys/mod.ts:1298](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23788
23788
|
|
|
23789
23789
|
> **append**(`sql`): `this`
|
|
23790
23790
|
|
|
23791
|
-
Defined in: [sys/mod.ts:
|
|
23791
|
+
Defined in: [sys/mod.ts:1687](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1687)
|
|
23792
23792
|
|
|
23793
23793
|
在 sql 最后追加字符串
|
|
23794
23794
|
|
|
@@ -23808,7 +23808,7 @@ Defined in: [sys/mod.ts:1685](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23808
23808
|
|
|
23809
23809
|
> **by**(`c`, `d?`): `this`
|
|
23810
23810
|
|
|
23811
|
-
Defined in: [sys/mod.ts:
|
|
23811
|
+
Defined in: [sys/mod.ts:1643](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1643)
|
|
23812
23812
|
|
|
23813
23813
|
ORDER BY
|
|
23814
23814
|
|
|
@@ -23836,7 +23836,7 @@ ORDER BY
|
|
|
23836
23836
|
|
|
23837
23837
|
> **contain**(`contain`): `this`
|
|
23838
23838
|
|
|
23839
|
-
Defined in: [sys/mod.ts:
|
|
23839
|
+
Defined in: [sys/mod.ts:1696](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1696)
|
|
23840
23840
|
|
|
23841
23841
|
设置闭包含数据
|
|
23842
23842
|
|
|
@@ -23864,7 +23864,7 @@ Defined in: [sys/mod.ts:1694](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23864
23864
|
|
|
23865
23865
|
> **count**(): `Promise`\<`number`\>
|
|
23866
23866
|
|
|
23867
|
-
Defined in: [sys/mod.ts:
|
|
23867
|
+
Defined in: [sys/mod.ts:1507](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1507)
|
|
23868
23868
|
|
|
23869
23869
|
根据当前条件,筛选出当前条目该有的数据条数
|
|
23870
23870
|
|
|
@@ -23878,7 +23878,7 @@ Defined in: [sys/mod.ts:1505](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23878
23878
|
|
|
23879
23879
|
> **countSql**(): `string`
|
|
23880
23880
|
|
|
23881
|
-
Defined in: [sys/mod.ts:
|
|
23881
|
+
Defined in: [sys/mod.ts:1528](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1528)
|
|
23882
23882
|
|
|
23883
23883
|
获取当前条件下的 count 的 SQL 语句
|
|
23884
23884
|
|
|
@@ -23892,7 +23892,7 @@ Defined in: [sys/mod.ts:1526](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23892
23892
|
|
|
23893
23893
|
> **create**(): `Promise`\<`boolean` \| `null`\>
|
|
23894
23894
|
|
|
23895
|
-
Defined in: [sys/mod.ts:
|
|
23895
|
+
Defined in: [sys/mod.ts:814](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L814)
|
|
23896
23896
|
|
|
23897
23897
|
创建数据
|
|
23898
23898
|
|
|
@@ -23908,7 +23908,7 @@ true-成功,false-报错,null-唯一键非 _$key 键冲突
|
|
|
23908
23908
|
|
|
23909
23909
|
> **crossJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
23910
23910
|
|
|
23911
|
-
Defined in: [sys/mod.ts:
|
|
23911
|
+
Defined in: [sys/mod.ts:1603](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1603)
|
|
23912
23912
|
|
|
23913
23913
|
cross join 方法
|
|
23914
23914
|
|
|
@@ -23956,7 +23956,7 @@ ON 信息
|
|
|
23956
23956
|
|
|
23957
23957
|
> **explain**(`all?`): `Promise`\<`string` \| `false`\>
|
|
23958
23958
|
|
|
23959
|
-
Defined in: [sys/mod.ts:
|
|
23959
|
+
Defined in: [sys/mod.ts:1425](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1425)
|
|
23960
23960
|
|
|
23961
23961
|
##### Parameters
|
|
23962
23962
|
|
|
@@ -23972,7 +23972,7 @@ Defined in: [sys/mod.ts:1423](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23972
23972
|
|
|
23973
23973
|
> **explain**(`all`): `Promise`\<`false` \| `Record`\<`string`, `any`\>\>
|
|
23974
23974
|
|
|
23975
|
-
Defined in: [sys/mod.ts:
|
|
23975
|
+
Defined in: [sys/mod.ts:1426](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1426)
|
|
23976
23976
|
|
|
23977
23977
|
##### Parameters
|
|
23978
23978
|
|
|
@@ -23990,7 +23990,7 @@ Defined in: [sys/mod.ts:1424](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23990
23990
|
|
|
23991
23991
|
> **filter**(`s`): `this`
|
|
23992
23992
|
|
|
23993
|
-
Defined in: [sys/mod.ts:
|
|
23993
|
+
Defined in: [sys/mod.ts:1621](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1621)
|
|
23994
23994
|
|
|
23995
23995
|
筛选器
|
|
23996
23996
|
|
|
@@ -24024,7 +24024,7 @@ Defined in: [sys/mod.ts:1619](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24024
24024
|
|
|
24025
24025
|
> **first**(`lock`, `array`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24026
24026
|
|
|
24027
|
-
Defined in: [sys/mod.ts:
|
|
24027
|
+
Defined in: [sys/mod.ts:1009](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1009)
|
|
24028
24028
|
|
|
24029
24029
|
##### Parameters
|
|
24030
24030
|
|
|
@@ -24044,7 +24044,7 @@ Defined in: [sys/mod.ts:1007](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24044
24044
|
|
|
24045
24045
|
> **first**(`lock?`, `array?`): `Promise`\<`false` \| `Mod` & `Record`\<`string`, `any`\> \| `null`\>
|
|
24046
24046
|
|
|
24047
|
-
Defined in: [sys/mod.ts:
|
|
24047
|
+
Defined in: [sys/mod.ts:1013](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1013)
|
|
24048
24048
|
|
|
24049
24049
|
##### Parameters
|
|
24050
24050
|
|
|
@@ -24066,7 +24066,7 @@ Defined in: [sys/mod.ts:1011](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24066
24066
|
|
|
24067
24067
|
> **firstArray**(`lock?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
24068
24068
|
|
|
24069
|
-
Defined in: [sys/mod.ts:
|
|
24069
|
+
Defined in: [sys/mod.ts:1053](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1053)
|
|
24070
24070
|
|
|
24071
24071
|
获取数据库第一个原生对象
|
|
24072
24072
|
|
|
@@ -24088,7 +24088,7 @@ Defined in: [sys/mod.ts:1051](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24088
24088
|
|
|
24089
24089
|
> **format**(`sql?`, `data?`): `string`
|
|
24090
24090
|
|
|
24091
|
-
Defined in: [sys/mod.ts:
|
|
24091
|
+
Defined in: [sys/mod.ts:1723](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1723)
|
|
24092
24092
|
|
|
24093
24093
|
获取带 data 的 sql 语句
|
|
24094
24094
|
|
|
@@ -24116,7 +24116,7 @@ sql 语句
|
|
|
24116
24116
|
|
|
24117
24117
|
> **fullJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24118
24118
|
|
|
24119
|
-
Defined in: [sys/mod.ts:
|
|
24119
|
+
Defined in: [sys/mod.ts:1591](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1591)
|
|
24120
24120
|
|
|
24121
24121
|
full join 方法
|
|
24122
24122
|
|
|
@@ -24156,7 +24156,7 @@ ON 信息
|
|
|
24156
24156
|
|
|
24157
24157
|
> **get**(`n`): `any`
|
|
24158
24158
|
|
|
24159
|
-
Defined in: [sys/mod.ts:
|
|
24159
|
+
Defined in: [sys/mod.ts:806](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L806)
|
|
24160
24160
|
|
|
24161
24161
|
获取一个字段值
|
|
24162
24162
|
|
|
@@ -24178,7 +24178,7 @@ Defined in: [sys/mod.ts:804](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24178
24178
|
|
|
24179
24179
|
> **getData**(): `any`[]
|
|
24180
24180
|
|
|
24181
|
-
Defined in: [sys/mod.ts:
|
|
24181
|
+
Defined in: [sys/mod.ts:1714](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1714)
|
|
24182
24182
|
|
|
24183
24183
|
获取全部 data
|
|
24184
24184
|
|
|
@@ -24192,7 +24192,7 @@ Defined in: [sys/mod.ts:1712](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24192
24192
|
|
|
24193
24193
|
> **getSql**(): `string`
|
|
24194
24194
|
|
|
24195
|
-
Defined in: [sys/mod.ts:
|
|
24195
|
+
Defined in: [sys/mod.ts:1707](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1707)
|
|
24196
24196
|
|
|
24197
24197
|
获取 sql 语句
|
|
24198
24198
|
|
|
@@ -24206,7 +24206,7 @@ Defined in: [sys/mod.ts:1705](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24206
24206
|
|
|
24207
24207
|
> **group**(`c`): `this`
|
|
24208
24208
|
|
|
24209
|
-
Defined in: [sys/mod.ts:
|
|
24209
|
+
Defined in: [sys/mod.ts:1652](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1652)
|
|
24210
24210
|
|
|
24211
24211
|
GROUP BY
|
|
24212
24212
|
|
|
@@ -24228,7 +24228,7 @@ GROUP BY
|
|
|
24228
24228
|
|
|
24229
24229
|
> **having**(`s`): `this`
|
|
24230
24230
|
|
|
24231
|
-
Defined in: [sys/mod.ts:
|
|
24231
|
+
Defined in: [sys/mod.ts:1612](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1612)
|
|
24232
24232
|
|
|
24233
24233
|
筛选器
|
|
24234
24234
|
|
|
@@ -24250,7 +24250,7 @@ Defined in: [sys/mod.ts:1610](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24250
24250
|
|
|
24251
24251
|
> **innerJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24252
24252
|
|
|
24253
|
-
Defined in: [sys/mod.ts:
|
|
24253
|
+
Defined in: [sys/mod.ts:1579](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1579)
|
|
24254
24254
|
|
|
24255
24255
|
inner join 方法
|
|
24256
24256
|
|
|
@@ -24290,7 +24290,7 @@ ON 信息
|
|
|
24290
24290
|
|
|
24291
24291
|
> **join**(`f`, `s?`, `type?`, `index?`, `pre?`): `this`
|
|
24292
24292
|
|
|
24293
|
-
Defined in: [sys/mod.ts:
|
|
24293
|
+
Defined in: [sys/mod.ts:1543](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1543)
|
|
24294
24294
|
|
|
24295
24295
|
#### Parameters
|
|
24296
24296
|
|
|
@@ -24334,7 +24334,7 @@ ON 信息
|
|
|
24334
24334
|
|
|
24335
24335
|
> **langText**(`col`, `lang`): `string`
|
|
24336
24336
|
|
|
24337
|
-
Defined in: [sys/mod.ts:
|
|
24337
|
+
Defined in: [sys/mod.ts:1758](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1758)
|
|
24338
24338
|
|
|
24339
24339
|
获取字段的可用语种文本
|
|
24340
24340
|
|
|
@@ -24362,7 +24362,7 @@ Defined in: [sys/mod.ts:1756](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24362
24362
|
|
|
24363
24363
|
> **leftJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24364
24364
|
|
|
24365
|
-
Defined in: [sys/mod.ts:
|
|
24365
|
+
Defined in: [sys/mod.ts:1555](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1555)
|
|
24366
24366
|
|
|
24367
24367
|
left join 方法
|
|
24368
24368
|
|
|
@@ -24402,7 +24402,7 @@ ON 信息
|
|
|
24402
24402
|
|
|
24403
24403
|
> **limit**(`a`, `b?`): `this`
|
|
24404
24404
|
|
|
24405
|
-
Defined in: [sys/mod.ts:
|
|
24405
|
+
Defined in: [sys/mod.ts:1665](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1665)
|
|
24406
24406
|
|
|
24407
24407
|
LIMIT
|
|
24408
24408
|
|
|
@@ -24430,7 +24430,7 @@ LIMIT
|
|
|
24430
24430
|
|
|
24431
24431
|
> **page**(`count`, `page?`): `this`
|
|
24432
24432
|
|
|
24433
|
-
Defined in: [sys/mod.ts:
|
|
24433
|
+
Defined in: [sys/mod.ts:1676](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1676)
|
|
24434
24434
|
|
|
24435
24435
|
分页
|
|
24436
24436
|
|
|
@@ -24458,7 +24458,7 @@ Defined in: [sys/mod.ts:1674](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24458
24458
|
|
|
24459
24459
|
> **refresh**(`lock?`): `Promise`\<`boolean` \| `null`\>
|
|
24460
24460
|
|
|
24461
|
-
Defined in: [sys/mod.ts:
|
|
24461
|
+
Defined in: [sys/mod.ts:934](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L934)
|
|
24462
24462
|
|
|
24463
24463
|
刷新当前模型获取最新数据
|
|
24464
24464
|
|
|
@@ -24480,7 +24480,7 @@ Defined in: [sys/mod.ts:932](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24480
24480
|
|
|
24481
24481
|
> **remove**(): `Promise`\<`boolean`\>
|
|
24482
24482
|
|
|
24483
|
-
Defined in: [sys/mod.ts:
|
|
24483
|
+
Defined in: [sys/mod.ts:991](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L991)
|
|
24484
24484
|
|
|
24485
24485
|
移除本条目
|
|
24486
24486
|
|
|
@@ -24494,7 +24494,7 @@ Defined in: [sys/mod.ts:989](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24494
24494
|
|
|
24495
24495
|
> **rightJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
24496
24496
|
|
|
24497
|
-
Defined in: [sys/mod.ts:
|
|
24497
|
+
Defined in: [sys/mod.ts:1567](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1567)
|
|
24498
24498
|
|
|
24499
24499
|
right join 方法
|
|
24500
24500
|
|
|
@@ -24534,7 +24534,7 @@ ON 信息
|
|
|
24534
24534
|
|
|
24535
24535
|
> **save**(`where?`): `Promise`\<`boolean`\>
|
|
24536
24536
|
|
|
24537
|
-
Defined in: [sys/mod.ts:
|
|
24537
|
+
Defined in: [sys/mod.ts:962](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L962)
|
|
24538
24538
|
|
|
24539
24539
|
更新 set 的数据到数据库,有未保存数据时才保存
|
|
24540
24540
|
|
|
@@ -24568,7 +24568,7 @@ Defined in: [sys/mod.ts:960](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24568
24568
|
|
|
24569
24569
|
> **set**\<`T`, `TK`\>(`n`): `void`
|
|
24570
24570
|
|
|
24571
|
-
Defined in: [sys/mod.ts:
|
|
24571
|
+
Defined in: [sys/mod.ts:767](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L767)
|
|
24572
24572
|
|
|
24573
24573
|
##### Type Parameters
|
|
24574
24574
|
|
|
@@ -24594,7 +24594,7 @@ Defined in: [sys/mod.ts:765](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24594
24594
|
|
|
24595
24595
|
> **set**\<`T`, `TK`\>(`n`, `v`): `void`
|
|
24596
24596
|
|
|
24597
|
-
Defined in: [sys/mod.ts:
|
|
24597
|
+
Defined in: [sys/mod.ts:768](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L768)
|
|
24598
24598
|
|
|
24599
24599
|
##### Type Parameters
|
|
24600
24600
|
|
|
@@ -24626,7 +24626,7 @@ Defined in: [sys/mod.ts:766](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24626
24626
|
|
|
24627
24627
|
> **toArray**\<`TC`\>(): [`TOnlyProperties`](../type-aliases/TOnlyProperties.md)\<`InstanceType`\<`TC`\>\> & `Record`\<`string`, `any`\>
|
|
24628
24628
|
|
|
24629
|
-
Defined in: [sys/mod.ts:
|
|
24629
|
+
Defined in: [sys/mod.ts:1730](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1730)
|
|
24630
24630
|
|
|
24631
24631
|
获取值对象,获取的是新创建的数组
|
|
24632
24632
|
|
|
@@ -24646,7 +24646,7 @@ Defined in: [sys/mod.ts:1728](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24646
24646
|
|
|
24647
24647
|
> **total**(`f?`): `Promise`\<`number`\>
|
|
24648
24648
|
|
|
24649
|
-
Defined in: [sys/mod.ts:
|
|
24649
|
+
Defined in: [sys/mod.ts:1483](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1483)
|
|
24650
24650
|
|
|
24651
24651
|
获取总条数,自动抛弃 LIMIT,仅用于获取数据的情况(select)
|
|
24652
24652
|
|
|
@@ -24666,7 +24666,7 @@ Defined in: [sys/mod.ts:1481](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24666
24666
|
|
|
24667
24667
|
> **union**(`f`, `type?`): `this`
|
|
24668
24668
|
|
|
24669
|
-
Defined in: [sys/mod.ts:
|
|
24669
|
+
Defined in: [sys/mod.ts:1064](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1064)
|
|
24670
24670
|
|
|
24671
24671
|
联合查询表数据
|
|
24672
24672
|
|
|
@@ -24694,7 +24694,7 @@ Defined in: [sys/mod.ts:1062](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24694
24694
|
|
|
24695
24695
|
> **unionAll**(`f`): `this`
|
|
24696
24696
|
|
|
24697
|
-
Defined in: [sys/mod.ts:
|
|
24697
|
+
Defined in: [sys/mod.ts:1094](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1094)
|
|
24698
24698
|
|
|
24699
24699
|
所有联合查询表数据
|
|
24700
24700
|
|
|
@@ -24716,7 +24716,7 @@ Defined in: [sys/mod.ts:1092](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24716
24716
|
|
|
24717
24717
|
> **unsaved**(): `boolean`
|
|
24718
24718
|
|
|
24719
|
-
Defined in: [sys/mod.ts:
|
|
24719
|
+
Defined in: [sys/mod.ts:1749](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1749)
|
|
24720
24720
|
|
|
24721
24721
|
当前是否设置了未保存 --=
|
|
24722
24722
|
|
|
@@ -24730,7 +24730,7 @@ Defined in: [sys/mod.ts:1747](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24730
24730
|
|
|
24731
24731
|
> **updates**(): `Record`\<`string`, `any`\>
|
|
24732
24732
|
|
|
24733
|
-
Defined in: [sys/mod.ts:
|
|
24733
|
+
Defined in: [sys/mod.ts:1738](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1738)
|
|
24734
24734
|
|
|
24735
24735
|
获取当前设置要提交的数据
|
|
24736
24736
|
|
|
@@ -24744,7 +24744,7 @@ Defined in: [sys/mod.ts:1736](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
24744
24744
|
|
|
24745
24745
|
> **upsert**(`conflict`): `Promise`\<`boolean`\>
|
|
24746
24746
|
|
|
24747
|
-
Defined in: [sys/mod.ts:
|
|
24747
|
+
Defined in: [sys/mod.ts:904](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L904)
|
|
24748
24748
|
|
|
24749
24749
|
插入数据,如果存在则更新(UPSERT)
|
|
24750
24750
|
|
|
@@ -24766,7 +24766,7 @@ Defined in: [sys/mod.ts:902](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24766
24766
|
|
|
24767
24767
|
> **where**(`s`): `this`
|
|
24768
24768
|
|
|
24769
|
-
Defined in: [sys/mod.ts:
|
|
24769
|
+
Defined in: [sys/mod.ts:1632](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1632)
|
|
24770
24770
|
|
|
24771
24771
|
是 filter 的别名
|
|
24772
24772
|
|
|
@@ -24820,7 +24820,7 @@ Defined in: [sys/mod.ts:175](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24820
24820
|
|
|
24821
24821
|
> `static` **find**\<`T`\>(`db`, `val`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
24822
24822
|
|
|
24823
|
-
Defined in: [sys/mod.ts:
|
|
24823
|
+
Defined in: [sys/mod.ts:590](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L590)
|
|
24824
24824
|
|
|
24825
24825
|
根据主键(或 key 字段)获取对象
|
|
24826
24826
|
|
|
@@ -24880,7 +24880,7 @@ Defined in: [sys/mod.ts:588](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
24880
24880
|
|
|
24881
24881
|
> `static` **getCreate**\<`T`\>(`db`, `opt?`): `T`
|
|
24882
24882
|
|
|
24883
|
-
Defined in: [sys/mod.ts:
|
|
24883
|
+
Defined in: [sys/mod.ts:572](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L572)
|
|
24884
24884
|
|
|
24885
24885
|
获取创建对象,通常用于新建数据库条目
|
|
24886
24886
|
|
|
@@ -25068,7 +25068,7 @@ Defined in: [sys/mod.ts:193](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25068
25068
|
|
|
25069
25069
|
> `static` **one**(`db`, `s`, `opt`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25070
25070
|
|
|
25071
|
-
Defined in: [sys/mod.ts:
|
|
25071
|
+
Defined in: [sys/mod.ts:617](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L617)
|
|
25072
25072
|
|
|
25073
25073
|
##### Parameters
|
|
25074
25074
|
|
|
@@ -25118,7 +25118,7 @@ Defined in: [sys/mod.ts:615](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25118
25118
|
|
|
25119
25119
|
> `static` **one**\<`T`\>(`db`, `s`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
25120
25120
|
|
|
25121
|
-
Defined in: [sys/mod.ts:
|
|
25121
|
+
Defined in: [sys/mod.ts:630](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L630)
|
|
25122
25122
|
|
|
25123
25123
|
##### Type Parameters
|
|
25124
25124
|
|
|
@@ -25176,7 +25176,7 @@ Defined in: [sys/mod.ts:628](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25176
25176
|
|
|
25177
25177
|
> `static` **oneArray**(`db`, `s`, `opt?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
25178
25178
|
|
|
25179
|
-
Defined in: [sys/mod.ts:
|
|
25179
|
+
Defined in: [sys/mod.ts:707](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L707)
|
|
25180
25180
|
|
|
25181
25181
|
通过 where 条件筛选单条数据返回原生对象
|
|
25182
25182
|
|
|
@@ -25228,7 +25228,7 @@ Defined in: [sys/mod.ts:705](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25228
25228
|
|
|
25229
25229
|
> `static` **primarys**(`db`, `where?`, `opt?`): `Promise`\<`false` \| `any`[]\>
|
|
25230
25230
|
|
|
25231
|
-
Defined in: [sys/mod.ts:
|
|
25231
|
+
Defined in: [sys/mod.ts:728](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L728)
|
|
25232
25232
|
|
|
25233
25233
|
根据 where 条件获取主键值列表
|
|
25234
25234
|
|
|
@@ -25376,7 +25376,7 @@ Defined in: [sys/mod.ts:334](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25376
25376
|
|
|
25377
25377
|
> `static` **select**\<`T`\>(`db`, `c`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
25378
25378
|
|
|
25379
|
-
Defined in: [sys/mod.ts:
|
|
25379
|
+
Defined in: [sys/mod.ts:513](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L513)
|
|
25380
25380
|
|
|
25381
25381
|
select 自定字段
|
|
25382
25382
|
|
|
@@ -25442,7 +25442,7 @@ select 自定字段
|
|
|
25442
25442
|
|
|
25443
25443
|
> `static` **toArrayByRecord**\<`T`\>(`obj`): `Record`\<`string`, `Record`\<`string`, `any`\>\>
|
|
25444
25444
|
|
|
25445
|
-
Defined in: [sys/mod.ts:
|
|
25445
|
+
Defined in: [sys/mod.ts:755](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L755)
|
|
25446
25446
|
|
|
25447
25447
|
将 key val 组成的数据列表转换为原生对象模式,获取的是新创建的数组
|
|
25448
25448
|
|
|
@@ -25586,7 +25586,7 @@ Defined in: [sys/mod.ts:413](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25586
25586
|
|
|
25587
25587
|
> `static` **updateList**(`db`, `data`, `key`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
25588
25588
|
|
|
25589
|
-
Defined in: [sys/mod.ts:
|
|
25589
|
+
Defined in: [sys/mod.ts:449](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L449)
|
|
25590
25590
|
|
|
25591
25591
|
批量更新数据
|
|
25592
25592
|
|
|
@@ -25602,13 +25602,15 @@ Defined in: [sys/mod.ts:447](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25602
25602
|
|
|
25603
25603
|
`Record`\<`string`, `any`\>[]
|
|
25604
25604
|
|
|
25605
|
-
|
|
25605
|
+
数据列表,每个元素必须包含 key 字段,其余字段为要更新的列;
|
|
25606
|
+
支持稀疏数据(不同元素可以拥有不同的列集合),内部会自动按列集合分组批量执行
|
|
25606
25607
|
|
|
25607
25608
|
##### key
|
|
25608
25609
|
|
|
25609
25610
|
`string`
|
|
25610
25611
|
|
|
25611
|
-
|
|
25612
|
+
用于定位记录的字段名(主键或唯一键),该字段仅用于 WHERE 条件匹配,不会被更新;
|
|
25613
|
+
data 中每个元素都必须包含此字段,否则该元素会被跳过
|
|
25612
25614
|
|
|
25613
25615
|
##### opt?
|
|
25614
25616
|
|
|
@@ -25668,7 +25670,7 @@ Defined in: [sys/mod.ts:184](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
25668
25670
|
|
|
25669
25671
|
> `static` **where**\<`T`\>(`db`, `s?`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
25670
25672
|
|
|
25671
|
-
Defined in: [sys/mod.ts:
|
|
25673
|
+
Defined in: [sys/mod.ts:543](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L543)
|
|
25672
25674
|
|
|
25673
25675
|
通过 where 条件获取模型
|
|
25674
25676
|
|
|
@@ -25933,7 +25935,7 @@ sys/mod/interfaces/IModUnionItem.md
|
|
|
25933
25935
|
|
|
25934
25936
|
# Interface: IModUnionItem
|
|
25935
25937
|
|
|
25936
|
-
Defined in: [sys/mod.ts:
|
|
25938
|
+
Defined in: [sys/mod.ts:1792](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1792)
|
|
25937
25939
|
|
|
25938
25940
|
## Properties
|
|
25939
25941
|
|
|
@@ -25941,7 +25943,7 @@ Defined in: [sys/mod.ts:1790](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25941
25943
|
|
|
25942
25944
|
> **field**: `string`
|
|
25943
25945
|
|
|
25944
|
-
Defined in: [sys/mod.ts:
|
|
25946
|
+
Defined in: [sys/mod.ts:1793](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1793)
|
|
25945
25947
|
|
|
25946
25948
|
***
|
|
25947
25949
|
|
|
@@ -25949,7 +25951,7 @@ Defined in: [sys/mod.ts:1791](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25949
25951
|
|
|
25950
25952
|
> `optional` **where?**: `any`
|
|
25951
25953
|
|
|
25952
|
-
Defined in: [sys/mod.ts:
|
|
25954
|
+
Defined in: [sys/mod.ts:1794](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1794)
|
|
25953
25955
|
|
|
25954
25956
|
sys/mod/interfaces/IRows.md
|
|
25955
25957
|
---
|
|
@@ -25962,7 +25964,7 @@ sys/mod/interfaces/IRows.md
|
|
|
25962
25964
|
|
|
25963
25965
|
# Interface: IRows\<T\>
|
|
25964
25966
|
|
|
25965
|
-
Defined in: [sys/mod.ts:
|
|
25967
|
+
Defined in: [sys/mod.ts:1786](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1786)
|
|
25966
25968
|
|
|
25967
25969
|
## Extends
|
|
25968
25970
|
|
|
@@ -25980,7 +25982,7 @@ Defined in: [sys/mod.ts:1784](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25980
25982
|
|
|
25981
25983
|
> `readonly` **length**: `number`
|
|
25982
25984
|
|
|
25983
|
-
Defined in: [sys/mod.ts:
|
|
25985
|
+
Defined in: [sys/mod.ts:1787](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1787)
|
|
25984
25986
|
|
|
25985
25987
|
## Methods
|
|
25986
25988
|
|
|
@@ -25988,7 +25990,7 @@ Defined in: [sys/mod.ts:1785](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
25988
25990
|
|
|
25989
25991
|
> **item**(`index`): `T`
|
|
25990
25992
|
|
|
25991
|
-
Defined in: [sys/mod.ts:
|
|
25993
|
+
Defined in: [sys/mod.ts:1788](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1788)
|
|
25992
25994
|
|
|
25993
25995
|
#### Parameters
|
|
25994
25996
|
|
|
@@ -26006,7 +26008,7 @@ Defined in: [sys/mod.ts:1786](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
26006
26008
|
|
|
26007
26009
|
> **toArray**(): `Record`\<`string`, `any`\>[]
|
|
26008
26010
|
|
|
26009
|
-
Defined in: [sys/mod.ts:
|
|
26011
|
+
Defined in: [sys/mod.ts:1789](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1789)
|
|
26010
26012
|
|
|
26011
26013
|
#### Returns
|
|
26012
26014
|
|