@maiyunnet/kebab 8.0.0 → 8.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/doc/kebab-rag.md +277 -277
- package/index.d.ts +1 -1
- package/index.js +1 -1
- package/lib/socket.js +1 -0
- package/lib/ws.js +1 -0
- package/package.json +8 -8
- package/www/example/skill/weather.d.ts +0 -15
- package/www/example/skill/weather.js +0 -36
package/doc/kebab-rag.md
CHANGED
|
@@ -1385,7 +1385,7 @@ index/variables/VER.md
|
|
|
1385
1385
|
|
|
1386
1386
|
# Variable: VER
|
|
1387
1387
|
|
|
1388
|
-
> `const` **VER**: `"8.0.
|
|
1388
|
+
> `const` **VER**: `"8.0.1"` = `'8.0.1'`
|
|
1389
1389
|
|
|
1390
1390
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1391
1391
|
|
|
@@ -1974,7 +1974,7 @@ Defined in: [lib/buffer.ts:113](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
1974
1974
|
|
|
1975
1975
|
### writeString()
|
|
1976
1976
|
|
|
1977
|
-
> **writeString**(`value`, `encoding
|
|
1977
|
+
> **writeString**(`value`, `encoding?`): `number`
|
|
1978
1978
|
|
|
1979
1979
|
Defined in: [lib/buffer.ts:126](https://github.com/maiyunnet/kebab/blob/master/lib/buffer.ts#L126)
|
|
1980
1980
|
|
|
@@ -1986,7 +1986,7 @@ Defined in: [lib/buffer.ts:126](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
1986
1986
|
|
|
1987
1987
|
`string`
|
|
1988
1988
|
|
|
1989
|
-
##### encoding
|
|
1989
|
+
##### encoding?
|
|
1990
1990
|
|
|
1991
1991
|
`BufferEncoding` = `'utf8'`
|
|
1992
1992
|
|
|
@@ -2227,7 +2227,7 @@ lib/captcha/functions/get.md
|
|
|
2227
2227
|
|
|
2228
2228
|
# Function: get()
|
|
2229
2229
|
|
|
2230
|
-
> **get**(`width`, `height`, `length
|
|
2230
|
+
> **get**(`width`, `height`, `length?`): [`Captcha`](../classes/Captcha.md)
|
|
2231
2231
|
|
|
2232
2232
|
Defined in: [lib/captcha.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/captcha.ts#L57)
|
|
2233
2233
|
|
|
@@ -2247,7 +2247,7 @@ Defined in: [lib/captcha.ts:57](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
2247
2247
|
|
|
2248
2248
|
高度
|
|
2249
2249
|
|
|
2250
|
-
### length
|
|
2250
|
+
### length?
|
|
2251
2251
|
|
|
2252
2252
|
`number` = `4`
|
|
2253
2253
|
|
|
@@ -2426,7 +2426,7 @@ lib/consistent/functions/addToCircle.md
|
|
|
2426
2426
|
|
|
2427
2427
|
# Function: addToCircle()
|
|
2428
2428
|
|
|
2429
|
-
> **addToCircle**(`circle`, `node`, `vcount
|
|
2429
|
+
> **addToCircle**(`circle`, `node`, `vcount?`): `void`
|
|
2430
2430
|
|
|
2431
2431
|
Defined in: [lib/consistent.ts:167](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L167)
|
|
2432
2432
|
|
|
@@ -2446,7 +2446,7 @@ node 节点名一个或多个
|
|
|
2446
2446
|
|
|
2447
2447
|
`string` | `string`[]
|
|
2448
2448
|
|
|
2449
|
-
### vcount
|
|
2449
|
+
### vcount?
|
|
2450
2450
|
|
|
2451
2451
|
`number` = `300`
|
|
2452
2452
|
|
|
@@ -2467,7 +2467,7 @@ lib/consistent/functions/fast.md
|
|
|
2467
2467
|
|
|
2468
2468
|
# Function: fast()
|
|
2469
2469
|
|
|
2470
|
-
> **fast**(`key`, `nodes`, `vcount
|
|
2470
|
+
> **fast**(`key`, `nodes`, `vcount?`): `string` \| `null`
|
|
2471
2471
|
|
|
2472
2472
|
Defined in: [lib/consistent.ts:124](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L124)
|
|
2473
2473
|
|
|
@@ -2487,7 +2487,7 @@ node 列表
|
|
|
2487
2487
|
|
|
2488
2488
|
`string` | `string`[]
|
|
2489
2489
|
|
|
2490
|
-
### vcount
|
|
2490
|
+
### vcount?
|
|
2491
2491
|
|
|
2492
2492
|
`number` = `300`
|
|
2493
2493
|
|
|
@@ -2508,7 +2508,7 @@ lib/consistent/functions/findInCircle.md
|
|
|
2508
2508
|
|
|
2509
2509
|
# Function: findInCircle()
|
|
2510
2510
|
|
|
2511
|
-
> **findInCircle**(`circle`, `key`, `keys
|
|
2511
|
+
> **findInCircle**(`circle`, `key`, `keys?`): `string` \| `null`
|
|
2512
2512
|
|
|
2513
2513
|
Defined in: [lib/consistent.ts:188](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L188)
|
|
2514
2514
|
|
|
@@ -2528,7 +2528,7 @@ Defined in: [lib/consistent.ts:188](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
2528
2528
|
|
|
2529
2529
|
`string` | `number`
|
|
2530
2530
|
|
|
2531
|
-
### keys
|
|
2531
|
+
### keys?
|
|
2532
2532
|
|
|
2533
2533
|
`string`[] = `[]`
|
|
2534
2534
|
|
|
@@ -2549,13 +2549,13 @@ lib/consistent/functions/get.md
|
|
|
2549
2549
|
|
|
2550
2550
|
# Function: get()
|
|
2551
2551
|
|
|
2552
|
-
> **get**(`vcount
|
|
2552
|
+
> **get**(`vcount?`): [`Consistent`](../classes/Consistent.md)
|
|
2553
2553
|
|
|
2554
2554
|
Defined in: [lib/consistent.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L114)
|
|
2555
2555
|
|
|
2556
2556
|
## Parameters
|
|
2557
2557
|
|
|
2558
|
-
### vcount
|
|
2558
|
+
### vcount?
|
|
2559
2559
|
|
|
2560
2560
|
`number` = `300`
|
|
2561
2561
|
|
|
@@ -2574,7 +2574,7 @@ lib/consistent/functions/getRange.md
|
|
|
2574
2574
|
|
|
2575
2575
|
# Function: getRange()
|
|
2576
2576
|
|
|
2577
|
-
> **getRange**(`min`, `max`, `pre
|
|
2577
|
+
> **getRange**(`min`, `max`, `pre?`): `string`[]
|
|
2578
2578
|
|
|
2579
2579
|
Defined in: [lib/consistent.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/consistent.ts#L153)
|
|
2580
2580
|
|
|
@@ -2594,7 +2594,7 @@ Defined in: [lib/consistent.ts:153](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
2594
2594
|
|
|
2595
2595
|
最大值(含)
|
|
2596
2596
|
|
|
2597
|
-
### pre
|
|
2597
|
+
### pre?
|
|
2598
2598
|
|
|
2599
2599
|
`string` = `''`
|
|
2600
2600
|
|
|
@@ -2668,7 +2668,7 @@ lib/core/functions/checkType.md
|
|
|
2668
2668
|
|
|
2669
2669
|
# Function: checkType()
|
|
2670
2670
|
|
|
2671
|
-
> **checkType**(`val`, `type`, `tree
|
|
2671
|
+
> **checkType**(`val`, `type`, `tree?`): `string`
|
|
2672
2672
|
|
|
2673
2673
|
Defined in: [lib/core.ts:201](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L201)
|
|
2674
2674
|
|
|
@@ -2688,7 +2688,7 @@ Defined in: [lib/core.ts:201](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
2688
2688
|
|
|
2689
2689
|
示例组
|
|
2690
2690
|
|
|
2691
|
-
### tree
|
|
2691
|
+
### tree?
|
|
2692
2692
|
|
|
2693
2693
|
`string` = `'root'`
|
|
2694
2694
|
|
|
@@ -2773,7 +2773,7 @@ lib/core/functions/debug.md
|
|
|
2773
2773
|
|
|
2774
2774
|
# Function: debug()
|
|
2775
2775
|
|
|
2776
|
-
> **debug**(`message?`, ...`optionalParams
|
|
2776
|
+
> **debug**(`message?`, ...`optionalParams`): `void`
|
|
2777
2777
|
|
|
2778
2778
|
Defined in: [lib/core.ts:981](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L981)
|
|
2779
2779
|
|
|
@@ -2787,7 +2787,7 @@ Defined in: [lib/core.ts:981](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
2787
2787
|
|
|
2788
2788
|
参数
|
|
2789
2789
|
|
|
2790
|
-
### optionalParams
|
|
2790
|
+
### optionalParams
|
|
2791
2791
|
|
|
2792
2792
|
...`any`[]
|
|
2793
2793
|
|
|
@@ -2808,7 +2808,7 @@ lib/core/functions/display.md
|
|
|
2808
2808
|
|
|
2809
2809
|
# Function: display()
|
|
2810
2810
|
|
|
2811
|
-
> **display**(`message?`, ...`optionalParams
|
|
2811
|
+
> **display**(`message?`, ...`optionalParams`): `void`
|
|
2812
2812
|
|
|
2813
2813
|
Defined in: [lib/core.ts:994](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L994)
|
|
2814
2814
|
|
|
@@ -2822,7 +2822,7 @@ Defined in: [lib/core.ts:994](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
2822
2822
|
|
|
2823
2823
|
参数
|
|
2824
2824
|
|
|
2825
|
-
### optionalParams
|
|
2825
|
+
### optionalParams
|
|
2826
2826
|
|
|
2827
2827
|
...`any`[]
|
|
2828
2828
|
|
|
@@ -2843,7 +2843,7 @@ lib/core/functions/emptyObject.md
|
|
|
2843
2843
|
|
|
2844
2844
|
# Function: emptyObject()
|
|
2845
2845
|
|
|
2846
|
-
> **emptyObject**(`obj`, `deep
|
|
2846
|
+
> **emptyObject**(`obj`, `deep?`): `void`
|
|
2847
2847
|
|
|
2848
2848
|
Defined in: [lib/core.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L410)
|
|
2849
2849
|
|
|
@@ -2857,7 +2857,7 @@ Defined in: [lib/core.ts:410](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
2857
2857
|
|
|
2858
2858
|
要清除的对象
|
|
2859
2859
|
|
|
2860
|
-
### deep
|
|
2860
|
+
### deep?
|
|
2861
2861
|
|
|
2862
2862
|
`boolean` = `false`
|
|
2863
2863
|
|
|
@@ -2878,7 +2878,7 @@ lib/core/functions/exec.md
|
|
|
2878
2878
|
|
|
2879
2879
|
# Function: exec()
|
|
2880
2880
|
|
|
2881
|
-
> **exec**(`command`, `options
|
|
2881
|
+
> **exec**(`command`, `options?`): `Promise`\<`string` \| `false`\>
|
|
2882
2882
|
|
|
2883
2883
|
Defined in: [lib/core.ts:468](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L468)
|
|
2884
2884
|
|
|
@@ -2892,7 +2892,7 @@ Defined in: [lib/core.ts:468](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
2892
2892
|
|
|
2893
2893
|
命令字符串
|
|
2894
2894
|
|
|
2895
|
-
### options
|
|
2895
|
+
### options?
|
|
2896
2896
|
|
|
2897
2897
|
#### cwd?
|
|
2898
2898
|
|
|
@@ -3019,7 +3019,7 @@ lib/core/functions/log.md
|
|
|
3019
3019
|
|
|
3020
3020
|
# Function: log()
|
|
3021
3021
|
|
|
3022
|
-
> **log**(`opt`, `msg`, `fend
|
|
3022
|
+
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3023
3023
|
|
|
3024
3024
|
Defined in: [lib/core.ts:774](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L774)
|
|
3025
3025
|
|
|
@@ -3039,7 +3039,7 @@ Defined in: [lib/core.ts:774](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3039
3039
|
|
|
3040
3040
|
自定义内容
|
|
3041
3041
|
|
|
3042
|
-
### fend
|
|
3042
|
+
### fend?
|
|
3043
3043
|
|
|
3044
3044
|
`string` = `''`
|
|
3045
3045
|
|
|
@@ -3103,7 +3103,7 @@ lib/core/functions/muid.md
|
|
|
3103
3103
|
|
|
3104
3104
|
# Function: muid()
|
|
3105
3105
|
|
|
3106
|
-
> **muid**(`ctr`, `opt
|
|
3106
|
+
> **muid**(`ctr`, `opt?`): `string`
|
|
3107
3107
|
|
|
3108
3108
|
Defined in: [lib/core.ts:289](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L289)
|
|
3109
3109
|
|
|
@@ -3117,7 +3117,7 @@ Defined in: [lib/core.ts:289](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3117
3117
|
|
|
3118
3118
|
Ctr 对象
|
|
3119
3119
|
|
|
3120
|
-
### opt
|
|
3120
|
+
### opt?
|
|
3121
3121
|
|
|
3122
3122
|
参数
|
|
3123
3123
|
|
|
@@ -3201,7 +3201,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3201
3201
|
|
|
3202
3202
|
# Function: passThroughAppend()
|
|
3203
3203
|
|
|
3204
|
-
> **passThroughAppend**(`passThrough`, `data`, `end
|
|
3204
|
+
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3205
3205
|
|
|
3206
3206
|
Defined in: [lib/core.ts:429](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L429)
|
|
3207
3207
|
|
|
@@ -3221,7 +3221,7 @@ passThrough 对象
|
|
|
3221
3221
|
|
|
3222
3222
|
数组
|
|
3223
3223
|
|
|
3224
|
-
### end
|
|
3224
|
+
### end?
|
|
3225
3225
|
|
|
3226
3226
|
`boolean` = `true`
|
|
3227
3227
|
|
|
@@ -3271,7 +3271,7 @@ lib/core/functions/rand.md
|
|
|
3271
3271
|
|
|
3272
3272
|
# Function: rand()
|
|
3273
3273
|
|
|
3274
|
-
> **rand**(`min`, `max`, `prec
|
|
3274
|
+
> **rand**(`min`, `max`, `prec?`): `number`
|
|
3275
3275
|
|
|
3276
3276
|
Defined in: [lib/core.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L79)
|
|
3277
3277
|
|
|
@@ -3291,7 +3291,7 @@ Defined in: [lib/core.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
3291
3291
|
|
|
3292
3292
|
<= 最大值
|
|
3293
3293
|
|
|
3294
|
-
### prec
|
|
3294
|
+
### prec?
|
|
3295
3295
|
|
|
3296
3296
|
`number` = `0`
|
|
3297
3297
|
|
|
@@ -3312,7 +3312,7 @@ lib/core/functions/random.md
|
|
|
3312
3312
|
|
|
3313
3313
|
# Function: random()
|
|
3314
3314
|
|
|
3315
|
-
> **random**(`length
|
|
3315
|
+
> **random**(`length?`, `source?`, `block?`): `string`
|
|
3316
3316
|
|
|
3317
3317
|
Defined in: [lib/core.ts:117](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L117)
|
|
3318
3318
|
|
|
@@ -3320,19 +3320,19 @@ Defined in: [lib/core.ts:117](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3320
3320
|
|
|
3321
3321
|
## Parameters
|
|
3322
3322
|
|
|
3323
|
-
### length
|
|
3323
|
+
### length?
|
|
3324
3324
|
|
|
3325
3325
|
`number` = `8`
|
|
3326
3326
|
|
|
3327
3327
|
长度
|
|
3328
3328
|
|
|
3329
|
-
### source
|
|
3329
|
+
### source?
|
|
3330
3330
|
|
|
3331
3331
|
`string` = `RANDOM_LN`
|
|
3332
3332
|
|
|
3333
3333
|
采样值
|
|
3334
3334
|
|
|
3335
|
-
### block
|
|
3335
|
+
### block?
|
|
3336
3336
|
|
|
3337
3337
|
`string` = `''`
|
|
3338
3338
|
|
|
@@ -3353,7 +3353,7 @@ lib/core/functions/realIP.md
|
|
|
3353
3353
|
|
|
3354
3354
|
# Function: realIP()
|
|
3355
3355
|
|
|
3356
|
-
> **realIP**(`ctr`, `name
|
|
3356
|
+
> **realIP**(`ctr`, `name?`): `string`
|
|
3357
3357
|
|
|
3358
3358
|
Defined in: [lib/core.ts:363](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L363)
|
|
3359
3359
|
|
|
@@ -3365,7 +3365,7 @@ Defined in: [lib/core.ts:363](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3365
3365
|
|
|
3366
3366
|
[`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
3367
3367
|
|
|
3368
|
-
### name
|
|
3368
|
+
### name?
|
|
3369
3369
|
|
|
3370
3370
|
`string` = `''`
|
|
3371
3371
|
|
|
@@ -3456,7 +3456,7 @@ lib/core/functions/sendPm2.md
|
|
|
3456
3456
|
|
|
3457
3457
|
# Function: sendPm2()
|
|
3458
3458
|
|
|
3459
|
-
> **sendPm2**(`name`, `action
|
|
3459
|
+
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`string`[]\>
|
|
3460
3460
|
|
|
3461
3461
|
Defined in: [lib/core.ts:573](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L573)
|
|
3462
3462
|
|
|
@@ -3470,7 +3470,7 @@ Defined in: [lib/core.ts:573](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3470
3470
|
|
|
3471
3471
|
PM2 进程名称
|
|
3472
3472
|
|
|
3473
|
-
### action
|
|
3473
|
+
### action?
|
|
3474
3474
|
|
|
3475
3475
|
[`TPm2Action`](../type-aliases/TPm2Action.md) = `'restart'`
|
|
3476
3476
|
|
|
@@ -3553,7 +3553,7 @@ lib/core/functions/setCookie.md
|
|
|
3553
3553
|
|
|
3554
3554
|
# Function: setCookie()
|
|
3555
3555
|
|
|
3556
|
-
> **setCookie**(`ctr`, `name`, `value`, `opt
|
|
3556
|
+
> **setCookie**(`ctr`, `name`, `value`, `opt?`): `void`
|
|
3557
3557
|
|
|
3558
3558
|
Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L50)
|
|
3559
3559
|
|
|
@@ -3579,7 +3579,7 @@ ctr 实例
|
|
|
3579
3579
|
|
|
3580
3580
|
值
|
|
3581
3581
|
|
|
3582
|
-
### opt
|
|
3582
|
+
### opt?
|
|
3583
3583
|
|
|
3584
3584
|
[`ICookieOptions`](../interfaces/ICookieOptions.md) = `{}`
|
|
3585
3585
|
|
|
@@ -4358,7 +4358,7 @@ lib/cron/functions/regular.md
|
|
|
4358
4358
|
|
|
4359
4359
|
# Function: regular()
|
|
4360
4360
|
|
|
4361
|
-
> **regular**(`task`, `immediate
|
|
4361
|
+
> **regular**(`task`, `immediate?`): `Promise`\<`boolean`\>
|
|
4362
4362
|
|
|
4363
4363
|
Defined in: [lib/cron.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L26)
|
|
4364
4364
|
|
|
@@ -4372,7 +4372,7 @@ Defined in: [lib/cron.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4372
4372
|
|
|
4373
4373
|
计划任务对象
|
|
4374
4374
|
|
|
4375
|
-
### immediate
|
|
4375
|
+
### immediate?
|
|
4376
4376
|
|
|
4377
4377
|
`string` = `''`
|
|
4378
4378
|
|
|
@@ -4868,7 +4868,7 @@ lib/crypto/functions/cipherDecrypt.md
|
|
|
4868
4868
|
|
|
4869
4869
|
# Function: cipherDecrypt()
|
|
4870
4870
|
|
|
4871
|
-
> **cipherDecrypt**(`encrypt`, `key`, `iv
|
|
4871
|
+
> **cipherDecrypt**(`encrypt`, `key`, `iv?`, `method?`, `output?`): `string` \| `false` \| `Buffer`\<`ArrayBufferLike`\>
|
|
4872
4872
|
|
|
4873
4873
|
Defined in: [lib/crypto.ts:280](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L280)
|
|
4874
4874
|
|
|
@@ -4888,19 +4888,19 @@ cipher 解密
|
|
|
4888
4888
|
|
|
4889
4889
|
密钥 32 个英文字母和数字
|
|
4890
4890
|
|
|
4891
|
-
### iv
|
|
4891
|
+
### iv?
|
|
4892
4892
|
|
|
4893
4893
|
`string` = `''`
|
|
4894
4894
|
|
|
4895
4895
|
向量 16(CTR) 或 12(GCM) 个英文字母和数字
|
|
4896
4896
|
|
|
4897
|
-
### method
|
|
4897
|
+
### method?
|
|
4898
4898
|
|
|
4899
4899
|
`string` = `AES_256_ECB`
|
|
4900
4900
|
|
|
4901
4901
|
加密方法
|
|
4902
4902
|
|
|
4903
|
-
### output
|
|
4903
|
+
### output?
|
|
4904
4904
|
|
|
4905
4905
|
输出类型
|
|
4906
4906
|
|
|
@@ -4921,7 +4921,7 @@ lib/crypto/functions/cipherEncrypt.md
|
|
|
4921
4921
|
|
|
4922
4922
|
# Function: cipherEncrypt()
|
|
4923
4923
|
|
|
4924
|
-
> **cipherEncrypt**(`original`, `key`, `iv
|
|
4924
|
+
> **cipherEncrypt**(`original`, `key`, `iv?`, `method?`, `output?`): `string` \| `false` \| `Buffer`\<`ArrayBufferLike`\>
|
|
4925
4925
|
|
|
4926
4926
|
Defined in: [lib/crypto.ts:167](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L167)
|
|
4927
4927
|
|
|
@@ -4941,19 +4941,19 @@ cipher 加密,强烈不建议使用 AES_256_ECB
|
|
|
4941
4941
|
|
|
4942
4942
|
密钥 32 个英文字母和数字
|
|
4943
4943
|
|
|
4944
|
-
### iv
|
|
4944
|
+
### iv?
|
|
4945
4945
|
|
|
4946
4946
|
`string` = `''`
|
|
4947
4947
|
|
|
4948
4948
|
向量 16(CTR) 或 12(GCM) 个英文字母和数字
|
|
4949
4949
|
|
|
4950
|
-
### method
|
|
4950
|
+
### method?
|
|
4951
4951
|
|
|
4952
4952
|
`string` = `AES_256_ECB`
|
|
4953
4953
|
|
|
4954
4954
|
加密方法
|
|
4955
4955
|
|
|
4956
|
-
### output
|
|
4956
|
+
### output?
|
|
4957
4957
|
|
|
4958
4958
|
输出类型
|
|
4959
4959
|
|
|
@@ -5124,7 +5124,7 @@ lib/crypto/functions/generateKeyPair.md
|
|
|
5124
5124
|
|
|
5125
5125
|
# Function: generateKeyPair()
|
|
5126
5126
|
|
|
5127
|
-
> **generateKeyPair**(`type`, `options
|
|
5127
|
+
> **generateKeyPair**(`type`, `options?`): `Promise`\<\{ `private`: `string` \| `Buffer`\<`ArrayBufferLike`\>; `public`: `string` \| `Buffer`\<`ArrayBufferLike`\>; \}\>
|
|
5128
5128
|
|
|
5129
5129
|
Defined in: [lib/crypto.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L18)
|
|
5130
5130
|
|
|
@@ -5138,7 +5138,7 @@ Defined in: [lib/crypto.ts:18](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
5138
5138
|
|
|
5139
5139
|
如 rsa/ec
|
|
5140
5140
|
|
|
5141
|
-
### options
|
|
5141
|
+
### options?
|
|
5142
5142
|
|
|
5143
5143
|
参数
|
|
5144
5144
|
|
|
@@ -5801,7 +5801,7 @@ lib/crypto/functions/verify.md
|
|
|
5801
5801
|
|
|
5802
5802
|
# Function: verify()
|
|
5803
5803
|
|
|
5804
|
-
> **verify**(`data`, `object`, `signature`, `algorithm
|
|
5804
|
+
> **verify**(`data`, `object`, `signature`, `algorithm?`): `boolean`
|
|
5805
5805
|
|
|
5806
5806
|
Defined in: [lib/crypto.ts:90](https://github.com/maiyunnet/kebab/blob/master/lib/crypto.ts#L90)
|
|
5807
5807
|
|
|
@@ -5827,7 +5827,7 @@ Defined in: [lib/crypto.ts:90](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
5827
5827
|
|
|
5828
5828
|
签名
|
|
5829
5829
|
|
|
5830
|
-
### algorithm
|
|
5830
|
+
### algorithm?
|
|
5831
5831
|
|
|
5832
5832
|
`string` = `'sha256'`
|
|
5833
5833
|
|
|
@@ -6161,7 +6161,7 @@ Defined in: [lib/db/conn.ts:73](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6161
6161
|
|
|
6162
6162
|
### isAvailable()
|
|
6163
6163
|
|
|
6164
|
-
> **isAvailable**(`last
|
|
6164
|
+
> **isAvailable**(`last?`): `Promise`\<`boolean`\>
|
|
6165
6165
|
|
|
6166
6166
|
Defined in: [lib/db/conn.ts:154](https://github.com/maiyunnet/kebab/blob/master/lib/db/conn.ts#L154)
|
|
6167
6167
|
|
|
@@ -6169,7 +6169,7 @@ Defined in: [lib/db/conn.ts:154](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
6169
6169
|
|
|
6170
6170
|
#### Parameters
|
|
6171
6171
|
|
|
6172
|
-
##### last
|
|
6172
|
+
##### last?
|
|
6173
6173
|
|
|
6174
6174
|
`boolean` = `true`
|
|
6175
6175
|
|
|
@@ -6374,7 +6374,7 @@ lib/db/functions/get.md
|
|
|
6374
6374
|
|
|
6375
6375
|
# Function: get()
|
|
6376
6376
|
|
|
6377
|
-
> **get**(`ctrEtc`, `opt
|
|
6377
|
+
> **get**(`ctrEtc`, `opt?`): [`Pool`](../pool/classes/Pool.md)
|
|
6378
6378
|
|
|
6379
6379
|
Defined in: [lib/db.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L68)
|
|
6380
6380
|
|
|
@@ -6388,7 +6388,7 @@ Defined in: [lib/db.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db
|
|
|
6388
6388
|
|
|
6389
6389
|
[`IConfigDb`](../../../index/interfaces/IConfigDb.md) | [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
6390
6390
|
|
|
6391
|
-
### opt
|
|
6391
|
+
### opt?
|
|
6392
6392
|
|
|
6393
6393
|
选项
|
|
6394
6394
|
|
|
@@ -6903,7 +6903,7 @@ Defined in: [lib/db/tran.ts:9](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
6903
6903
|
|
|
6904
6904
|
### Constructor
|
|
6905
6905
|
|
|
6906
|
-
> **new Transaction**(`ctr`, `conn`, `opts
|
|
6906
|
+
> **new Transaction**(`ctr`, `conn`, `opts?`): `Transaction`
|
|
6907
6907
|
|
|
6908
6908
|
Defined in: [lib/db/tran.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/db/tran.ts#L28)
|
|
6909
6909
|
|
|
@@ -6917,7 +6917,7 @@ Defined in: [lib/db/tran.ts:28](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6917
6917
|
|
|
6918
6918
|
[`Connection`](../../conn/classes/Connection.md)
|
|
6919
6919
|
|
|
6920
|
-
##### opts
|
|
6920
|
+
##### opts?
|
|
6921
6921
|
|
|
6922
6922
|
###### danger?
|
|
6923
6923
|
|
|
@@ -7664,7 +7664,7 @@ lib/fs/functions/copyFolder.md
|
|
|
7664
7664
|
|
|
7665
7665
|
# Function: copyFolder()
|
|
7666
7666
|
|
|
7667
|
-
> **copyFolder**(`from`, `to`, `ignore
|
|
7667
|
+
> **copyFolder**(`from`, `to`, `ignore?`): `Promise`\<`number`\>
|
|
7668
7668
|
|
|
7669
7669
|
Defined in: [lib/fs.ts:341](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L341)
|
|
7670
7670
|
|
|
@@ -7684,7 +7684,7 @@ Defined in: [lib/fs.ts:341](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
7684
7684
|
|
|
7685
7685
|
目标,末尾加 /
|
|
7686
7686
|
|
|
7687
|
-
### ignore
|
|
7687
|
+
### ignore?
|
|
7688
7688
|
|
|
7689
7689
|
`RegExp`[] = `[]`
|
|
7690
7690
|
|
|
@@ -7900,7 +7900,7 @@ lib/fs/functions/mkdir.md
|
|
|
7900
7900
|
|
|
7901
7901
|
# Function: mkdir()
|
|
7902
7902
|
|
|
7903
|
-
> **mkdir**(`path`, `mode
|
|
7903
|
+
> **mkdir**(`path`, `mode?`): `Promise`\<`boolean`\>
|
|
7904
7904
|
|
|
7905
7905
|
Defined in: [lib/fs.ts:207](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L207)
|
|
7906
7906
|
|
|
@@ -7914,7 +7914,7 @@ Defined in: [lib/fs.ts:207](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
7914
7914
|
|
|
7915
7915
|
要创建的路径,如 /a/b/c/
|
|
7916
7916
|
|
|
7917
|
-
### mode
|
|
7917
|
+
### mode?
|
|
7918
7918
|
|
|
7919
7919
|
`number` = `0o755`
|
|
7920
7920
|
|
|
@@ -7978,7 +7978,7 @@ lib/fs/functions/putContent.md
|
|
|
7978
7978
|
|
|
7979
7979
|
# Function: putContent()
|
|
7980
7980
|
|
|
7981
|
-
> **putContent**(`path`, `data`, `options
|
|
7981
|
+
> **putContent**(`path`, `data`, `options?`): `Promise`\<`boolean`\>
|
|
7982
7982
|
|
|
7983
7983
|
Defined in: [lib/fs.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/fs.ts#L93)
|
|
7984
7984
|
|
|
@@ -7998,7 +7998,7 @@ Defined in: [lib/fs.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/fs
|
|
|
7998
7998
|
|
|
7999
7999
|
`string` | `Buffer`\<`ArrayBufferLike`\>
|
|
8000
8000
|
|
|
8001
|
-
### options
|
|
8001
|
+
### options?
|
|
8002
8002
|
|
|
8003
8003
|
选项
|
|
8004
8004
|
|
|
@@ -8406,7 +8406,7 @@ Defined in: [lib/kv.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/kv
|
|
|
8406
8406
|
|
|
8407
8407
|
### add()
|
|
8408
8408
|
|
|
8409
|
-
> **add**(`key`, `val`, `ttl
|
|
8409
|
+
> **add**(`key`, `val`, `ttl?`): `Promise`\<`boolean`\>
|
|
8410
8410
|
|
|
8411
8411
|
Defined in: [lib/kv.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L115)
|
|
8412
8412
|
|
|
@@ -8422,7 +8422,7 @@ Defined in: [lib/kv.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8422
8422
|
|
|
8423
8423
|
`string` | `number` | `object`
|
|
8424
8424
|
|
|
8425
|
-
##### ttl
|
|
8425
|
+
##### ttl?
|
|
8426
8426
|
|
|
8427
8427
|
`number` = `0`
|
|
8428
8428
|
|
|
@@ -8520,7 +8520,7 @@ Defined in: [lib/kv.ts:780](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8520
8520
|
|
|
8521
8521
|
### decr()
|
|
8522
8522
|
|
|
8523
|
-
> **decr**(`key`, `num
|
|
8523
|
+
> **decr**(`key`, `num?`): `Promise`\<`number` \| `false`\>
|
|
8524
8524
|
|
|
8525
8525
|
Defined in: [lib/kv.ts:387](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L387)
|
|
8526
8526
|
|
|
@@ -8532,7 +8532,7 @@ Defined in: [lib/kv.ts:387](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8532
8532
|
|
|
8533
8533
|
`string`
|
|
8534
8534
|
|
|
8535
|
-
##### num
|
|
8535
|
+
##### num?
|
|
8536
8536
|
|
|
8537
8537
|
`number` = `1`
|
|
8538
8538
|
|
|
@@ -8892,7 +8892,7 @@ key / val 数组
|
|
|
8892
8892
|
|
|
8893
8893
|
### hSet()
|
|
8894
8894
|
|
|
8895
|
-
> **hSet**(`key`, `field`, `val`, `mod
|
|
8895
|
+
> **hSet**(`key`, `field`, `val`, `mod?`): `Promise`\<`boolean`\>
|
|
8896
8896
|
|
|
8897
8897
|
Defined in: [lib/kv.ts:519](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L519)
|
|
8898
8898
|
|
|
@@ -8918,7 +8918,7 @@ key 名
|
|
|
8918
8918
|
|
|
8919
8919
|
`string` | `number` | `object`
|
|
8920
8920
|
|
|
8921
|
-
##### mod
|
|
8921
|
+
##### mod?
|
|
8922
8922
|
|
|
8923
8923
|
空,nx(key不存在才建立)
|
|
8924
8924
|
|
|
@@ -8932,7 +8932,7 @@ key 名
|
|
|
8932
8932
|
|
|
8933
8933
|
### incr()
|
|
8934
8934
|
|
|
8935
|
-
> **incr**(`key`, `num
|
|
8935
|
+
> **incr**(`key`, `num?`): `Promise`\<`number` \| `false`\>
|
|
8936
8936
|
|
|
8937
8937
|
Defined in: [lib/kv.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L359)
|
|
8938
8938
|
|
|
@@ -8944,7 +8944,7 @@ Defined in: [lib/kv.ts:359](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8944
8944
|
|
|
8945
8945
|
`string`
|
|
8946
8946
|
|
|
8947
|
-
##### num
|
|
8947
|
+
##### num?
|
|
8948
8948
|
|
|
8949
8949
|
`number` = `1`
|
|
8950
8950
|
|
|
@@ -9180,7 +9180,7 @@ Defined in: [lib/kv.ts:252](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9180
9180
|
|
|
9181
9181
|
### replace()
|
|
9182
9182
|
|
|
9183
|
-
> **replace**(`key`, `val`, `ttl
|
|
9183
|
+
> **replace**(`key`, `val`, `ttl?`): `Promise`\<`boolean`\>
|
|
9184
9184
|
|
|
9185
9185
|
Defined in: [lib/kv.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L129)
|
|
9186
9186
|
|
|
@@ -9200,7 +9200,7 @@ Defined in: [lib/kv.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9200
9200
|
|
|
9201
9201
|
`string` | `number` | `object`
|
|
9202
9202
|
|
|
9203
|
-
##### ttl
|
|
9203
|
+
##### ttl?
|
|
9204
9204
|
|
|
9205
9205
|
`number` = `0`
|
|
9206
9206
|
|
|
@@ -9254,7 +9254,7 @@ Defined in: [lib/kv.ts:728](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9254
9254
|
|
|
9255
9255
|
### scan()
|
|
9256
9256
|
|
|
9257
|
-
> **scan**(`cursor
|
|
9257
|
+
> **scan**(`cursor?`, `pattern?`, `count?`): `Promise`\<`false` \| `IScanResult`\<`string`\>\>
|
|
9258
9258
|
|
|
9259
9259
|
Defined in: [lib/kv.ts:458](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L458)
|
|
9260
9260
|
|
|
@@ -9262,17 +9262,17 @@ Defined in: [lib/kv.ts:458](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9262
9262
|
|
|
9263
9263
|
#### Parameters
|
|
9264
9264
|
|
|
9265
|
-
##### cursor
|
|
9265
|
+
##### cursor?
|
|
9266
9266
|
|
|
9267
9267
|
`number` = `0`
|
|
9268
9268
|
|
|
9269
|
-
##### pattern
|
|
9269
|
+
##### pattern?
|
|
9270
9270
|
|
|
9271
9271
|
`string` = `'*'`
|
|
9272
9272
|
|
|
9273
9273
|
例如 *
|
|
9274
9274
|
|
|
9275
|
-
##### count
|
|
9275
|
+
##### count?
|
|
9276
9276
|
|
|
9277
9277
|
`number` = `10`
|
|
9278
9278
|
|
|
@@ -9286,7 +9286,7 @@ Defined in: [lib/kv.ts:458](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9286
9286
|
|
|
9287
9287
|
### set()
|
|
9288
9288
|
|
|
9289
|
-
> **set**(`key`, `val`, `ttl
|
|
9289
|
+
> **set**(`key`, `val`, `ttl?`, `mod?`): `Promise`\<`boolean`\>
|
|
9290
9290
|
|
|
9291
9291
|
Defined in: [lib/kv.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L83)
|
|
9292
9292
|
|
|
@@ -9302,13 +9302,13 @@ Defined in: [lib/kv.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/kv
|
|
|
9302
9302
|
|
|
9303
9303
|
`string` | `number` | `object`
|
|
9304
9304
|
|
|
9305
|
-
##### ttl
|
|
9305
|
+
##### ttl?
|
|
9306
9306
|
|
|
9307
9307
|
`number` = `0`
|
|
9308
9308
|
|
|
9309
9309
|
秒,0 为不限制
|
|
9310
9310
|
|
|
9311
|
-
##### mod
|
|
9311
|
+
##### mod?
|
|
9312
9312
|
|
|
9313
9313
|
设置模式: 空,nx(key不存在才建立),xx(key存在才修改)
|
|
9314
9314
|
|
|
@@ -10202,7 +10202,7 @@ lib/net/functions/fetch.md
|
|
|
10202
10202
|
|
|
10203
10203
|
# Function: fetch()
|
|
10204
10204
|
|
|
10205
|
-
> **fetch**(`input`, `init
|
|
10205
|
+
> **fetch**(`input`, `init?`): `Promise`\<`Response`\>
|
|
10206
10206
|
|
|
10207
10207
|
Defined in: [lib/net.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L131)
|
|
10208
10208
|
|
|
@@ -10216,7 +10216,7 @@ Defined in: [lib/net.ts:131](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10216
10216
|
|
|
10217
10217
|
`string` | `Request` | `URL`
|
|
10218
10218
|
|
|
10219
|
-
### init
|
|
10219
|
+
### init?
|
|
10220
10220
|
|
|
10221
10221
|
`RequestInit` & `object` = `{}`
|
|
10222
10222
|
|
|
@@ -10278,7 +10278,7 @@ lib/net/functions/get.md
|
|
|
10278
10278
|
|
|
10279
10279
|
# Function: get()
|
|
10280
10280
|
|
|
10281
|
-
> **get**(`u`, `opt
|
|
10281
|
+
> **get**(`u`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
10282
10282
|
|
|
10283
10283
|
Defined in: [lib/net.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L67)
|
|
10284
10284
|
|
|
@@ -10292,7 +10292,7 @@ Defined in: [lib/net.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/n
|
|
|
10292
10292
|
|
|
10293
10293
|
请求的 URL
|
|
10294
10294
|
|
|
10295
|
-
### opt
|
|
10295
|
+
### opt?
|
|
10296
10296
|
|
|
10297
10297
|
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
10298
10298
|
|
|
@@ -10355,7 +10355,7 @@ lib/net/functions/mproxy.md
|
|
|
10355
10355
|
|
|
10356
10356
|
# Function: mproxy()
|
|
10357
10357
|
|
|
10358
|
-
> **mproxy**(`ctr`, `auth`, `opt
|
|
10358
|
+
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
10359
10359
|
|
|
10360
10360
|
Defined in: [lib/net.ts:718](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L718)
|
|
10361
10361
|
|
|
@@ -10376,7 +10376,7 @@ get: url, auth
|
|
|
10376
10376
|
|
|
10377
10377
|
校验字符串,读取 get 的 auth 和本参数做比对
|
|
10378
10378
|
|
|
10379
|
-
### opt
|
|
10379
|
+
### opt?
|
|
10380
10380
|
|
|
10381
10381
|
[`IMproxyOptions`](../interfaces/IMproxyOptions.md) = `{}`
|
|
10382
10382
|
|
|
@@ -10453,7 +10453,7 @@ lib/net/functions/post.md
|
|
|
10453
10453
|
|
|
10454
10454
|
# Function: post()
|
|
10455
10455
|
|
|
10456
|
-
> **post**(`u`, `data`, `opt
|
|
10456
|
+
> **post**(`u`, `data`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
10457
10457
|
|
|
10458
10458
|
Defined in: [lib/net.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L77)
|
|
10459
10459
|
|
|
@@ -10473,7 +10473,7 @@ Defined in: [lib/net.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/n
|
|
|
10473
10473
|
|
|
10474
10474
|
`string` | `Record`\<`string`, `any`\> | `Buffer`\<`ArrayBufferLike`\> | `Readable`
|
|
10475
10475
|
|
|
10476
|
-
### opt
|
|
10476
|
+
### opt?
|
|
10477
10477
|
|
|
10478
10478
|
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
10479
10479
|
|
|
@@ -10494,7 +10494,7 @@ lib/net/functions/postJson.md
|
|
|
10494
10494
|
|
|
10495
10495
|
# Function: postJson()
|
|
10496
10496
|
|
|
10497
|
-
> **postJson**(`u`, `data`, `opt
|
|
10497
|
+
> **postJson**(`u`, `data`, `opt?`): `Promise`\<[`Response`](../response/classes/Response.md)\>
|
|
10498
10498
|
|
|
10499
10499
|
Defined in: [lib/net.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L92)
|
|
10500
10500
|
|
|
@@ -10514,7 +10514,7 @@ Defined in: [lib/net.ts:92](https://github.com/maiyunnet/kebab/blob/master/lib/n
|
|
|
10514
10514
|
|
|
10515
10515
|
`any`[] | `Record`\<`string`, `any`\>
|
|
10516
10516
|
|
|
10517
|
-
### opt
|
|
10517
|
+
### opt?
|
|
10518
10518
|
|
|
10519
10519
|
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
10520
10520
|
|
|
@@ -10535,7 +10535,7 @@ lib/net/functions/postJsonResponseJson.md
|
|
|
10535
10535
|
|
|
10536
10536
|
# Function: postJsonResponseJson()
|
|
10537
10537
|
|
|
10538
|
-
> **postJsonResponseJson**(`u`, `data`, `opt
|
|
10538
|
+
> **postJsonResponseJson**(`u`, `data`, `opt?`): `Promise`\<`any`\>
|
|
10539
10539
|
|
|
10540
10540
|
Defined in: [lib/net.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L109)
|
|
10541
10541
|
|
|
@@ -10555,7 +10555,7 @@ Defined in: [lib/net.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10555
10555
|
|
|
10556
10556
|
`any`[] | `Record`\<`string`, `any`\>
|
|
10557
10557
|
|
|
10558
|
-
### opt
|
|
10558
|
+
### opt?
|
|
10559
10559
|
|
|
10560
10560
|
[`IRequestOptions`](../interfaces/IRequestOptions.md) = `{}`
|
|
10561
10561
|
|
|
@@ -10644,7 +10644,7 @@ lib/net/functions/rproxy.md
|
|
|
10644
10644
|
|
|
10645
10645
|
# Function: rproxy()
|
|
10646
10646
|
|
|
10647
|
-
> **rproxy**(`ctr`, `route`, `opt
|
|
10647
|
+
> **rproxy**(`ctr`, `route`, `opt?`): `Promise`\<`boolean`\>
|
|
10648
10648
|
|
|
10649
10649
|
Defined in: [lib/net.ts:785](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L785)
|
|
10650
10650
|
|
|
@@ -10664,7 +10664,7 @@ Defined in: [lib/net.ts:785](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10664
10664
|
|
|
10665
10665
|
要反代的路由
|
|
10666
10666
|
|
|
10667
|
-
### opt
|
|
10667
|
+
### opt?
|
|
10668
10668
|
|
|
10669
10669
|
[`IRproxyOptions`](../interfaces/IRproxyOptions.md) = `{}`
|
|
10670
10670
|
|
|
@@ -10685,7 +10685,7 @@ lib/net/functions/setCookie.md
|
|
|
10685
10685
|
|
|
10686
10686
|
# Function: setCookie()
|
|
10687
10687
|
|
|
10688
|
-
> **setCookie**(`cookie`, `name`, `value`, `domain`, `opt
|
|
10688
|
+
> **setCookie**(`cookie`, `name`, `value`, `domain`, `opt?`): `void`
|
|
10689
10689
|
|
|
10690
10690
|
Defined in: [lib/net.ts:466](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L466)
|
|
10691
10691
|
|
|
@@ -10717,7 +10717,7 @@ Defined in: [lib/net.ts:466](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10717
10717
|
|
|
10718
10718
|
应用网址,如 .xxx.com
|
|
10719
10719
|
|
|
10720
|
-
### opt
|
|
10720
|
+
### opt?
|
|
10721
10721
|
|
|
10722
10722
|
选项 ttl, path, ssl, httponly
|
|
10723
10723
|
|
|
@@ -11249,7 +11249,7 @@ Defined in: [lib/net/request.ts:29](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11249
11249
|
|
|
11250
11250
|
### follow()
|
|
11251
11251
|
|
|
11252
|
-
> **follow**(`follow
|
|
11252
|
+
> **follow**(`follow?`): `this`
|
|
11253
11253
|
|
|
11254
11254
|
Defined in: [lib/net/request.ts:86](https://github.com/maiyunnet/kebab/blob/master/lib/net/request.ts#L86)
|
|
11255
11255
|
|
|
@@ -11257,7 +11257,7 @@ Defined in: [lib/net/request.ts:86](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11257
11257
|
|
|
11258
11258
|
#### Parameters
|
|
11259
11259
|
|
|
11260
|
-
##### follow
|
|
11260
|
+
##### follow?
|
|
11261
11261
|
|
|
11262
11262
|
`number` = `5`
|
|
11263
11263
|
|
|
@@ -12274,7 +12274,7 @@ lib/scan/functions/scanned.md
|
|
|
12274
12274
|
|
|
12275
12275
|
# Function: scanned()
|
|
12276
12276
|
|
|
12277
|
-
> **scanned**(`link`, `token`, `opt
|
|
12277
|
+
> **scanned**(`link`, `token`, `opt?`): `Promise`\<`boolean`\>
|
|
12278
12278
|
|
|
12279
12279
|
Defined in: [lib/scan.ts:265](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L265)
|
|
12280
12280
|
|
|
@@ -12294,7 +12294,7 @@ Db 或 Kv
|
|
|
12294
12294
|
|
|
12295
12295
|
必填
|
|
12296
12296
|
|
|
12297
|
-
### opt
|
|
12297
|
+
### opt?
|
|
12298
12298
|
|
|
12299
12299
|
[`IStaticOptions`](../interfaces/IStaticOptions.md) = `{}`
|
|
12300
12300
|
|
|
@@ -12315,7 +12315,7 @@ lib/scan/functions/setData.md
|
|
|
12315
12315
|
|
|
12316
12316
|
# Function: setData()
|
|
12317
12317
|
|
|
12318
|
-
> **setData**(`link`, `token`, `data`, `opt
|
|
12318
|
+
> **setData**(`link`, `token`, `data`, `opt?`): `Promise`\<`boolean`\>
|
|
12319
12319
|
|
|
12320
12320
|
Defined in: [lib/scan.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L323)
|
|
12321
12321
|
|
|
@@ -12335,7 +12335,7 @@ Defined in: [lib/scan.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
12335
12335
|
|
|
12336
12336
|
`string` | `number` | `Record`\<`string`, `any`\>
|
|
12337
12337
|
|
|
12338
|
-
### opt
|
|
12338
|
+
### opt?
|
|
12339
12339
|
|
|
12340
12340
|
[`IStaticOptions`](../interfaces/IStaticOptions.md) = `{}`
|
|
12341
12341
|
|
|
@@ -12510,7 +12510,7 @@ Defined in: [lib/session.ts:194](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
12510
12510
|
|
|
12511
12511
|
### init()
|
|
12512
12512
|
|
|
12513
|
-
> **init**(`ctr`, `link`, `auth
|
|
12513
|
+
> **init**(`ctr`, `link`, `auth?`, `opt?`): `Promise`\<`boolean`\>
|
|
12514
12514
|
|
|
12515
12515
|
Defined in: [lib/session.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L65)
|
|
12516
12516
|
|
|
@@ -12530,13 +12530,13 @@ Kv 或 Db 实例
|
|
|
12530
12530
|
|
|
12531
12531
|
[`Pool`](../../db/pool/classes/Pool.md) | [`Kv`](../../kv/classes/Kv.md)
|
|
12532
12532
|
|
|
12533
|
-
##### auth
|
|
12533
|
+
##### auth?
|
|
12534
12534
|
|
|
12535
12535
|
`boolean` = `false`
|
|
12536
12536
|
|
|
12537
12537
|
设为 true 则优先从头 Authorization 或 post _auth 值读取 token
|
|
12538
12538
|
|
|
12539
|
-
##### opt
|
|
12539
|
+
##### opt?
|
|
12540
12540
|
|
|
12541
12541
|
[`IOptions`](../interfaces/IOptions.md) = `{}`
|
|
12542
12542
|
|
|
@@ -12637,7 +12637,7 @@ lib/socket/functions/rwebsocket.md
|
|
|
12637
12637
|
|
|
12638
12638
|
# Function: rwebsocket()
|
|
12639
12639
|
|
|
12640
|
-
> **rwebsocket**(`port`, `url`, `opt
|
|
12640
|
+
> **rwebsocket**(`port`, `url`, `opt?`): `Server`
|
|
12641
12641
|
|
|
12642
12642
|
Defined in: [lib/socket.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L37)
|
|
12643
12643
|
|
|
@@ -12657,7 +12657,7 @@ Defined in: [lib/socket.ts:37](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
12657
12657
|
|
|
12658
12658
|
反代到的 WebSocket
|
|
12659
12659
|
|
|
12660
|
-
### opt
|
|
12660
|
+
### opt?
|
|
12661
12661
|
|
|
12662
12662
|
[`IRwebsocketOptions`](../interfaces/IRwebsocketOptions.md) = `{}`
|
|
12663
12663
|
|
|
@@ -12854,7 +12854,7 @@ Defined in: [lib/sql.ts:860](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12854
12854
|
|
|
12855
12855
|
### by()
|
|
12856
12856
|
|
|
12857
|
-
> **by**(`c`, `d
|
|
12857
|
+
> **by**(`c`, `d?`): `this`
|
|
12858
12858
|
|
|
12859
12859
|
Defined in: [lib/sql.ts:661](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L661)
|
|
12860
12860
|
|
|
@@ -12868,7 +12868,7 @@ ORDER BY
|
|
|
12868
12868
|
|
|
12869
12869
|
`string` | (`string` \| `string`[])[]
|
|
12870
12870
|
|
|
12871
|
-
##### d
|
|
12871
|
+
##### d?
|
|
12872
12872
|
|
|
12873
12873
|
排序规则
|
|
12874
12874
|
|
|
@@ -12910,7 +12910,7 @@ Defined in: [lib/sql.ts:729](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12910
12910
|
|
|
12911
12911
|
### crossJoin()
|
|
12912
12912
|
|
|
12913
|
-
> **crossJoin**(`f`, `s
|
|
12913
|
+
> **crossJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
12914
12914
|
|
|
12915
12915
|
Defined in: [lib/sql.ts:416](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L416)
|
|
12916
12916
|
|
|
@@ -12924,19 +12924,19 @@ cross join 方法
|
|
|
12924
12924
|
|
|
12925
12925
|
表名
|
|
12926
12926
|
|
|
12927
|
-
##### s
|
|
12927
|
+
##### s?
|
|
12928
12928
|
|
|
12929
12929
|
`any` = `[]`
|
|
12930
12930
|
|
|
12931
12931
|
ON 信息
|
|
12932
12932
|
|
|
12933
|
-
##### suf
|
|
12933
|
+
##### suf?
|
|
12934
12934
|
|
|
12935
12935
|
`string` = `''`
|
|
12936
12936
|
|
|
12937
12937
|
表后缀
|
|
12938
12938
|
|
|
12939
|
-
##### pre
|
|
12939
|
+
##### pre?
|
|
12940
12940
|
|
|
12941
12941
|
`string` = `''`
|
|
12942
12942
|
|
|
@@ -12972,7 +12972,7 @@ Defined in: [lib/sql.ts:311](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12972
12972
|
|
|
12973
12973
|
### field()
|
|
12974
12974
|
|
|
12975
|
-
> **field**(`str`, `pre
|
|
12975
|
+
> **field**(`str`, `pre?`, `suf?`): `string`
|
|
12976
12976
|
|
|
12977
12977
|
Defined in: [lib/sql.ts:871](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L871)
|
|
12978
12978
|
|
|
@@ -12984,13 +12984,13 @@ Defined in: [lib/sql.ts:871](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12984
12984
|
|
|
12985
12985
|
`string` | `number` | (`string` \| `string`[])[]
|
|
12986
12986
|
|
|
12987
|
-
##### pre
|
|
12987
|
+
##### pre?
|
|
12988
12988
|
|
|
12989
12989
|
`string` = `''`
|
|
12990
12990
|
|
|
12991
12991
|
表前缀,仅请在 field 表名时倒入前缀
|
|
12992
12992
|
|
|
12993
|
-
##### suf
|
|
12993
|
+
##### suf?
|
|
12994
12994
|
|
|
12995
12995
|
`string` = `''`
|
|
12996
12996
|
|
|
@@ -13028,7 +13028,7 @@ Defined in: [lib/sql.ts:850](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13028
13028
|
|
|
13029
13029
|
### fullJoin()
|
|
13030
13030
|
|
|
13031
|
-
> **fullJoin**(`f`, `s
|
|
13031
|
+
> **fullJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
13032
13032
|
|
|
13033
13033
|
Defined in: [lib/sql.ts:405](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L405)
|
|
13034
13034
|
|
|
@@ -13042,19 +13042,19 @@ full join 方法
|
|
|
13042
13042
|
|
|
13043
13043
|
表名
|
|
13044
13044
|
|
|
13045
|
-
##### s
|
|
13045
|
+
##### s?
|
|
13046
13046
|
|
|
13047
13047
|
`any` = `[]`
|
|
13048
13048
|
|
|
13049
13049
|
ON 信息
|
|
13050
13050
|
|
|
13051
|
-
##### suf
|
|
13051
|
+
##### suf?
|
|
13052
13052
|
|
|
13053
13053
|
`string` = `''`
|
|
13054
13054
|
|
|
13055
13055
|
表后缀
|
|
13056
13056
|
|
|
13057
|
-
##### pre
|
|
13057
|
+
##### pre?
|
|
13058
13058
|
|
|
13059
13059
|
`string` = `''`
|
|
13060
13060
|
|
|
@@ -13132,7 +13132,7 @@ GROUP BY
|
|
|
13132
13132
|
|
|
13133
13133
|
### having()
|
|
13134
13134
|
|
|
13135
|
-
> **having**(`s
|
|
13135
|
+
> **having**(`s?`): `this`
|
|
13136
13136
|
|
|
13137
13137
|
Defined in: [lib/sql.ts:423](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L423)
|
|
13138
13138
|
|
|
@@ -13140,7 +13140,7 @@ having 后置筛选器,用法类似 where
|
|
|
13140
13140
|
|
|
13141
13141
|
#### Parameters
|
|
13142
13142
|
|
|
13143
|
-
##### s
|
|
13143
|
+
##### s?
|
|
13144
13144
|
|
|
13145
13145
|
`any` = `''`
|
|
13146
13146
|
|
|
@@ -13152,7 +13152,7 @@ having 后置筛选器,用法类似 where
|
|
|
13152
13152
|
|
|
13153
13153
|
### innerJoin()
|
|
13154
13154
|
|
|
13155
|
-
> **innerJoin**(`f`, `s
|
|
13155
|
+
> **innerJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
13156
13156
|
|
|
13157
13157
|
Defined in: [lib/sql.ts:394](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L394)
|
|
13158
13158
|
|
|
@@ -13166,19 +13166,19 @@ inner join 方法
|
|
|
13166
13166
|
|
|
13167
13167
|
表名
|
|
13168
13168
|
|
|
13169
|
-
##### s
|
|
13169
|
+
##### s?
|
|
13170
13170
|
|
|
13171
13171
|
`any` = `[]`
|
|
13172
13172
|
|
|
13173
13173
|
ON 信息
|
|
13174
13174
|
|
|
13175
|
-
##### suf
|
|
13175
|
+
##### suf?
|
|
13176
13176
|
|
|
13177
13177
|
`string` = `''`
|
|
13178
13178
|
|
|
13179
13179
|
表后缀
|
|
13180
13180
|
|
|
13181
|
-
##### pre
|
|
13181
|
+
##### pre?
|
|
13182
13182
|
|
|
13183
13183
|
`string` = `''`
|
|
13184
13184
|
|
|
@@ -13192,7 +13192,7 @@ ON 信息
|
|
|
13192
13192
|
|
|
13193
13193
|
### insert()
|
|
13194
13194
|
|
|
13195
|
-
> **insert**(`table`, `ignore
|
|
13195
|
+
> **insert**(`table`, `ignore?`): `this`
|
|
13196
13196
|
|
|
13197
13197
|
Defined in: [lib/sql.ts:91](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L91)
|
|
13198
13198
|
|
|
@@ -13206,7 +13206,7 @@ Defined in: [lib/sql.ts:91](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
13206
13206
|
|
|
13207
13207
|
表名
|
|
13208
13208
|
|
|
13209
|
-
##### ignore
|
|
13209
|
+
##### ignore?
|
|
13210
13210
|
|
|
13211
13211
|
`boolean` = `false`
|
|
13212
13212
|
|
|
@@ -13220,7 +13220,7 @@ Defined in: [lib/sql.ts:91](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
13220
13220
|
|
|
13221
13221
|
### join()
|
|
13222
13222
|
|
|
13223
|
-
> **join**(`f`, `s
|
|
13223
|
+
> **join**(`f`, `s?`, `type?`, `suf?`, `pre?`): `this`
|
|
13224
13224
|
|
|
13225
13225
|
Defined in: [lib/sql.ts:346](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L346)
|
|
13226
13226
|
|
|
@@ -13234,25 +13234,25 @@ join 方法
|
|
|
13234
13234
|
|
|
13235
13235
|
表名
|
|
13236
13236
|
|
|
13237
|
-
##### s
|
|
13237
|
+
##### s?
|
|
13238
13238
|
|
|
13239
13239
|
`any` = `[]`
|
|
13240
13240
|
|
|
13241
13241
|
ON 信息
|
|
13242
13242
|
|
|
13243
|
-
##### type
|
|
13243
|
+
##### type?
|
|
13244
13244
|
|
|
13245
13245
|
`string` = `'INNER'`
|
|
13246
13246
|
|
|
13247
13247
|
类型
|
|
13248
13248
|
|
|
13249
|
-
##### suf
|
|
13249
|
+
##### suf?
|
|
13250
13250
|
|
|
13251
13251
|
`string` = `''`
|
|
13252
13252
|
|
|
13253
13253
|
表后缀
|
|
13254
13254
|
|
|
13255
|
-
##### pre
|
|
13255
|
+
##### pre?
|
|
13256
13256
|
|
|
13257
13257
|
`string` = `''`
|
|
13258
13258
|
|
|
@@ -13266,7 +13266,7 @@ ON 信息
|
|
|
13266
13266
|
|
|
13267
13267
|
### leftJoin()
|
|
13268
13268
|
|
|
13269
|
-
> **leftJoin**(`f`, `s
|
|
13269
|
+
> **leftJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
13270
13270
|
|
|
13271
13271
|
Defined in: [lib/sql.ts:372](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L372)
|
|
13272
13272
|
|
|
@@ -13280,19 +13280,19 @@ left join 方法
|
|
|
13280
13280
|
|
|
13281
13281
|
表名
|
|
13282
13282
|
|
|
13283
|
-
##### s
|
|
13283
|
+
##### s?
|
|
13284
13284
|
|
|
13285
13285
|
`any` = `[]`
|
|
13286
13286
|
|
|
13287
13287
|
ON 信息
|
|
13288
13288
|
|
|
13289
|
-
##### suf
|
|
13289
|
+
##### suf?
|
|
13290
13290
|
|
|
13291
13291
|
`string` = `''`
|
|
13292
13292
|
|
|
13293
13293
|
表后缀
|
|
13294
13294
|
|
|
13295
|
-
##### pre
|
|
13295
|
+
##### pre?
|
|
13296
13296
|
|
|
13297
13297
|
`string` = `''`
|
|
13298
13298
|
|
|
@@ -13306,7 +13306,7 @@ ON 信息
|
|
|
13306
13306
|
|
|
13307
13307
|
### limit()
|
|
13308
13308
|
|
|
13309
|
-
> **limit**(`a`, `b
|
|
13309
|
+
> **limit**(`a`, `b?`): `this`
|
|
13310
13310
|
|
|
13311
13311
|
Defined in: [lib/sql.ts:705](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L705)
|
|
13312
13312
|
|
|
@@ -13320,7 +13320,7 @@ LIMIT(limit、offset, limit)
|
|
|
13320
13320
|
|
|
13321
13321
|
起始(offset)
|
|
13322
13322
|
|
|
13323
|
-
##### b
|
|
13323
|
+
##### b?
|
|
13324
13324
|
|
|
13325
13325
|
`number` = `0`
|
|
13326
13326
|
|
|
@@ -13348,7 +13348,7 @@ Defined in: [lib/sql.ts:720](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13348
13348
|
|
|
13349
13349
|
### rightJoin()
|
|
13350
13350
|
|
|
13351
|
-
> **rightJoin**(`f`, `s
|
|
13351
|
+
> **rightJoin**(`f`, `s?`, `suf?`, `pre?`): `this`
|
|
13352
13352
|
|
|
13353
13353
|
Defined in: [lib/sql.ts:383](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L383)
|
|
13354
13354
|
|
|
@@ -13362,19 +13362,19 @@ right join 方法
|
|
|
13362
13362
|
|
|
13363
13363
|
表名
|
|
13364
13364
|
|
|
13365
|
-
##### s
|
|
13365
|
+
##### s?
|
|
13366
13366
|
|
|
13367
13367
|
`any` = `[]`
|
|
13368
13368
|
|
|
13369
13369
|
ON 信息
|
|
13370
13370
|
|
|
13371
|
-
##### suf
|
|
13371
|
+
##### suf?
|
|
13372
13372
|
|
|
13373
13373
|
`string` = `''`
|
|
13374
13374
|
|
|
13375
13375
|
表后缀
|
|
13376
13376
|
|
|
13377
|
-
##### pre
|
|
13377
|
+
##### pre?
|
|
13378
13378
|
|
|
13379
13379
|
`string` = `''`
|
|
13380
13380
|
|
|
@@ -13416,7 +13416,7 @@ Defined in: [lib/sql.ts:202](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13416
13416
|
|
|
13417
13417
|
### union()
|
|
13418
13418
|
|
|
13419
|
-
> **union**(`lsql`, `type
|
|
13419
|
+
> **union**(`lsql`, `type?`): `this`
|
|
13420
13420
|
|
|
13421
13421
|
Defined in: [lib/sql.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L323)
|
|
13422
13422
|
|
|
@@ -13430,7 +13430,7 @@ Defined in: [lib/sql.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13430
13430
|
|
|
13431
13431
|
sql 对象
|
|
13432
13432
|
|
|
13433
|
-
##### type
|
|
13433
|
+
##### type?
|
|
13434
13434
|
|
|
13435
13435
|
`string` = `''`
|
|
13436
13436
|
|
|
@@ -13522,7 +13522,7 @@ Defined in: [lib/sql.ts:168](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13522
13522
|
|
|
13523
13523
|
### values()
|
|
13524
13524
|
|
|
13525
|
-
> **values**(`cs`, `vs
|
|
13525
|
+
> **values**(`cs`, `vs?`): `this`
|
|
13526
13526
|
|
|
13527
13527
|
Defined in: [lib/sql.ts:110](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L110)
|
|
13528
13528
|
|
|
@@ -13536,7 +13536,7 @@ Defined in: [lib/sql.ts:110](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13536
13536
|
|
|
13537
13537
|
`string`[] | `Record`\<`string`, [`DbValue`](../../../index/type-aliases/DbValue.md)\>
|
|
13538
13538
|
|
|
13539
|
-
##### vs
|
|
13539
|
+
##### vs?
|
|
13540
13540
|
|
|
13541
13541
|
[] | [][] 数据
|
|
13542
13542
|
|
|
@@ -13761,7 +13761,7 @@ lib/sql/functions/format.md
|
|
|
13761
13761
|
|
|
13762
13762
|
# Function: format()
|
|
13763
13763
|
|
|
13764
|
-
> **format**(`sql`, `data`, `service
|
|
13764
|
+
> **format**(`sql`, `data`, `service?`): `string`
|
|
13765
13765
|
|
|
13766
13766
|
Defined in: [lib/sql.ts:1154](https://github.com/maiyunnet/kebab/blob/master/lib/sql.ts#L1154)
|
|
13767
13767
|
|
|
@@ -13781,7 +13781,7 @@ SQL 字符串
|
|
|
13781
13781
|
|
|
13782
13782
|
DATA 数据
|
|
13783
13783
|
|
|
13784
|
-
### service
|
|
13784
|
+
### service?
|
|
13785
13785
|
|
|
13786
13786
|
[`ESERVICE`](../enumerations/ESERVICE.md) = `ESERVICE.MYSQL`
|
|
13787
13787
|
|
|
@@ -14239,7 +14239,7 @@ Defined in: [lib/ssh/sftp.ts:418](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14239
14239
|
|
|
14240
14240
|
### downloadFile()
|
|
14241
14241
|
|
|
14242
|
-
> **downloadFile**(`remoteFile`, `localFile`, `options
|
|
14242
|
+
> **downloadFile**(`remoteFile`, `localFile`, `options?`): `Promise`\<`boolean`\>
|
|
14243
14243
|
|
|
14244
14244
|
Defined in: [lib/ssh/sftp.ts:442](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/sftp.ts#L442)
|
|
14245
14245
|
|
|
@@ -14259,7 +14259,7 @@ Defined in: [lib/ssh/sftp.ts:442](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14259
14259
|
|
|
14260
14260
|
本地路径
|
|
14261
14261
|
|
|
14262
|
-
##### options
|
|
14262
|
+
##### options?
|
|
14263
14263
|
|
|
14264
14264
|
`TransferOptions` = `{}`
|
|
14265
14265
|
|
|
@@ -14377,7 +14377,7 @@ Defined in: [lib/ssh/sftp.ts:229](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14377
14377
|
|
|
14378
14378
|
### mkdir()
|
|
14379
14379
|
|
|
14380
|
-
> **mkdir**(`path`, `mode
|
|
14380
|
+
> **mkdir**(`path`, `mode?`): `Promise`\<`boolean`\>
|
|
14381
14381
|
|
|
14382
14382
|
Defined in: [lib/ssh/sftp.ts:242](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/sftp.ts#L242)
|
|
14383
14383
|
|
|
@@ -14391,7 +14391,7 @@ Defined in: [lib/ssh/sftp.ts:242](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14391
14391
|
|
|
14392
14392
|
要创建的路径,如 /a/b/c/
|
|
14393
14393
|
|
|
14394
|
-
##### mode
|
|
14394
|
+
##### mode?
|
|
14395
14395
|
|
|
14396
14396
|
`number` = `0o755`
|
|
14397
14397
|
|
|
@@ -14405,7 +14405,7 @@ Defined in: [lib/ssh/sftp.ts:242](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14405
14405
|
|
|
14406
14406
|
### pipe()
|
|
14407
14407
|
|
|
14408
|
-
> **pipe**\<`T`\>(`path`, `destination`, `options
|
|
14408
|
+
> **pipe**\<`T`\>(`path`, `destination`, `options?`): `Promise`\<`boolean`\>
|
|
14409
14409
|
|
|
14410
14410
|
Defined in: [lib/ssh/sftp.ts:400](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/sftp.ts#L400)
|
|
14411
14411
|
|
|
@@ -14431,7 +14431,7 @@ Defined in: [lib/ssh/sftp.ts:400](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14431
14431
|
|
|
14432
14432
|
要写入的流
|
|
14433
14433
|
|
|
14434
|
-
##### options
|
|
14434
|
+
##### options?
|
|
14435
14435
|
|
|
14436
14436
|
写入后是否终止写入流,默认终止
|
|
14437
14437
|
|
|
@@ -14447,7 +14447,7 @@ Defined in: [lib/ssh/sftp.ts:400](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14447
14447
|
|
|
14448
14448
|
### putContent()
|
|
14449
14449
|
|
|
14450
|
-
> **putContent**(`path`, `data`, `options
|
|
14450
|
+
> **putContent**(`path`, `data`, `options?`): `Promise`\<`boolean`\>
|
|
14451
14451
|
|
|
14452
14452
|
Defined in: [lib/ssh/sftp.ts:109](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/sftp.ts#L109)
|
|
14453
14453
|
|
|
@@ -14467,7 +14467,7 @@ Defined in: [lib/ssh/sftp.ts:109](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14467
14467
|
|
|
14468
14468
|
`string` | `Buffer`\<`ArrayBufferLike`\>
|
|
14469
14469
|
|
|
14470
|
-
##### options
|
|
14470
|
+
##### options?
|
|
14471
14471
|
|
|
14472
14472
|
`WriteFileOptions` = `{}`
|
|
14473
14473
|
|
|
@@ -14685,7 +14685,7 @@ Defined in: [lib/ssh/sftp.ts:169](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14685
14685
|
|
|
14686
14686
|
### uploadFile()
|
|
14687
14687
|
|
|
14688
|
-
> **uploadFile**(`localFile`, `remoteFile`, `options
|
|
14688
|
+
> **uploadFile**(`localFile`, `remoteFile`, `options?`): `Promise`\<`boolean`\>
|
|
14689
14689
|
|
|
14690
14690
|
Defined in: [lib/ssh/sftp.ts:466](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/sftp.ts#L466)
|
|
14691
14691
|
|
|
@@ -14703,7 +14703,7 @@ Defined in: [lib/ssh/sftp.ts:466](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14703
14703
|
|
|
14704
14704
|
`string`
|
|
14705
14705
|
|
|
14706
|
-
##### options
|
|
14706
|
+
##### options?
|
|
14707
14707
|
|
|
14708
14708
|
`TransferOptions` = `{}`
|
|
14709
14709
|
|
|
@@ -14791,7 +14791,7 @@ Defined in: [lib/ssh/shell.ts:77](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14791
14791
|
|
|
14792
14792
|
### getContent()
|
|
14793
14793
|
|
|
14794
|
-
> **getContent**(`tryCount
|
|
14794
|
+
> **getContent**(`tryCount?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\>\>
|
|
14795
14795
|
|
|
14796
14796
|
Defined in: [lib/ssh/shell.ts:96](https://github.com/maiyunnet/kebab/blob/master/lib/ssh/shell.ts#L96)
|
|
14797
14797
|
|
|
@@ -14799,7 +14799,7 @@ Defined in: [lib/ssh/shell.ts:96](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14799
14799
|
|
|
14800
14800
|
#### Parameters
|
|
14801
14801
|
|
|
14802
|
-
##### tryCount
|
|
14802
|
+
##### tryCount?
|
|
14803
14803
|
|
|
14804
14804
|
`number` = `10`
|
|
14805
14805
|
|
|
@@ -15005,7 +15005,7 @@ lib/text/functions/int2str.md
|
|
|
15005
15005
|
|
|
15006
15006
|
# Function: int2str()
|
|
15007
15007
|
|
|
15008
|
-
> **int2str**(`int`, `digits
|
|
15008
|
+
> **int2str**(`int`, `digits?`, `decimal?`): `string`
|
|
15009
15009
|
|
|
15010
15010
|
Defined in: [lib/text.ts:697](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L697)
|
|
15011
15011
|
|
|
@@ -15024,13 +15024,13 @@ int 传入 2,返回 '0.00'
|
|
|
15024
15024
|
|
|
15025
15025
|
要转换的整数
|
|
15026
15026
|
|
|
15027
|
-
### digits
|
|
15027
|
+
### digits?
|
|
15028
15028
|
|
|
15029
15029
|
`number` = `4`
|
|
15030
15030
|
|
|
15031
15031
|
小数点左移位数
|
|
15032
15032
|
|
|
15033
|
-
### decimal
|
|
15033
|
+
### decimal?
|
|
15034
15034
|
|
|
15035
15035
|
`number` = `2`
|
|
15036
15036
|
|
|
@@ -15423,7 +15423,7 @@ lib/text/functions/nlReplace.md
|
|
|
15423
15423
|
|
|
15424
15424
|
# Function: nlReplace()
|
|
15425
15425
|
|
|
15426
|
-
> **nlReplace**(`str`, `to
|
|
15426
|
+
> **nlReplace**(`str`, `to?`): `string`
|
|
15427
15427
|
|
|
15428
15428
|
Defined in: [lib/text.ts:265](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L265)
|
|
15429
15429
|
|
|
@@ -15437,7 +15437,7 @@ Defined in: [lib/text.ts:265](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
15437
15437
|
|
|
15438
15438
|
要替换的字符串
|
|
15439
15439
|
|
|
15440
|
-
### to
|
|
15440
|
+
### to?
|
|
15441
15441
|
|
|
15442
15442
|
`string` = '\n'
|
|
15443
15443
|
|
|
@@ -15692,7 +15692,7 @@ lib/text/functions/sizeFormat.md
|
|
|
15692
15692
|
|
|
15693
15693
|
# Function: sizeFormat()
|
|
15694
15694
|
|
|
15695
|
-
> **sizeFormat**(`size`, `spliter
|
|
15695
|
+
> **sizeFormat**(`size`, `spliter?`): `string`
|
|
15696
15696
|
|
|
15697
15697
|
Defined in: [lib/text.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L15)
|
|
15698
15698
|
|
|
@@ -15706,7 +15706,7 @@ Defined in: [lib/text.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
15706
15706
|
|
|
15707
15707
|
文件大小
|
|
15708
15708
|
|
|
15709
|
-
### spliter
|
|
15709
|
+
### spliter?
|
|
15710
15710
|
|
|
15711
15711
|
`string` = `' '`
|
|
15712
15712
|
|
|
@@ -15727,7 +15727,7 @@ lib/text/functions/str2int.md
|
|
|
15727
15727
|
|
|
15728
15728
|
# Function: str2int()
|
|
15729
15729
|
|
|
15730
|
-
> **str2int**(`str`, `digits
|
|
15730
|
+
> **str2int**(`str`, `digits?`): `number`
|
|
15731
15731
|
|
|
15732
15732
|
Defined in: [lib/text.ts:679](https://github.com/maiyunnet/kebab/blob/master/lib/text.ts#L679)
|
|
15733
15733
|
|
|
@@ -15746,7 +15746,7 @@ str 传入 '6',返回 600
|
|
|
15746
15746
|
|
|
15747
15747
|
要转换的数字字符串
|
|
15748
15748
|
|
|
15749
|
-
### digits
|
|
15749
|
+
### digits?
|
|
15750
15750
|
|
|
15751
15751
|
`number` = `3`
|
|
15752
15752
|
|
|
@@ -16322,7 +16322,7 @@ lib/time/functions/get.md
|
|
|
16322
16322
|
|
|
16323
16323
|
# Function: get()
|
|
16324
16324
|
|
|
16325
|
-
> **get**(`ctr`, `opt
|
|
16325
|
+
> **get**(`ctr`, `opt?`): [`Time`](../classes/Time.md)
|
|
16326
16326
|
|
|
16327
16327
|
Defined in: [lib/time.ts:113](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L113)
|
|
16328
16328
|
|
|
@@ -16334,7 +16334,7 @@ Defined in: [lib/time.ts:113](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16334
16334
|
|
|
16335
16335
|
[`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
16336
16336
|
|
|
16337
|
-
### opt
|
|
16337
|
+
### opt?
|
|
16338
16338
|
|
|
16339
16339
|
[`IOptions`](../interfaces/IOptions.md) = `{}`
|
|
16340
16340
|
|
|
@@ -16990,7 +16990,7 @@ Defined in: [lib/ws.ts:361](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
16990
16990
|
|
|
16991
16991
|
### connect()
|
|
16992
16992
|
|
|
16993
|
-
> **connect**(`u`, `opt
|
|
16993
|
+
> **connect**(`u`, `opt?`): `Promise`\<`Socket` \| `null`\>
|
|
16994
16994
|
|
|
16995
16995
|
Defined in: [lib/ws.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L123)
|
|
16996
16996
|
|
|
@@ -17004,7 +17004,7 @@ Defined in: [lib/ws.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17004
17004
|
|
|
17005
17005
|
以 ws, wss 开头的地址
|
|
17006
17006
|
|
|
17007
|
-
##### opt
|
|
17007
|
+
##### opt?
|
|
17008
17008
|
|
|
17009
17009
|
[`IConnectOptions`](../interfaces/IConnectOptions.md) = `{}`
|
|
17010
17010
|
|
|
@@ -17341,7 +17341,7 @@ lib/ws/functions/connect.md
|
|
|
17341
17341
|
|
|
17342
17342
|
# Function: connect()
|
|
17343
17343
|
|
|
17344
|
-
> **connect**(`u`, `opt
|
|
17344
|
+
> **connect**(`u`, `opt?`): `Promise`\<[`Socket`](../classes/Socket.md) \| `null`\>
|
|
17345
17345
|
|
|
17346
17346
|
Defined in: [lib/ws.ts:411](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L411)
|
|
17347
17347
|
|
|
@@ -17355,7 +17355,7 @@ Defined in: [lib/ws.ts:411](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17355
17355
|
|
|
17356
17356
|
以 ws, wss 开头的地址
|
|
17357
17357
|
|
|
17358
|
-
### opt
|
|
17358
|
+
### opt?
|
|
17359
17359
|
|
|
17360
17360
|
[`IConnectOptions`](../interfaces/IConnectOptions.md) = `{}`
|
|
17361
17361
|
|
|
@@ -17425,7 +17425,7 @@ lib/ws/functions/mproxy.md
|
|
|
17425
17425
|
|
|
17426
17426
|
# Function: mproxy()
|
|
17427
17427
|
|
|
17428
|
-
> **mproxy**(`ctr`, `auth`, `opt
|
|
17428
|
+
> **mproxy**(`ctr`, `auth`, `opt?`): `Promise`\<`number`\>
|
|
17429
17429
|
|
|
17430
17430
|
Defined in: [lib/ws.ts:509](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L509)
|
|
17431
17431
|
|
|
@@ -17446,7 +17446,7 @@ get: url, auth
|
|
|
17446
17446
|
|
|
17447
17447
|
校验字符串,读取 get 的 auth 和本参数做比对
|
|
17448
17448
|
|
|
17449
|
-
### opt
|
|
17449
|
+
### opt?
|
|
17450
17450
|
|
|
17451
17451
|
[`IMproxyOptions`](../interfaces/IMproxyOptions.md) = `{}`
|
|
17452
17452
|
|
|
@@ -17467,7 +17467,7 @@ lib/ws/functions/rproxy.md
|
|
|
17467
17467
|
|
|
17468
17468
|
# Function: rproxy()
|
|
17469
17469
|
|
|
17470
|
-
> **rproxy**(`ctr`, `url`, `opt
|
|
17470
|
+
> **rproxy**(`ctr`, `url`, `opt?`): `Promise`\<`boolean`\>
|
|
17471
17471
|
|
|
17472
17472
|
Defined in: [lib/ws.ts:546](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L546)
|
|
17473
17473
|
|
|
@@ -17487,7 +17487,7 @@ Defined in: [lib/ws.ts:546](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17487
17487
|
|
|
17488
17488
|
反代真实请求地址,如有 get 需要自行添加
|
|
17489
17489
|
|
|
17490
|
-
### opt
|
|
17490
|
+
### opt?
|
|
17491
17491
|
|
|
17492
17492
|
[`IRproxyOptions`](../interfaces/IRproxyOptions.md) = `{}`
|
|
17493
17493
|
|
|
@@ -17931,7 +17931,7 @@ Defined in: [lib/zip.ts:338](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
17931
17931
|
|
|
17932
17932
|
### generate()
|
|
17933
17933
|
|
|
17934
|
-
> **generate**\<`T`\>(`options
|
|
17934
|
+
> **generate**\<`T`\>(`options?`): `Promise`\<[`IZipOutputByType`](../interfaces/IZipOutputByType.md)\[`T`\]\>
|
|
17935
17935
|
|
|
17936
17936
|
Defined in: [lib/zip.ts:350](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L350)
|
|
17937
17937
|
|
|
@@ -17945,7 +17945,7 @@ Defined in: [lib/zip.ts:350](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
17945
17945
|
|
|
17946
17946
|
#### Parameters
|
|
17947
17947
|
|
|
17948
|
-
##### options
|
|
17948
|
+
##### options?
|
|
17949
17949
|
|
|
17950
17950
|
选项
|
|
17951
17951
|
|
|
@@ -18083,7 +18083,7 @@ Defined in: [lib/zip.ts:146](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
18083
18083
|
|
|
18084
18084
|
### putContent()
|
|
18085
18085
|
|
|
18086
|
-
> **putContent**\<`T`\>(`path`, `data`, `options
|
|
18086
|
+
> **putContent**\<`T`\>(`path`, `data`, `options?`): `void`
|
|
18087
18087
|
|
|
18088
18088
|
Defined in: [lib/zip.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/zip.ts#L51)
|
|
18089
18089
|
|
|
@@ -18109,7 +18109,7 @@ Defined in: [lib/zip.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/z
|
|
|
18109
18109
|
|
|
18110
18110
|
要写入的内容
|
|
18111
18111
|
|
|
18112
|
-
##### options
|
|
18112
|
+
##### options?
|
|
18113
18113
|
|
|
18114
18114
|
选项
|
|
18115
18115
|
|
|
@@ -18706,7 +18706,7 @@ lib/zlib/functions/brotliCompress.md
|
|
|
18706
18706
|
|
|
18707
18707
|
# Function: brotliCompress()
|
|
18708
18708
|
|
|
18709
|
-
> **brotliCompress**(`buffer`, `options
|
|
18709
|
+
> **brotliCompress**(`buffer`, `options?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
18710
18710
|
|
|
18711
18711
|
Defined in: [lib/zlib.ts:212](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L212)
|
|
18712
18712
|
|
|
@@ -18720,7 +18720,7 @@ Brotli 压缩一段
|
|
|
18720
18720
|
|
|
18721
18721
|
段
|
|
18722
18722
|
|
|
18723
|
-
### options
|
|
18723
|
+
### options?
|
|
18724
18724
|
|
|
18725
18725
|
`ZlibOptions` = `{}`
|
|
18726
18726
|
|
|
@@ -18811,7 +18811,7 @@ lib/zlib/functions/createBrotliCompress.md
|
|
|
18811
18811
|
|
|
18812
18812
|
# Function: createBrotliCompress()
|
|
18813
18813
|
|
|
18814
|
-
> **createBrotliCompress**(`options
|
|
18814
|
+
> **createBrotliCompress**(`options?`): `BrotliCompress`
|
|
18815
18815
|
|
|
18816
18816
|
Defined in: [lib/zlib.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L57)
|
|
18817
18817
|
|
|
@@ -18819,7 +18819,7 @@ Defined in: [lib/zlib.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
18819
18819
|
|
|
18820
18820
|
## Parameters
|
|
18821
18821
|
|
|
18822
|
-
### options
|
|
18822
|
+
### options?
|
|
18823
18823
|
|
|
18824
18824
|
`ZlibOptions` = `{}`
|
|
18825
18825
|
|
|
@@ -18861,7 +18861,7 @@ lib/zlib/functions/createCompress.md
|
|
|
18861
18861
|
|
|
18862
18862
|
# Function: createCompress()
|
|
18863
18863
|
|
|
18864
|
-
> **createCompress**(`types`, `options
|
|
18864
|
+
> **createCompress**(`types`, `options?`): [`ICompress`](../interfaces/ICompress.md) \| `null`
|
|
18865
18865
|
|
|
18866
18866
|
Defined in: [lib/zlib.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L74)
|
|
18867
18867
|
|
|
@@ -18875,7 +18875,7 @@ Defined in: [lib/zlib.ts:74](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
18875
18875
|
|
|
18876
18876
|
用 , 间隔的字符串,如 gzip,deflate
|
|
18877
18877
|
|
|
18878
|
-
### options
|
|
18878
|
+
### options?
|
|
18879
18879
|
|
|
18880
18880
|
`ZlibOptions` = `{}`
|
|
18881
18881
|
|
|
@@ -18925,7 +18925,7 @@ lib/zlib/functions/createDeflate.md
|
|
|
18925
18925
|
|
|
18926
18926
|
# Function: createDeflate()
|
|
18927
18927
|
|
|
18928
|
-
> **createDeflate**(`options
|
|
18928
|
+
> **createDeflate**(`options?`): `Deflate`
|
|
18929
18929
|
|
|
18930
18930
|
Defined in: [lib/zlib.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L41)
|
|
18931
18931
|
|
|
@@ -18933,7 +18933,7 @@ Defined in: [lib/zlib.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
18933
18933
|
|
|
18934
18934
|
## Parameters
|
|
18935
18935
|
|
|
18936
|
-
### options
|
|
18936
|
+
### options?
|
|
18937
18937
|
|
|
18938
18938
|
`ZlibOptions` = `{}`
|
|
18939
18939
|
|
|
@@ -18975,7 +18975,7 @@ lib/zlib/functions/createGzip.md
|
|
|
18975
18975
|
|
|
18976
18976
|
# Function: createGzip()
|
|
18977
18977
|
|
|
18978
|
-
> **createGzip**(`options
|
|
18978
|
+
> **createGzip**(`options?`): `Gzip`
|
|
18979
18979
|
|
|
18980
18980
|
Defined in: [lib/zlib.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L25)
|
|
18981
18981
|
|
|
@@ -18983,7 +18983,7 @@ Defined in: [lib/zlib.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
18983
18983
|
|
|
18984
18984
|
## Parameters
|
|
18985
18985
|
|
|
18986
|
-
### options
|
|
18986
|
+
### options?
|
|
18987
18987
|
|
|
18988
18988
|
`ZlibOptions` = `{}`
|
|
18989
18989
|
|
|
@@ -19060,7 +19060,7 @@ lib/zlib/functions/deflate.md
|
|
|
19060
19060
|
|
|
19061
19061
|
# Function: deflate()
|
|
19062
19062
|
|
|
19063
|
-
> **deflate**(`buffer`, `options
|
|
19063
|
+
> **deflate**(`buffer`, `options?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
19064
19064
|
|
|
19065
19065
|
Defined in: [lib/zlib.ts:176](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L176)
|
|
19066
19066
|
|
|
@@ -19074,7 +19074,7 @@ Deflate 压缩一段
|
|
|
19074
19074
|
|
|
19075
19075
|
段
|
|
19076
19076
|
|
|
19077
|
-
### options
|
|
19077
|
+
### options?
|
|
19078
19078
|
|
|
19079
19079
|
`ZlibOptions` = `{}`
|
|
19080
19080
|
|
|
@@ -19124,7 +19124,7 @@ lib/zlib/functions/gzip.md
|
|
|
19124
19124
|
|
|
19125
19125
|
# Function: gzip()
|
|
19126
19126
|
|
|
19127
|
-
> **gzip**(`buffer`, `options
|
|
19127
|
+
> **gzip**(`buffer`, `options?`): `Promise`\<`Buffer`\<`ArrayBufferLike`\> \| `null`\>
|
|
19128
19128
|
|
|
19129
19129
|
Defined in: [lib/zlib.ts:140](https://github.com/maiyunnet/kebab/blob/master/lib/zlib.ts#L140)
|
|
19130
19130
|
|
|
@@ -19138,7 +19138,7 @@ Gzip 压缩一段
|
|
|
19138
19138
|
|
|
19139
19139
|
段
|
|
19140
19140
|
|
|
19141
|
-
### options
|
|
19141
|
+
### options?
|
|
19142
19142
|
|
|
19143
19143
|
`ZlibOptions` = `{}`
|
|
19144
19144
|
|
|
@@ -19828,7 +19828,7 @@ Defined in: [sys/ctr.ts:323](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19828
19828
|
|
|
19829
19829
|
### \_getRunTime()
|
|
19830
19830
|
|
|
19831
|
-
> `protected` **\_getRunTime**(`ms
|
|
19831
|
+
> `protected` **\_getRunTime**(`ms?`): `number`
|
|
19832
19832
|
|
|
19833
19833
|
Defined in: [sys/ctr.ts:315](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L315)
|
|
19834
19834
|
|
|
@@ -19836,7 +19836,7 @@ Defined in: [sys/ctr.ts:315](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19836
19836
|
|
|
19837
19837
|
#### Parameters
|
|
19838
19838
|
|
|
19839
|
-
##### ms
|
|
19839
|
+
##### ms?
|
|
19840
19840
|
|
|
19841
19841
|
`boolean` = `false`
|
|
19842
19842
|
|
|
@@ -19850,7 +19850,7 @@ Defined in: [sys/ctr.ts:315](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19850
19850
|
|
|
19851
19851
|
### \_handleFormData()
|
|
19852
19852
|
|
|
19853
|
-
> `protected` **\_handleFormData**(`events
|
|
19853
|
+
> `protected` **\_handleFormData**(`events?`): `Promise`\<`boolean`\>
|
|
19854
19854
|
|
|
19855
19855
|
Defined in: [sys/ctr.ts:843](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L843)
|
|
19856
19856
|
|
|
@@ -19858,7 +19858,7 @@ Defined in: [sys/ctr.ts:843](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19858
19858
|
|
|
19859
19859
|
#### Parameters
|
|
19860
19860
|
|
|
19861
|
-
##### events
|
|
19861
|
+
##### events?
|
|
19862
19862
|
|
|
19863
19863
|
文件处理情况
|
|
19864
19864
|
|
|
@@ -19930,7 +19930,7 @@ Defined in: [sys/ctr.ts:635](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19930
19930
|
|
|
19931
19931
|
### \_loadLocale()
|
|
19932
19932
|
|
|
19933
|
-
> `protected` **\_loadLocale**(`loc`, `pkg
|
|
19933
|
+
> `protected` **\_loadLocale**(`loc`, `pkg?`): `Promise`\<`boolean`\>
|
|
19934
19934
|
|
|
19935
19935
|
Defined in: [sys/ctr.ts:683](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L683)
|
|
19936
19936
|
|
|
@@ -19944,7 +19944,7 @@ Defined in: [sys/ctr.ts:683](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19944
19944
|
|
|
19945
19945
|
要加载的目标语言
|
|
19946
19946
|
|
|
19947
|
-
##### pkg
|
|
19947
|
+
##### pkg?
|
|
19948
19948
|
|
|
19949
19949
|
`string` = `'default'`
|
|
19950
19950
|
|
|
@@ -19958,7 +19958,7 @@ Defined in: [sys/ctr.ts:683](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19958
19958
|
|
|
19959
19959
|
### \_loadView()
|
|
19960
19960
|
|
|
19961
|
-
> `protected` **\_loadView**(`path`, `data
|
|
19961
|
+
> `protected` **\_loadView**(`path`, `data?`): `Promise`\<`string`\>
|
|
19962
19962
|
|
|
19963
19963
|
Defined in: [sys/ctr.ts:332](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L332)
|
|
19964
19964
|
|
|
@@ -19970,7 +19970,7 @@ Defined in: [sys/ctr.ts:332](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19970
19970
|
|
|
19971
19971
|
`string`
|
|
19972
19972
|
|
|
19973
|
-
##### data
|
|
19973
|
+
##### data?
|
|
19974
19974
|
|
|
19975
19975
|
`any` = `{}`
|
|
19976
19976
|
|
|
@@ -20048,7 +20048,7 @@ Defined in: [sys/ctr.ts:828](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20048
20048
|
|
|
20049
20049
|
### \_startSession()
|
|
20050
20050
|
|
|
20051
|
-
> `protected` **\_startSession**(`link`, `auth
|
|
20051
|
+
> `protected` **\_startSession**(`link`, `auth?`, `opt?`): `Promise`\<`boolean`\>
|
|
20052
20052
|
|
|
20053
20053
|
Defined in: [sys/ctr.ts:667](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L667)
|
|
20054
20054
|
|
|
@@ -20062,13 +20062,13 @@ Kv 或 Db 实例
|
|
|
20062
20062
|
|
|
20063
20063
|
[`Pool`](../../../lib/db/pool/classes/Pool.md) | [`Kv`](../../../lib/kv/classes/Kv.md)
|
|
20064
20064
|
|
|
20065
|
-
##### auth
|
|
20065
|
+
##### auth?
|
|
20066
20066
|
|
|
20067
20067
|
`boolean` = `false`
|
|
20068
20068
|
|
|
20069
20069
|
设为 true 则从头 Authorization 或 post _auth 值读取 token
|
|
20070
20070
|
|
|
20071
|
-
##### opt
|
|
20071
|
+
##### opt?
|
|
20072
20072
|
|
|
20073
20073
|
[`IOptions`](../../../lib/session/interfaces/IOptions.md) = `{}`
|
|
20074
20074
|
|
|
@@ -20907,7 +20907,7 @@ Defined in: [sys/mod.ts:1667](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
20907
20907
|
|
|
20908
20908
|
### by()
|
|
20909
20909
|
|
|
20910
|
-
> **by**(`c`, `d
|
|
20910
|
+
> **by**(`c`, `d?`): `this`
|
|
20911
20911
|
|
|
20912
20912
|
Defined in: [sys/mod.ts:1623](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1623)
|
|
20913
20913
|
|
|
@@ -20921,7 +20921,7 @@ ORDER BY
|
|
|
20921
20921
|
|
|
20922
20922
|
`string` | (`string` \| `string`[])[]
|
|
20923
20923
|
|
|
20924
|
-
##### d
|
|
20924
|
+
##### d?
|
|
20925
20925
|
|
|
20926
20926
|
排序规则
|
|
20927
20927
|
|
|
@@ -21007,7 +21007,7 @@ true-成功,false-报错,null-唯一键非 _$key 键冲突
|
|
|
21007
21007
|
|
|
21008
21008
|
### crossJoin()
|
|
21009
21009
|
|
|
21010
|
-
> **crossJoin**(`f`, `s`, `index
|
|
21010
|
+
> **crossJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
21011
21011
|
|
|
21012
21012
|
Defined in: [sys/mod.ts:1583](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1583)
|
|
21013
21013
|
|
|
@@ -21027,13 +21027,13 @@ cross join 方法
|
|
|
21027
21027
|
|
|
21028
21028
|
ON 信息
|
|
21029
21029
|
|
|
21030
|
-
##### index
|
|
21030
|
+
##### index?
|
|
21031
21031
|
|
|
21032
21032
|
`string` = `''`
|
|
21033
21033
|
|
|
21034
21034
|
给本表增加 index 分表项
|
|
21035
21035
|
|
|
21036
|
-
##### pre
|
|
21036
|
+
##### pre?
|
|
21037
21037
|
|
|
21038
21038
|
`string` = `''`
|
|
21039
21039
|
|
|
@@ -21165,7 +21165,7 @@ Defined in: [sys/mod.ts:1018](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21165
21165
|
|
|
21166
21166
|
### firstArray()
|
|
21167
21167
|
|
|
21168
|
-
> **firstArray**(`lock
|
|
21168
|
+
> **firstArray**(`lock?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
21169
21169
|
|
|
21170
21170
|
Defined in: [sys/mod.ts:1058](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1058)
|
|
21171
21171
|
|
|
@@ -21173,7 +21173,7 @@ Defined in: [sys/mod.ts:1058](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21173
21173
|
|
|
21174
21174
|
#### Parameters
|
|
21175
21175
|
|
|
21176
|
-
##### lock
|
|
21176
|
+
##### lock?
|
|
21177
21177
|
|
|
21178
21178
|
`boolean` = `false`
|
|
21179
21179
|
|
|
@@ -21215,7 +21215,7 @@ sql 语句
|
|
|
21215
21215
|
|
|
21216
21216
|
### fullJoin()
|
|
21217
21217
|
|
|
21218
|
-
> **fullJoin**(`f`, `s`, `index
|
|
21218
|
+
> **fullJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
21219
21219
|
|
|
21220
21220
|
Defined in: [sys/mod.ts:1571](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1571)
|
|
21221
21221
|
|
|
@@ -21235,13 +21235,13 @@ full join 方法
|
|
|
21235
21235
|
|
|
21236
21236
|
ON 信息
|
|
21237
21237
|
|
|
21238
|
-
##### index
|
|
21238
|
+
##### index?
|
|
21239
21239
|
|
|
21240
21240
|
`string` = `''`
|
|
21241
21241
|
|
|
21242
21242
|
给本表增加 index 分表项
|
|
21243
21243
|
|
|
21244
|
-
##### pre
|
|
21244
|
+
##### pre?
|
|
21245
21245
|
|
|
21246
21246
|
`string` = `''`
|
|
21247
21247
|
|
|
@@ -21349,7 +21349,7 @@ Defined in: [sys/mod.ts:1592](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21349
21349
|
|
|
21350
21350
|
### innerJoin()
|
|
21351
21351
|
|
|
21352
|
-
> **innerJoin**(`f`, `s`, `index
|
|
21352
|
+
> **innerJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
21353
21353
|
|
|
21354
21354
|
Defined in: [sys/mod.ts:1559](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1559)
|
|
21355
21355
|
|
|
@@ -21369,13 +21369,13 @@ inner join 方法
|
|
|
21369
21369
|
|
|
21370
21370
|
ON 信息
|
|
21371
21371
|
|
|
21372
|
-
##### index
|
|
21372
|
+
##### index?
|
|
21373
21373
|
|
|
21374
21374
|
`string` = `''`
|
|
21375
21375
|
|
|
21376
21376
|
给本表增加 index 分表项
|
|
21377
21377
|
|
|
21378
|
-
##### pre
|
|
21378
|
+
##### pre?
|
|
21379
21379
|
|
|
21380
21380
|
`string` = `''`
|
|
21381
21381
|
|
|
@@ -21389,7 +21389,7 @@ ON 信息
|
|
|
21389
21389
|
|
|
21390
21390
|
### join()
|
|
21391
21391
|
|
|
21392
|
-
> **join**(`f`, `s
|
|
21392
|
+
> **join**(`f`, `s?`, `type?`, `index?`, `pre?`): `this`
|
|
21393
21393
|
|
|
21394
21394
|
Defined in: [sys/mod.ts:1523](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1523)
|
|
21395
21395
|
|
|
@@ -21401,25 +21401,25 @@ Defined in: [sys/mod.ts:1523](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21401
21401
|
|
|
21402
21402
|
表名
|
|
21403
21403
|
|
|
21404
|
-
##### s
|
|
21404
|
+
##### s?
|
|
21405
21405
|
|
|
21406
21406
|
`any` = `[]`
|
|
21407
21407
|
|
|
21408
21408
|
ON 信息
|
|
21409
21409
|
|
|
21410
|
-
##### type
|
|
21410
|
+
##### type?
|
|
21411
21411
|
|
|
21412
21412
|
`string` = `'INNER'`
|
|
21413
21413
|
|
|
21414
21414
|
类型
|
|
21415
21415
|
|
|
21416
|
-
##### index
|
|
21416
|
+
##### index?
|
|
21417
21417
|
|
|
21418
21418
|
`string` = `''`
|
|
21419
21419
|
|
|
21420
21420
|
给本表增加 index 分表项
|
|
21421
21421
|
|
|
21422
|
-
##### pre
|
|
21422
|
+
##### pre?
|
|
21423
21423
|
|
|
21424
21424
|
`string` = `''`
|
|
21425
21425
|
|
|
@@ -21461,7 +21461,7 @@ Defined in: [sys/mod.ts:1738](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21461
21461
|
|
|
21462
21462
|
### leftJoin()
|
|
21463
21463
|
|
|
21464
|
-
> **leftJoin**(`f`, `s`, `index
|
|
21464
|
+
> **leftJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
21465
21465
|
|
|
21466
21466
|
Defined in: [sys/mod.ts:1535](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1535)
|
|
21467
21467
|
|
|
@@ -21481,13 +21481,13 @@ left join 方法
|
|
|
21481
21481
|
|
|
21482
21482
|
ON 信息
|
|
21483
21483
|
|
|
21484
|
-
##### index
|
|
21484
|
+
##### index?
|
|
21485
21485
|
|
|
21486
21486
|
`string` = `''`
|
|
21487
21487
|
|
|
21488
21488
|
给本表增加 index 分表项
|
|
21489
21489
|
|
|
21490
|
-
##### pre
|
|
21490
|
+
##### pre?
|
|
21491
21491
|
|
|
21492
21492
|
`string` = `''`
|
|
21493
21493
|
|
|
@@ -21501,7 +21501,7 @@ ON 信息
|
|
|
21501
21501
|
|
|
21502
21502
|
### limit()
|
|
21503
21503
|
|
|
21504
|
-
> **limit**(`a`, `b
|
|
21504
|
+
> **limit**(`a`, `b?`): `this`
|
|
21505
21505
|
|
|
21506
21506
|
Defined in: [sys/mod.ts:1645](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1645)
|
|
21507
21507
|
|
|
@@ -21515,7 +21515,7 @@ LIMIT
|
|
|
21515
21515
|
|
|
21516
21516
|
起始
|
|
21517
21517
|
|
|
21518
|
-
##### b
|
|
21518
|
+
##### b?
|
|
21519
21519
|
|
|
21520
21520
|
`number` = `0`
|
|
21521
21521
|
|
|
@@ -21529,7 +21529,7 @@ LIMIT
|
|
|
21529
21529
|
|
|
21530
21530
|
### page()
|
|
21531
21531
|
|
|
21532
|
-
> **page**(`count`, `page
|
|
21532
|
+
> **page**(`count`, `page?`): `this`
|
|
21533
21533
|
|
|
21534
21534
|
Defined in: [sys/mod.ts:1656](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1656)
|
|
21535
21535
|
|
|
@@ -21543,7 +21543,7 @@ Defined in: [sys/mod.ts:1656](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21543
21543
|
|
|
21544
21544
|
每页条数
|
|
21545
21545
|
|
|
21546
|
-
##### page
|
|
21546
|
+
##### page?
|
|
21547
21547
|
|
|
21548
21548
|
`number` = `1`
|
|
21549
21549
|
|
|
@@ -21557,7 +21557,7 @@ Defined in: [sys/mod.ts:1656](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21557
21557
|
|
|
21558
21558
|
### refresh()
|
|
21559
21559
|
|
|
21560
|
-
> **refresh**(`lock
|
|
21560
|
+
> **refresh**(`lock?`): `Promise`\<`boolean` \| `null`\>
|
|
21561
21561
|
|
|
21562
21562
|
Defined in: [sys/mod.ts:939](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L939)
|
|
21563
21563
|
|
|
@@ -21565,7 +21565,7 @@ Defined in: [sys/mod.ts:939](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
21565
21565
|
|
|
21566
21566
|
#### Parameters
|
|
21567
21567
|
|
|
21568
|
-
##### lock
|
|
21568
|
+
##### lock?
|
|
21569
21569
|
|
|
21570
21570
|
`boolean` = `false`
|
|
21571
21571
|
|
|
@@ -21593,7 +21593,7 @@ Defined in: [sys/mod.ts:996](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
21593
21593
|
|
|
21594
21594
|
### rightJoin()
|
|
21595
21595
|
|
|
21596
|
-
> **rightJoin**(`f`, `s`, `index
|
|
21596
|
+
> **rightJoin**(`f`, `s`, `index?`, `pre?`): `this`
|
|
21597
21597
|
|
|
21598
21598
|
Defined in: [sys/mod.ts:1547](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1547)
|
|
21599
21599
|
|
|
@@ -21613,13 +21613,13 @@ right join 方法
|
|
|
21613
21613
|
|
|
21614
21614
|
ON 信息
|
|
21615
21615
|
|
|
21616
|
-
##### index
|
|
21616
|
+
##### index?
|
|
21617
21617
|
|
|
21618
21618
|
`string` = `''`
|
|
21619
21619
|
|
|
21620
21620
|
给本表增加 index 分表项
|
|
21621
21621
|
|
|
21622
|
-
##### pre
|
|
21622
|
+
##### pre?
|
|
21623
21623
|
|
|
21624
21624
|
`string` = `''`
|
|
21625
21625
|
|
|
@@ -21745,7 +21745,7 @@ Defined in: [sys/mod.ts:1710](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21745
21745
|
|
|
21746
21746
|
### total()
|
|
21747
21747
|
|
|
21748
|
-
> **total**(`f
|
|
21748
|
+
> **total**(`f?`): `Promise`\<`number`\>
|
|
21749
21749
|
|
|
21750
21750
|
Defined in: [sys/mod.ts:1465](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1465)
|
|
21751
21751
|
|
|
@@ -21753,7 +21753,7 @@ Defined in: [sys/mod.ts:1465](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21753
21753
|
|
|
21754
21754
|
#### Parameters
|
|
21755
21755
|
|
|
21756
|
-
##### f
|
|
21756
|
+
##### f?
|
|
21757
21757
|
|
|
21758
21758
|
`string` = `'*'`
|
|
21759
21759
|
|
|
@@ -21765,7 +21765,7 @@ Defined in: [sys/mod.ts:1465](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21765
21765
|
|
|
21766
21766
|
### union()
|
|
21767
21767
|
|
|
21768
|
-
> **union**(`f`, `type
|
|
21768
|
+
> **union**(`f`, `type?`): `this`
|
|
21769
21769
|
|
|
21770
21770
|
Defined in: [sys/mod.ts:1069](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1069)
|
|
21771
21771
|
|
|
@@ -21779,7 +21779,7 @@ Defined in: [sys/mod.ts:1069](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
21779
21779
|
|
|
21780
21780
|
`string` | `string`[] | [`Sql`](../../../lib/sql/classes/Sql.md) | [`IModUnionItem`](../interfaces/IModUnionItem.md) | [`IModUnionItem`](../interfaces/IModUnionItem.md)[]
|
|
21781
21781
|
|
|
21782
|
-
##### type
|
|
21782
|
+
##### type?
|
|
21783
21783
|
|
|
21784
21784
|
`string` = `''`
|
|
21785
21785
|
|
|
@@ -21919,7 +21919,7 @@ Defined in: [sys/mod.ts:168](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
21919
21919
|
|
|
21920
21920
|
### find()
|
|
21921
21921
|
|
|
21922
|
-
> `static` **find**\<`T`\>(`db`, `val`, `opt
|
|
21922
|
+
> `static` **find**\<`T`\>(`db`, `val`, `opt?`): `Promise`\<`false` \| `T` & `Record`\<`string`, `any`\> \| `null`\>
|
|
21923
21923
|
|
|
21924
21924
|
Defined in: [sys/mod.ts:599](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L599)
|
|
21925
21925
|
|
|
@@ -21945,7 +21945,7 @@ Defined in: [sys/mod.ts:599](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
21945
21945
|
|
|
21946
21946
|
`string` | `number` | `null`
|
|
21947
21947
|
|
|
21948
|
-
##### opt
|
|
21948
|
+
##### opt?
|
|
21949
21949
|
|
|
21950
21950
|
选项
|
|
21951
21951
|
|
|
@@ -21979,7 +21979,7 @@ Defined in: [sys/mod.ts:599](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
21979
21979
|
|
|
21980
21980
|
### getCreate()
|
|
21981
21981
|
|
|
21982
|
-
> `static` **getCreate**\<`T`\>(`db`, `opt
|
|
21982
|
+
> `static` **getCreate**\<`T`\>(`db`, `opt?`): `T`
|
|
21983
21983
|
|
|
21984
21984
|
Defined in: [sys/mod.ts:581](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L581)
|
|
21985
21985
|
|
|
@@ -21999,7 +21999,7 @@ Defined in: [sys/mod.ts:581](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
21999
21999
|
|
|
22000
22000
|
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) | [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22001
22001
|
|
|
22002
|
-
##### opt
|
|
22002
|
+
##### opt?
|
|
22003
22003
|
|
|
22004
22004
|
选项
|
|
22005
22005
|
|
|
@@ -22247,7 +22247,7 @@ Defined in: [sys/mod.ts:638](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22247
22247
|
|
|
22248
22248
|
### oneArray()
|
|
22249
22249
|
|
|
22250
|
-
> `static` **oneArray**(`db`, `s`, `opt
|
|
22250
|
+
> `static` **oneArray**(`db`, `s`, `opt?`): `Promise`\<`false` \| `Record`\<`string`, `any`\> \| `null`\>
|
|
22251
22251
|
|
|
22252
22252
|
Defined in: [sys/mod.ts:713](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L713)
|
|
22253
22253
|
|
|
@@ -22267,7 +22267,7 @@ Defined in: [sys/mod.ts:713](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22267
22267
|
|
|
22268
22268
|
筛选条件数组或字符串
|
|
22269
22269
|
|
|
22270
|
-
##### opt
|
|
22270
|
+
##### opt?
|
|
22271
22271
|
|
|
22272
22272
|
选项
|
|
22273
22273
|
|
|
@@ -22295,7 +22295,7 @@ Defined in: [sys/mod.ts:713](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22295
22295
|
|
|
22296
22296
|
### primarys()
|
|
22297
22297
|
|
|
22298
|
-
> `static` **primarys**(`db`, `where
|
|
22298
|
+
> `static` **primarys**(`db`, `where?`, `opt?`): `Promise`\<`false` \| `any`[]\>
|
|
22299
22299
|
|
|
22300
22300
|
Defined in: [sys/mod.ts:733](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L733)
|
|
22301
22301
|
|
|
@@ -22309,13 +22309,13 @@ Defined in: [sys/mod.ts:733](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22309
22309
|
|
|
22310
22310
|
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) | [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22311
22311
|
|
|
22312
|
-
##### where
|
|
22312
|
+
##### where?
|
|
22313
22313
|
|
|
22314
22314
|
`any` = `''`
|
|
22315
22315
|
|
|
22316
22316
|
where 条件
|
|
22317
22317
|
|
|
22318
|
-
##### opt
|
|
22318
|
+
##### opt?
|
|
22319
22319
|
|
|
22320
22320
|
选项
|
|
22321
22321
|
|
|
@@ -22339,7 +22339,7 @@ where 条件
|
|
|
22339
22339
|
|
|
22340
22340
|
### removeByWhere()
|
|
22341
22341
|
|
|
22342
|
-
> `static` **removeByWhere**(`db`, `where`, `opt
|
|
22342
|
+
> `static` **removeByWhere**(`db`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
22343
22343
|
|
|
22344
22344
|
Defined in: [sys/mod.ts:269](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L269)
|
|
22345
22345
|
|
|
@@ -22359,7 +22359,7 @@ Defined in: [sys/mod.ts:269](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22359
22359
|
|
|
22360
22360
|
筛选条件
|
|
22361
22361
|
|
|
22362
|
-
##### opt
|
|
22362
|
+
##### opt?
|
|
22363
22363
|
|
|
22364
22364
|
选项
|
|
22365
22365
|
|
|
@@ -22391,7 +22391,7 @@ Defined in: [sys/mod.ts:269](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22391
22391
|
|
|
22392
22392
|
### removeByWhereSql()
|
|
22393
22393
|
|
|
22394
|
-
> `static` **removeByWhereSql**(`db`, `where`, `opt
|
|
22394
|
+
> `static` **removeByWhereSql**(`db`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
22395
22395
|
|
|
22396
22396
|
Defined in: [sys/mod.ts:313](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L313)
|
|
22397
22397
|
|
|
@@ -22411,7 +22411,7 @@ Defined in: [sys/mod.ts:313](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22411
22411
|
|
|
22412
22412
|
筛选条件
|
|
22413
22413
|
|
|
22414
|
-
##### opt
|
|
22414
|
+
##### opt?
|
|
22415
22415
|
|
|
22416
22416
|
选项
|
|
22417
22417
|
|
|
@@ -22443,7 +22443,7 @@ Defined in: [sys/mod.ts:313](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22443
22443
|
|
|
22444
22444
|
### select()
|
|
22445
22445
|
|
|
22446
|
-
> `static` **select**\<`T`\>(`db`, `c`, `opt
|
|
22446
|
+
> `static` **select**\<`T`\>(`db`, `c`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
22447
22447
|
|
|
22448
22448
|
Defined in: [sys/mod.ts:522](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L522)
|
|
22449
22449
|
|
|
@@ -22469,7 +22469,7 @@ select 自定字段
|
|
|
22469
22469
|
|
|
22470
22470
|
`string` | `string`[]
|
|
22471
22471
|
|
|
22472
|
-
##### opt
|
|
22472
|
+
##### opt?
|
|
22473
22473
|
|
|
22474
22474
|
选项
|
|
22475
22475
|
|
|
@@ -22537,7 +22537,7 @@ Defined in: [sys/mod.ts:760](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22537
22537
|
|
|
22538
22538
|
### updateByWhere()
|
|
22539
22539
|
|
|
22540
|
-
> `static` **updateByWhere**(`db`, `data`, `where`, `opt
|
|
22540
|
+
> `static` **updateByWhere**(`db`, `data`, `where`, `opt?`): `Promise`\<`number` \| `false` \| `null`\>
|
|
22541
22541
|
|
|
22542
22542
|
Defined in: [sys/mod.ts:346](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L346)
|
|
22543
22543
|
|
|
@@ -22563,7 +22563,7 @@ Defined in: [sys/mod.ts:346](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22563
22563
|
|
|
22564
22564
|
筛选条件
|
|
22565
22565
|
|
|
22566
|
-
##### opt
|
|
22566
|
+
##### opt?
|
|
22567
22567
|
|
|
22568
22568
|
选项
|
|
22569
22569
|
|
|
@@ -22595,7 +22595,7 @@ Defined in: [sys/mod.ts:346](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22595
22595
|
|
|
22596
22596
|
### updateByWhereSql()
|
|
22597
22597
|
|
|
22598
|
-
> `static` **updateByWhereSql**(`db`, `data`, `where`, `opt
|
|
22598
|
+
> `static` **updateByWhereSql**(`db`, `data`, `where`, `opt?`): [`Sql`](../../../lib/sql/classes/Sql.md)
|
|
22599
22599
|
|
|
22600
22600
|
Defined in: [sys/mod.ts:392](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L392)
|
|
22601
22601
|
|
|
@@ -22621,7 +22621,7 @@ Defined in: [sys/mod.ts:392](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22621
22621
|
|
|
22622
22622
|
筛选条件
|
|
22623
22623
|
|
|
22624
|
-
##### opt
|
|
22624
|
+
##### opt?
|
|
22625
22625
|
|
|
22626
22626
|
选项
|
|
22627
22627
|
|
|
@@ -22653,7 +22653,7 @@ Defined in: [sys/mod.ts:392](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22653
22653
|
|
|
22654
22654
|
### updateList()
|
|
22655
22655
|
|
|
22656
|
-
> `static` **updateList**(`db`, `data`, `key`, `opt
|
|
22656
|
+
> `static` **updateList**(`db`, `data`, `key`, `opt?`): `Promise`\<`boolean` \| `null`\>
|
|
22657
22657
|
|
|
22658
22658
|
Defined in: [sys/mod.ts:426](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L426)
|
|
22659
22659
|
|
|
@@ -22679,7 +22679,7 @@ Defined in: [sys/mod.ts:426](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22679
22679
|
|
|
22680
22680
|
用于定位的主键或唯一键字段名
|
|
22681
22681
|
|
|
22682
|
-
##### opt
|
|
22682
|
+
##### opt?
|
|
22683
22683
|
|
|
22684
22684
|
选项
|
|
22685
22685
|
|
|
@@ -22703,7 +22703,7 @@ Defined in: [sys/mod.ts:426](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22703
22703
|
|
|
22704
22704
|
### where()
|
|
22705
22705
|
|
|
22706
|
-
> `static` **where**\<`T`\>(`db`, `s
|
|
22706
|
+
> `static` **where**\<`T`\>(`db`, `s?`, `opt?`): `T` & `Record`\<`string`, `any`\>
|
|
22707
22707
|
|
|
22708
22708
|
Defined in: [sys/mod.ts:552](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L552)
|
|
22709
22709
|
|
|
@@ -22723,13 +22723,13 @@ Defined in: [sys/mod.ts:552](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22723
22723
|
|
|
22724
22724
|
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) | [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22725
22725
|
|
|
22726
|
-
##### s
|
|
22726
|
+
##### s?
|
|
22727
22727
|
|
|
22728
22728
|
`any` = `''`
|
|
22729
22729
|
|
|
22730
22730
|
筛选条件数组或字符串
|
|
22731
22731
|
|
|
22732
|
-
##### opt
|
|
22732
|
+
##### opt?
|
|
22733
22733
|
|
|
22734
22734
|
选项
|
|
22735
22735
|
|
|
@@ -22794,13 +22794,13 @@ Defined in: [sys/mod.ts:19](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
22794
22794
|
|
|
22795
22795
|
### Constructor
|
|
22796
22796
|
|
|
22797
|
-
> **new Rows**\<`T`\>(`initialItems
|
|
22797
|
+
> **new Rows**\<`T`\>(`initialItems?`): `Rows`\<`T`\>
|
|
22798
22798
|
|
|
22799
22799
|
Defined in: [sys/mod.ts:23](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L23)
|
|
22800
22800
|
|
|
22801
22801
|
#### Parameters
|
|
22802
22802
|
|
|
22803
|
-
##### initialItems
|
|
22803
|
+
##### initialItems?
|
|
22804
22804
|
|
|
22805
22805
|
`T`[] = `[]`
|
|
22806
22806
|
|
|
@@ -23104,7 +23104,7 @@ sys/route/functions/getFormData.md
|
|
|
23104
23104
|
|
|
23105
23105
|
# Function: getFormData()
|
|
23106
23106
|
|
|
23107
|
-
> **getFormData**(`req`, `events
|
|
23107
|
+
> **getFormData**(`req`, `events?`): `Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|
|
23108
23108
|
|
|
23109
23109
|
Defined in: [sys/route.ts:932](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L932)
|
|
23110
23110
|
|
|
@@ -23118,7 +23118,7 @@ Defined in: [sys/route.ts:932](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
23118
23118
|
|
|
23119
23119
|
`IncomingMessage` | `Http2ServerRequest`
|
|
23120
23120
|
|
|
23121
|
-
### events
|
|
23121
|
+
### events?
|
|
23122
23122
|
|
|
23123
23123
|
文件处理情况
|
|
23124
23124
|
|