@maiyunnet/kebab 8.6.5 → 9.0.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 +1040 -697
- package/index.d.ts +1 -9
- package/index.js +1 -1
- package/lib/core.d.ts +12 -0
- package/lib/core.js +93 -22
- package/lib/cron.js +84 -33
- package/lib/db.d.ts +2 -0
- package/lib/db.js +3 -1
- package/lib/ratelimit.d.ts +47 -0
- package/lib/ratelimit.js +88 -0
- package/package.json +20 -13
- package/sys/child.js +2 -0
- package/sys/cmd.js +153 -0
- package/sys/ctr.d.ts +46 -5
- package/sys/ctr.js +135 -11
- package/sys/master.js +96 -2
- package/sys/route.d.ts +6 -0
- package/sys/route.js +24 -3
- package/www/example/ctr/test.d.ts +34 -0
- package/www/example/ctr/test.js +140 -0
- package/www/example/route.json +2 -1
- package/www/example/stc/view/react-page.bundle.js +97 -0
- package/www/example/stc/view/react-page.css +2 -0
- package/www/example/stc/view/react-page.d.ts +50 -0
- package/www/example/stc/view/react-page.js +136 -0
- package/www/example/stc/view/react-page.tsx +448 -0
- package/www/example/stc/view/react-router-page.bundle.js +81 -0
- package/www/example/stc/view/react-router-page.css +2 -0
- package/www/example/stc/view/react-router-page.d.ts +58 -0
- package/www/example/stc/view/react-router-page.js +142 -0
- package/www/example/stc/view/react-router-page.tsx +426 -0
package/doc/kebab-rag.md
CHANGED
|
@@ -86,6 +86,7 @@ index.md
|
|
|
86
86
|
- [lib/net/formdata](lib/net/formdata/index.md)
|
|
87
87
|
- [lib/net/request](lib/net/request/index.md)
|
|
88
88
|
- [lib/net/response](lib/net/response/index.md)
|
|
89
|
+
- [lib/ratelimit](lib/ratelimit/index.md)
|
|
89
90
|
- [lib/s3](lib/s3/index.md)
|
|
90
91
|
- [lib/scan](lib/scan/index.md)
|
|
91
92
|
- [lib/session](lib/session/index.md)
|
|
@@ -124,7 +125,6 @@ index/index.md
|
|
|
124
125
|
- [IConfigConst](interfaces/IConfigConst.md)
|
|
125
126
|
- [IConfigDb](interfaces/IConfigDb.md)
|
|
126
127
|
- [IConfigDns](interfaces/IConfigDns.md)
|
|
127
|
-
- [IConfigJwt](interfaces/IConfigJwt.md)
|
|
128
128
|
- [IConfigKv](interfaces/IConfigKv.md)
|
|
129
129
|
- [IConfigLang](interfaces/IConfigLang.md)
|
|
130
130
|
- [IConfigS3](interfaces/IConfigS3.md)
|
|
@@ -174,7 +174,7 @@ Defined in: [index.ts:52](https://github.com/maiyunnet/kebab/blob/master/index.t
|
|
|
174
174
|
|
|
175
175
|
## Indexable
|
|
176
176
|
|
|
177
|
-
\[`key`: `string`\]: `Record`\<`string`, `any`\>
|
|
177
|
+
> \[`key`: `string`\]: `Record`\<`string`, `any`\>
|
|
178
178
|
|
|
179
179
|
## Properties
|
|
180
180
|
|
|
@@ -345,7 +345,7 @@ AI
|
|
|
345
345
|
|
|
346
346
|
### endpoint?
|
|
347
347
|
|
|
348
|
-
> `optional` **endpoint
|
|
348
|
+
> `optional` **endpoint?**: `string`
|
|
349
349
|
|
|
350
350
|
Defined in: [index.ts:122](https://github.com/maiyunnet/kebab/blob/master/index.ts#L122)
|
|
351
351
|
|
|
@@ -370,7 +370,7 @@ index/interfaces/IConfigConst.md
|
|
|
370
370
|
|
|
371
371
|
# Interface: IConfigConst
|
|
372
372
|
|
|
373
|
-
Defined in: [index.ts:
|
|
373
|
+
Defined in: [index.ts:183](https://github.com/maiyunnet/kebab/blob/master/index.ts#L183)
|
|
374
374
|
|
|
375
375
|
常量
|
|
376
376
|
|
|
@@ -380,7 +380,7 @@ Defined in: [index.ts:192](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
380
380
|
|
|
381
381
|
> **ctrPath**: `string`
|
|
382
382
|
|
|
383
|
-
Defined in: [index.ts:
|
|
383
|
+
Defined in: [index.ts:208](https://github.com/maiyunnet/kebab/blob/master/index.ts#L208)
|
|
384
384
|
|
|
385
385
|
***
|
|
386
386
|
|
|
@@ -388,7 +388,7 @@ Defined in: [index.ts:217](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
388
388
|
|
|
389
389
|
> **dataPath**: `string`
|
|
390
390
|
|
|
391
|
-
Defined in: [index.ts:
|
|
391
|
+
Defined in: [index.ts:210](https://github.com/maiyunnet/kebab/blob/master/index.ts#L210)
|
|
392
392
|
|
|
393
393
|
***
|
|
394
394
|
|
|
@@ -396,7 +396,7 @@ Defined in: [index.ts:219](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
396
396
|
|
|
397
397
|
> **host**: `string`
|
|
398
398
|
|
|
399
|
-
Defined in: [index.ts:
|
|
399
|
+
Defined in: [index.ts:199](https://github.com/maiyunnet/kebab/blob/master/index.ts#L199)
|
|
400
400
|
|
|
401
401
|
***
|
|
402
402
|
|
|
@@ -404,7 +404,7 @@ Defined in: [index.ts:208](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
404
404
|
|
|
405
405
|
> **hostname**: `string`
|
|
406
406
|
|
|
407
|
-
Defined in: [index.ts:
|
|
407
|
+
Defined in: [index.ts:200](https://github.com/maiyunnet/kebab/blob/master/index.ts#L200)
|
|
408
408
|
|
|
409
409
|
***
|
|
410
410
|
|
|
@@ -412,7 +412,7 @@ Defined in: [index.ts:209](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
412
412
|
|
|
413
413
|
> **hostport**: `number`
|
|
414
414
|
|
|
415
|
-
Defined in: [index.ts:
|
|
415
|
+
Defined in: [index.ts:201](https://github.com/maiyunnet/kebab/blob/master/index.ts#L201)
|
|
416
416
|
|
|
417
417
|
***
|
|
418
418
|
|
|
@@ -420,7 +420,7 @@ Defined in: [index.ts:210](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
420
420
|
|
|
421
421
|
> **https**: `boolean`
|
|
422
422
|
|
|
423
|
-
Defined in: [index.ts:
|
|
423
|
+
Defined in: [index.ts:198](https://github.com/maiyunnet/kebab/blob/master/index.ts#L198)
|
|
424
424
|
|
|
425
425
|
***
|
|
426
426
|
|
|
@@ -428,7 +428,7 @@ Defined in: [index.ts:207](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
428
428
|
|
|
429
429
|
> **miniprogram**: `""` \| `"wechat"`
|
|
430
430
|
|
|
431
|
-
Defined in: [index.ts:
|
|
431
|
+
Defined in: [index.ts:197](https://github.com/maiyunnet/kebab/blob/master/index.ts#L197)
|
|
432
432
|
|
|
433
433
|
***
|
|
434
434
|
|
|
@@ -436,7 +436,7 @@ Defined in: [index.ts:206](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
436
436
|
|
|
437
437
|
> **mobile**: `boolean`
|
|
438
438
|
|
|
439
|
-
Defined in: [index.ts:
|
|
439
|
+
Defined in: [index.ts:195](https://github.com/maiyunnet/kebab/blob/master/index.ts#L195)
|
|
440
440
|
|
|
441
441
|
***
|
|
442
442
|
|
|
@@ -444,7 +444,7 @@ Defined in: [index.ts:204](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
444
444
|
|
|
445
445
|
> **modPath**: `string`
|
|
446
446
|
|
|
447
|
-
Defined in: [index.ts:
|
|
447
|
+
Defined in: [index.ts:207](https://github.com/maiyunnet/kebab/blob/master/index.ts#L207)
|
|
448
448
|
|
|
449
449
|
***
|
|
450
450
|
|
|
@@ -452,7 +452,7 @@ Defined in: [index.ts:216](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
452
452
|
|
|
453
453
|
> **path**: `string`
|
|
454
454
|
|
|
455
|
-
Defined in: [index.ts:
|
|
455
|
+
Defined in: [index.ts:185](https://github.com/maiyunnet/kebab/blob/master/index.ts#L185)
|
|
456
456
|
|
|
457
457
|
不以 / 开头,不含 qs
|
|
458
458
|
|
|
@@ -462,7 +462,7 @@ Defined in: [index.ts:194](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
462
462
|
|
|
463
463
|
> **qs**: `string`
|
|
464
464
|
|
|
465
|
-
Defined in: [index.ts:
|
|
465
|
+
Defined in: [index.ts:187](https://github.com/maiyunnet/kebab/blob/master/index.ts#L187)
|
|
466
466
|
|
|
467
467
|
不含 ? 开头
|
|
468
468
|
|
|
@@ -472,7 +472,7 @@ Defined in: [index.ts:196](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
472
472
|
|
|
473
473
|
> **qss**: `string`
|
|
474
474
|
|
|
475
|
-
Defined in: [index.ts:
|
|
475
|
+
Defined in: [index.ts:189](https://github.com/maiyunnet/kebab/blob/master/index.ts#L189)
|
|
476
476
|
|
|
477
477
|
含 ? 开头
|
|
478
478
|
|
|
@@ -482,7 +482,7 @@ Defined in: [index.ts:198](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
482
482
|
|
|
483
483
|
> **rootPath**: `string`
|
|
484
484
|
|
|
485
|
-
Defined in: [index.ts:
|
|
485
|
+
Defined in: [index.ts:206](https://github.com/maiyunnet/kebab/blob/master/index.ts#L206)
|
|
486
486
|
|
|
487
487
|
***
|
|
488
488
|
|
|
@@ -490,7 +490,7 @@ Defined in: [index.ts:215](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
490
490
|
|
|
491
491
|
> **startMemory**: `number`
|
|
492
492
|
|
|
493
|
-
Defined in: [index.ts:
|
|
493
|
+
Defined in: [index.ts:191](https://github.com/maiyunnet/kebab/blob/master/index.ts#L191)
|
|
494
494
|
|
|
495
495
|
***
|
|
496
496
|
|
|
@@ -498,7 +498,7 @@ Defined in: [index.ts:200](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
498
498
|
|
|
499
499
|
> **startTime**: `bigint`
|
|
500
500
|
|
|
501
|
-
Defined in: [index.ts:
|
|
501
|
+
Defined in: [index.ts:190](https://github.com/maiyunnet/kebab/blob/master/index.ts#L190)
|
|
502
502
|
|
|
503
503
|
***
|
|
504
504
|
|
|
@@ -506,7 +506,7 @@ Defined in: [index.ts:199](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
506
506
|
|
|
507
507
|
> **uri**: [`IUrlParse`](IUrlParse.md)
|
|
508
508
|
|
|
509
|
-
Defined in: [index.ts:
|
|
509
|
+
Defined in: [index.ts:202](https://github.com/maiyunnet/kebab/blob/master/index.ts#L202)
|
|
510
510
|
|
|
511
511
|
***
|
|
512
512
|
|
|
@@ -514,7 +514,7 @@ Defined in: [index.ts:211](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
514
514
|
|
|
515
515
|
> **urlBase**: `string`
|
|
516
516
|
|
|
517
|
-
Defined in: [index.ts:
|
|
517
|
+
Defined in: [index.ts:215](https://github.com/maiyunnet/kebab/blob/master/index.ts#L215)
|
|
518
518
|
|
|
519
519
|
***
|
|
520
520
|
|
|
@@ -522,7 +522,7 @@ Defined in: [index.ts:224](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
522
522
|
|
|
523
523
|
> **urlFull**: `string`
|
|
524
524
|
|
|
525
|
-
Defined in: [index.ts:
|
|
525
|
+
Defined in: [index.ts:217](https://github.com/maiyunnet/kebab/blob/master/index.ts#L217)
|
|
526
526
|
|
|
527
527
|
***
|
|
528
528
|
|
|
@@ -530,7 +530,7 @@ Defined in: [index.ts:226](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
530
530
|
|
|
531
531
|
> **urlStc**: `string`
|
|
532
532
|
|
|
533
|
-
Defined in: [index.ts:
|
|
533
|
+
Defined in: [index.ts:216](https://github.com/maiyunnet/kebab/blob/master/index.ts#L216)
|
|
534
534
|
|
|
535
535
|
***
|
|
536
536
|
|
|
@@ -538,7 +538,7 @@ Defined in: [index.ts:225](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
538
538
|
|
|
539
539
|
> **urlStcFull**: `string`
|
|
540
540
|
|
|
541
|
-
Defined in: [index.ts:
|
|
541
|
+
Defined in: [index.ts:218](https://github.com/maiyunnet/kebab/blob/master/index.ts#L218)
|
|
542
542
|
|
|
543
543
|
***
|
|
544
544
|
|
|
@@ -546,7 +546,7 @@ Defined in: [index.ts:227](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
546
546
|
|
|
547
547
|
> **viewPath**: `string`
|
|
548
548
|
|
|
549
|
-
Defined in: [index.ts:
|
|
549
|
+
Defined in: [index.ts:209](https://github.com/maiyunnet/kebab/blob/master/index.ts#L209)
|
|
550
550
|
|
|
551
551
|
***
|
|
552
552
|
|
|
@@ -554,7 +554,7 @@ Defined in: [index.ts:218](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
554
554
|
|
|
555
555
|
> **wechat**: `boolean`
|
|
556
556
|
|
|
557
|
-
Defined in: [index.ts:
|
|
557
|
+
Defined in: [index.ts:196](https://github.com/maiyunnet/kebab/blob/master/index.ts#L196)
|
|
558
558
|
|
|
559
559
|
***
|
|
560
560
|
|
|
@@ -562,7 +562,7 @@ Defined in: [index.ts:205](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
562
562
|
|
|
563
563
|
> **wsPath**: `string`
|
|
564
564
|
|
|
565
|
-
Defined in: [index.ts:
|
|
565
|
+
Defined in: [index.ts:211](https://github.com/maiyunnet/kebab/blob/master/index.ts#L211)
|
|
566
566
|
|
|
567
567
|
index/interfaces/IConfigDb.md
|
|
568
568
|
---
|
|
@@ -583,7 +583,7 @@ Defined in: [index.ts:150](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
583
583
|
|
|
584
584
|
### charset?
|
|
585
585
|
|
|
586
|
-
> `optional` **charset
|
|
586
|
+
> `optional` **charset?**: `string`
|
|
587
587
|
|
|
588
588
|
Defined in: [index.ts:153](https://github.com/maiyunnet/kebab/blob/master/index.ts#L153)
|
|
589
589
|
|
|
@@ -599,7 +599,7 @@ Defined in: [index.ts:151](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
599
599
|
|
|
600
600
|
### name?
|
|
601
601
|
|
|
602
|
-
> `optional` **name
|
|
602
|
+
> `optional` **name?**: `string`
|
|
603
603
|
|
|
604
604
|
Defined in: [index.ts:154](https://github.com/maiyunnet/kebab/blob/master/index.ts#L154)
|
|
605
605
|
|
|
@@ -638,7 +638,7 @@ index/interfaces/IConfigDns.md
|
|
|
638
638
|
|
|
639
639
|
# Interface: IConfigDns
|
|
640
640
|
|
|
641
|
-
Defined in: [index.ts:
|
|
641
|
+
Defined in: [index.ts:161](https://github.com/maiyunnet/kebab/blob/master/index.ts#L161)
|
|
642
642
|
|
|
643
643
|
DNS
|
|
644
644
|
|
|
@@ -648,7 +648,7 @@ DNS
|
|
|
648
648
|
|
|
649
649
|
> **sid**: `string`
|
|
650
650
|
|
|
651
|
-
Defined in: [index.ts:
|
|
651
|
+
Defined in: [index.ts:162](https://github.com/maiyunnet/kebab/blob/master/index.ts#L162)
|
|
652
652
|
|
|
653
653
|
***
|
|
654
654
|
|
|
@@ -656,61 +656,6 @@ Defined in: [index.ts:171](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
656
656
|
|
|
657
657
|
> **skey**: `string`
|
|
658
658
|
|
|
659
|
-
Defined in: [index.ts:172](https://github.com/maiyunnet/kebab/blob/master/index.ts#L172)
|
|
660
|
-
|
|
661
|
-
index/interfaces/IConfigJwt.md
|
|
662
|
-
---
|
|
663
|
-
|
|
664
|
-
[**Documents for @maiyunnet/kebab**](../../index.md)
|
|
665
|
-
|
|
666
|
-
***
|
|
667
|
-
|
|
668
|
-
[Documents for @maiyunnet/kebab](../../index.md) / [index](../index.md) / IConfigJwt
|
|
669
|
-
|
|
670
|
-
# Interface: IConfigJwt
|
|
671
|
-
|
|
672
|
-
Defined in: [index.ts:161](https://github.com/maiyunnet/kebab/blob/master/index.ts#L161)
|
|
673
|
-
|
|
674
|
-
Jwt 信息
|
|
675
|
-
|
|
676
|
-
## Properties
|
|
677
|
-
|
|
678
|
-
### auth
|
|
679
|
-
|
|
680
|
-
> **auth**: `boolean`
|
|
681
|
-
|
|
682
|
-
Defined in: [index.ts:166](https://github.com/maiyunnet/kebab/blob/master/index.ts#L166)
|
|
683
|
-
|
|
684
|
-
***
|
|
685
|
-
|
|
686
|
-
### name
|
|
687
|
-
|
|
688
|
-
> **name**: `string`
|
|
689
|
-
|
|
690
|
-
Defined in: [index.ts:162](https://github.com/maiyunnet/kebab/blob/master/index.ts#L162)
|
|
691
|
-
|
|
692
|
-
***
|
|
693
|
-
|
|
694
|
-
### secret
|
|
695
|
-
|
|
696
|
-
> **secret**: `string`
|
|
697
|
-
|
|
698
|
-
Defined in: [index.ts:165](https://github.com/maiyunnet/kebab/blob/master/index.ts#L165)
|
|
699
|
-
|
|
700
|
-
***
|
|
701
|
-
|
|
702
|
-
### ssl
|
|
703
|
-
|
|
704
|
-
> **ssl**: `boolean`
|
|
705
|
-
|
|
706
|
-
Defined in: [index.ts:164](https://github.com/maiyunnet/kebab/blob/master/index.ts#L164)
|
|
707
|
-
|
|
708
|
-
***
|
|
709
|
-
|
|
710
|
-
### ttl
|
|
711
|
-
|
|
712
|
-
> **ttl**: `number`
|
|
713
|
-
|
|
714
659
|
Defined in: [index.ts:163](https://github.com/maiyunnet/kebab/blob/master/index.ts#L163)
|
|
715
660
|
|
|
716
661
|
index/interfaces/IConfigKv.md
|
|
@@ -724,7 +669,7 @@ index/interfaces/IConfigKv.md
|
|
|
724
669
|
|
|
725
670
|
# Interface: IConfigKv
|
|
726
671
|
|
|
727
|
-
Defined in: [index.ts:
|
|
672
|
+
Defined in: [index.ts:167](https://github.com/maiyunnet/kebab/blob/master/index.ts#L167)
|
|
728
673
|
|
|
729
674
|
kv
|
|
730
675
|
|
|
@@ -734,7 +679,7 @@ kv
|
|
|
734
679
|
|
|
735
680
|
> **host**: `string`
|
|
736
681
|
|
|
737
|
-
Defined in: [index.ts:
|
|
682
|
+
Defined in: [index.ts:168](https://github.com/maiyunnet/kebab/blob/master/index.ts#L168)
|
|
738
683
|
|
|
739
684
|
***
|
|
740
685
|
|
|
@@ -742,7 +687,7 @@ Defined in: [index.ts:177](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
742
687
|
|
|
743
688
|
> **index**: `number`
|
|
744
689
|
|
|
745
|
-
Defined in: [index.ts:
|
|
690
|
+
Defined in: [index.ts:170](https://github.com/maiyunnet/kebab/blob/master/index.ts#L170)
|
|
746
691
|
|
|
747
692
|
***
|
|
748
693
|
|
|
@@ -750,7 +695,7 @@ Defined in: [index.ts:179](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
750
695
|
|
|
751
696
|
> **port**: `number`
|
|
752
697
|
|
|
753
|
-
Defined in: [index.ts:
|
|
698
|
+
Defined in: [index.ts:169](https://github.com/maiyunnet/kebab/blob/master/index.ts#L169)
|
|
754
699
|
|
|
755
700
|
***
|
|
756
701
|
|
|
@@ -758,7 +703,7 @@ Defined in: [index.ts:178](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
758
703
|
|
|
759
704
|
> **pre**: `string`
|
|
760
705
|
|
|
761
|
-
Defined in: [index.ts:
|
|
706
|
+
Defined in: [index.ts:171](https://github.com/maiyunnet/kebab/blob/master/index.ts#L171)
|
|
762
707
|
|
|
763
708
|
***
|
|
764
709
|
|
|
@@ -766,7 +711,7 @@ Defined in: [index.ts:180](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
766
711
|
|
|
767
712
|
> **pwd**: `string`
|
|
768
713
|
|
|
769
|
-
Defined in: [index.ts:
|
|
714
|
+
Defined in: [index.ts:174](https://github.com/maiyunnet/kebab/blob/master/index.ts#L174)
|
|
770
715
|
|
|
771
716
|
***
|
|
772
717
|
|
|
@@ -774,7 +719,7 @@ Defined in: [index.ts:183](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
774
719
|
|
|
775
720
|
> **user**: `string`
|
|
776
721
|
|
|
777
|
-
Defined in: [index.ts:
|
|
722
|
+
Defined in: [index.ts:173](https://github.com/maiyunnet/kebab/blob/master/index.ts#L173)
|
|
778
723
|
|
|
779
724
|
index/interfaces/IConfigLang.md
|
|
780
725
|
---
|
|
@@ -826,7 +771,7 @@ Defined in: [index.ts:110](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
826
771
|
|
|
827
772
|
### account?
|
|
828
773
|
|
|
829
|
-
> `optional` **account
|
|
774
|
+
> `optional` **account?**: `string`
|
|
830
775
|
|
|
831
776
|
Defined in: [index.ts:112](https://github.com/maiyunnet/kebab/blob/master/index.ts#L112)
|
|
832
777
|
|
|
@@ -875,7 +820,7 @@ index/interfaces/IConfigSql.md
|
|
|
875
820
|
|
|
876
821
|
# Interface: IConfigSql
|
|
877
822
|
|
|
878
|
-
Defined in: [index.ts:
|
|
823
|
+
Defined in: [index.ts:178](https://github.com/maiyunnet/kebab/blob/master/index.ts#L178)
|
|
879
824
|
|
|
880
825
|
sql
|
|
881
826
|
|
|
@@ -885,7 +830,7 @@ sql
|
|
|
885
830
|
|
|
886
831
|
> **pre**: `string`
|
|
887
832
|
|
|
888
|
-
Defined in: [index.ts:
|
|
833
|
+
Defined in: [index.ts:179](https://github.com/maiyunnet/kebab/blob/master/index.ts#L179)
|
|
889
834
|
|
|
890
835
|
index/interfaces/IConfigTurnstile.md
|
|
891
836
|
---
|
|
@@ -1008,7 +953,7 @@ index/interfaces/IPostFile.md
|
|
|
1008
953
|
|
|
1009
954
|
# Interface: IPostFile
|
|
1010
955
|
|
|
1011
|
-
Defined in: [index.ts:
|
|
956
|
+
Defined in: [index.ts:230](https://github.com/maiyunnet/kebab/blob/master/index.ts#L230)
|
|
1012
957
|
|
|
1013
958
|
上传的文件信息对象
|
|
1014
959
|
|
|
@@ -1018,7 +963,7 @@ Defined in: [index.ts:239](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1018
963
|
|
|
1019
964
|
> `readonly` **name**: `string`
|
|
1020
965
|
|
|
1021
|
-
Defined in: [index.ts:
|
|
966
|
+
Defined in: [index.ts:231](https://github.com/maiyunnet/kebab/blob/master/index.ts#L231)
|
|
1022
967
|
|
|
1023
968
|
***
|
|
1024
969
|
|
|
@@ -1026,7 +971,7 @@ Defined in: [index.ts:240](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1026
971
|
|
|
1027
972
|
> `readonly` **origin**: `string`
|
|
1028
973
|
|
|
1029
|
-
Defined in: [index.ts:
|
|
974
|
+
Defined in: [index.ts:232](https://github.com/maiyunnet/kebab/blob/master/index.ts#L232)
|
|
1030
975
|
|
|
1031
976
|
***
|
|
1032
977
|
|
|
@@ -1034,7 +979,7 @@ Defined in: [index.ts:241](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1034
979
|
|
|
1035
980
|
> `readonly` **path**: `string`
|
|
1036
981
|
|
|
1037
|
-
Defined in: [index.ts:
|
|
982
|
+
Defined in: [index.ts:234](https://github.com/maiyunnet/kebab/blob/master/index.ts#L234)
|
|
1038
983
|
|
|
1039
984
|
***
|
|
1040
985
|
|
|
@@ -1042,7 +987,7 @@ Defined in: [index.ts:243](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1042
987
|
|
|
1043
988
|
> `readonly` **size**: `number`
|
|
1044
989
|
|
|
1045
|
-
Defined in: [index.ts:
|
|
990
|
+
Defined in: [index.ts:233](https://github.com/maiyunnet/kebab/blob/master/index.ts#L233)
|
|
1046
991
|
|
|
1047
992
|
index/interfaces/IUrlParse.md
|
|
1048
993
|
---
|
|
@@ -1156,7 +1101,7 @@ index/interfaces/IVhost.md
|
|
|
1156
1101
|
|
|
1157
1102
|
# Interface: IVhost
|
|
1158
1103
|
|
|
1159
|
-
Defined in: [index.ts:
|
|
1104
|
+
Defined in: [index.ts:222](https://github.com/maiyunnet/kebab/blob/master/index.ts#L222)
|
|
1160
1105
|
|
|
1161
1106
|
虚拟机配置对象
|
|
1162
1107
|
|
|
@@ -1166,23 +1111,23 @@ Defined in: [index.ts:231](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1166
1111
|
|
|
1167
1112
|
> `readonly` **domains**: `string`[]
|
|
1168
1113
|
|
|
1169
|
-
Defined in: [index.ts:
|
|
1114
|
+
Defined in: [index.ts:224](https://github.com/maiyunnet/kebab/blob/master/index.ts#L224)
|
|
1170
1115
|
|
|
1171
1116
|
***
|
|
1172
1117
|
|
|
1173
1118
|
### name?
|
|
1174
1119
|
|
|
1175
|
-
> `readonly` `optional` **name
|
|
1120
|
+
> `readonly` `optional` **name?**: `string`
|
|
1176
1121
|
|
|
1177
|
-
Defined in: [index.ts:
|
|
1122
|
+
Defined in: [index.ts:223](https://github.com/maiyunnet/kebab/blob/master/index.ts#L223)
|
|
1178
1123
|
|
|
1179
1124
|
***
|
|
1180
1125
|
|
|
1181
1126
|
### remark?
|
|
1182
1127
|
|
|
1183
|
-
> `readonly` `optional` **remark
|
|
1128
|
+
> `readonly` `optional` **remark?**: `string`
|
|
1184
1129
|
|
|
1185
|
-
Defined in: [index.ts:
|
|
1130
|
+
Defined in: [index.ts:226](https://github.com/maiyunnet/kebab/blob/master/index.ts#L226)
|
|
1186
1131
|
|
|
1187
1132
|
***
|
|
1188
1133
|
|
|
@@ -1190,7 +1135,7 @@ Defined in: [index.ts:235](https://github.com/maiyunnet/kebab/blob/master/index.
|
|
|
1190
1135
|
|
|
1191
1136
|
> `readonly` **root**: `string`
|
|
1192
1137
|
|
|
1193
|
-
Defined in: [index.ts:
|
|
1138
|
+
Defined in: [index.ts:225](https://github.com/maiyunnet/kebab/blob/master/index.ts#L225)
|
|
1194
1139
|
|
|
1195
1140
|
index/type-aliases/DbValue.md
|
|
1196
1141
|
---
|
|
@@ -1410,7 +1355,7 @@ index/variables/VER.md
|
|
|
1410
1355
|
|
|
1411
1356
|
# Variable: VER
|
|
1412
1357
|
|
|
1413
|
-
> `const` **VER**: `"
|
|
1358
|
+
> `const` **VER**: `"9.0.0"` = `'9.0.0'`
|
|
1414
1359
|
|
|
1415
1360
|
Defined in: [index.ts:10](https://github.com/maiyunnet/kebab/blob/master/index.ts#L10)
|
|
1416
1361
|
|
|
@@ -1471,7 +1416,7 @@ Defined in: [lib/ai.ts:71](https://github.com/maiyunnet/kebab/blob/master/lib/ai
|
|
|
1471
1416
|
|
|
1472
1417
|
##### ctrEtc
|
|
1473
1418
|
|
|
1474
|
-
[`IConfigAi`](../../../index/interfaces/IConfigAi.md)
|
|
1419
|
+
[`IConfigAi`](../../../index/interfaces/IConfigAi.md) \| [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
1475
1420
|
|
|
1476
1421
|
##### opt
|
|
1477
1422
|
|
|
@@ -1635,7 +1580,7 @@ Defined in: [lib/ai.ts:191](https://github.com/maiyunnet/kebab/blob/master/lib/a
|
|
|
1635
1580
|
|
|
1636
1581
|
### poll()
|
|
1637
1582
|
|
|
1638
|
-
> **poll**(`opt`): `Promise`\<`false` \| \{ `add?`: `number`; `end?`: `number`; `error?`: `string`; `start?`: `number`; `status`: `"
|
|
1583
|
+
> **poll**(`opt`): `Promise`\<`false` \| \{ `add?`: `number`; `end?`: `number`; `error?`: `string`; `start?`: `number`; `status`: `"FAILED"` \| `"PENDING"` \| `"RUNNING"` \| `"SUCCEEDED"` \| `"CANCELED"` \| `"UNKNOWN"`; `task`: `string`; `url?`: `string`; \}\>
|
|
1639
1584
|
|
|
1640
1585
|
Defined in: [lib/ai.ts:539](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L539)
|
|
1641
1586
|
|
|
@@ -1655,13 +1600,13 @@ Defined in: [lib/ai.ts:539](https://github.com/maiyunnet/kebab/blob/master/lib/a
|
|
|
1655
1600
|
|
|
1656
1601
|
#### Returns
|
|
1657
1602
|
|
|
1658
|
-
`Promise`\<`false` \| \{ `add?`: `number`; `end?`: `number`; `error?`: `string`; `start?`: `number`; `status`: `"
|
|
1603
|
+
`Promise`\<`false` \| \{ `add?`: `number`; `end?`: `number`; `error?`: `string`; `start?`: `number`; `status`: `"FAILED"` \| `"PENDING"` \| `"RUNNING"` \| `"SUCCEEDED"` \| `"CANCELED"` \| `"UNKNOWN"`; `task`: `string`; `url?`: `string`; \}\>
|
|
1659
1604
|
|
|
1660
1605
|
***
|
|
1661
1606
|
|
|
1662
1607
|
### video()
|
|
1663
1608
|
|
|
1664
|
-
> **video**(`opt`): `Promise`\<`false` \| \{ `request`: `string`; `seed`: `number`; `status`: `"
|
|
1609
|
+
> **video**(`opt`): `Promise`\<`false` \| \{ `request`: `string`; `seed`: `number`; `status`: `"FAILED"` \| `"PENDING"` \| `"RUNNING"` \| `"SUCCEEDED"` \| `"CANCELED"` \| `"UNKNOWN"`; `task`: `string`; \}\>
|
|
1665
1610
|
|
|
1666
1611
|
Defined in: [lib/ai.ts:371](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L371)
|
|
1667
1612
|
|
|
@@ -1735,13 +1680,13 @@ Defined in: [lib/ai.ts:371](https://github.com/maiyunnet/kebab/blob/master/lib/a
|
|
|
1735
1680
|
|
|
1736
1681
|
###### shot?
|
|
1737
1682
|
|
|
1738
|
-
`"
|
|
1683
|
+
`"single"` \| `"multi"`
|
|
1739
1684
|
|
|
1740
1685
|
镜头,默认单镜头 single
|
|
1741
1686
|
|
|
1742
1687
|
#### Returns
|
|
1743
1688
|
|
|
1744
|
-
`Promise`\<`false` \| \{ `request`: `string`; `seed`: `number`; `status`: `"
|
|
1689
|
+
`Promise`\<`false` \| \{ `request`: `string`; `seed`: `number`; `status`: `"FAILED"` \| `"PENDING"` \| `"RUNNING"` \| `"SUCCEEDED"` \| `"CANCELED"` \| `"UNKNOWN"`; `task`: `string`; \}\>
|
|
1745
1690
|
|
|
1746
1691
|
lib/ai/enumerations/ESERVICE.md
|
|
1747
1692
|
---
|
|
@@ -1869,7 +1814,7 @@ Defined in: [lib/ai.ts:594](https://github.com/maiyunnet/kebab/blob/master/lib/a
|
|
|
1869
1814
|
|
|
1870
1815
|
### ctrEtc
|
|
1871
1816
|
|
|
1872
|
-
[`IConfigAi`](../../../index/interfaces/IConfigAi.md)
|
|
1817
|
+
[`IConfigAi`](../../../index/interfaces/IConfigAi.md) \| [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
1873
1818
|
|
|
1874
1819
|
### opt
|
|
1875
1820
|
|
|
@@ -1927,7 +1872,7 @@ Defined in: [lib/ai.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/ai
|
|
|
1927
1872
|
|
|
1928
1873
|
### endpoint?
|
|
1929
1874
|
|
|
1930
|
-
> `optional` **endpoint
|
|
1875
|
+
> `optional` **endpoint?**: `string`
|
|
1931
1876
|
|
|
1932
1877
|
Defined in: [lib/ai.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L45)
|
|
1933
1878
|
|
|
@@ -1935,9 +1880,9 @@ Defined in: [lib/ai.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/ai
|
|
|
1935
1880
|
|
|
1936
1881
|
***
|
|
1937
1882
|
|
|
1938
|
-
### fetch
|
|
1883
|
+
### fetch?
|
|
1939
1884
|
|
|
1940
|
-
> `optional` **fetch
|
|
1885
|
+
> `optional` **fetch?**: (`input`, `init?`) => `Promise`\<`Response`\>
|
|
1941
1886
|
|
|
1942
1887
|
Defined in: [lib/ai.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L49)
|
|
1943
1888
|
|
|
@@ -1947,7 +1892,7 @@ Defined in: [lib/ai.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/ai
|
|
|
1947
1892
|
|
|
1948
1893
|
##### input
|
|
1949
1894
|
|
|
1950
|
-
`string`
|
|
1895
|
+
`string` \| `Request` \| `URL`
|
|
1951
1896
|
|
|
1952
1897
|
##### init?
|
|
1953
1898
|
|
|
@@ -1961,7 +1906,7 @@ Defined in: [lib/ai.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/ai
|
|
|
1961
1906
|
|
|
1962
1907
|
### secretKey?
|
|
1963
1908
|
|
|
1964
|
-
> `optional` **secretKey
|
|
1909
|
+
> `optional` **secretKey?**: `string`
|
|
1965
1910
|
|
|
1966
1911
|
Defined in: [lib/ai.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/ai.ts#L47)
|
|
1967
1912
|
|
|
@@ -2576,9 +2521,9 @@ Defined in: [lib/consistent.ts:34](https://github.com/maiyunnet/kebab/blob/maste
|
|
|
2576
2521
|
|
|
2577
2522
|
##### node
|
|
2578
2523
|
|
|
2579
|
-
|
|
2524
|
+
`string` \| `string`[]
|
|
2580
2525
|
|
|
2581
|
-
|
|
2526
|
+
node 节点名一个或多个
|
|
2582
2527
|
|
|
2583
2528
|
#### Returns
|
|
2584
2529
|
|
|
@@ -2598,9 +2543,9 @@ Defined in: [lib/consistent.ts:59](https://github.com/maiyunnet/kebab/blob/maste
|
|
|
2598
2543
|
|
|
2599
2544
|
##### key
|
|
2600
2545
|
|
|
2601
|
-
|
|
2546
|
+
`string` \| `number`
|
|
2602
2547
|
|
|
2603
|
-
|
|
2548
|
+
为给定键取 Hash,取得顺时针方向上最近的一个虚拟节点对应的实际节点
|
|
2604
2549
|
|
|
2605
2550
|
#### Returns
|
|
2606
2551
|
|
|
@@ -2634,15 +2579,15 @@ Defined in: [lib/consistent.ts:74](https://github.com/maiyunnet/kebab/blob/maste
|
|
|
2634
2579
|
|
|
2635
2580
|
##### keys
|
|
2636
2581
|
|
|
2637
|
-
|
|
2582
|
+
`string` \| `number` \| (`string` \| `number`)[]
|
|
2638
2583
|
|
|
2639
|
-
|
|
2584
|
+
原始数据 key 集
|
|
2640
2585
|
|
|
2641
2586
|
##### node
|
|
2642
2587
|
|
|
2643
|
-
|
|
2588
|
+
`string` \| `string`[]
|
|
2644
2589
|
|
|
2645
|
-
|
|
2590
|
+
新增的节点一个或多个
|
|
2646
2591
|
|
|
2647
2592
|
#### Returns
|
|
2648
2593
|
|
|
@@ -2662,9 +2607,9 @@ Defined in: [lib/consistent.ts:43](https://github.com/maiyunnet/kebab/blob/maste
|
|
|
2662
2607
|
|
|
2663
2608
|
##### node
|
|
2664
2609
|
|
|
2665
|
-
|
|
2610
|
+
`string` \| `string`[]
|
|
2666
2611
|
|
|
2667
|
-
|
|
2612
|
+
node 节点名
|
|
2668
2613
|
|
|
2669
2614
|
#### Returns
|
|
2670
2615
|
|
|
@@ -2697,9 +2642,9 @@ Defined in: [lib/consistent.ts:167](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
2697
2642
|
|
|
2698
2643
|
### node
|
|
2699
2644
|
|
|
2700
|
-
|
|
2645
|
+
`string` \| `string`[]
|
|
2701
2646
|
|
|
2702
|
-
|
|
2647
|
+
node 节点名一个或多个
|
|
2703
2648
|
|
|
2704
2649
|
### vcount?
|
|
2705
2650
|
|
|
@@ -2732,15 +2677,15 @@ Defined in: [lib/consistent.ts:124](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
2732
2677
|
|
|
2733
2678
|
### key
|
|
2734
2679
|
|
|
2735
|
-
|
|
2680
|
+
`string` \| `number`
|
|
2736
2681
|
|
|
2737
|
-
|
|
2682
|
+
要查找的key
|
|
2738
2683
|
|
|
2739
2684
|
### nodes
|
|
2740
2685
|
|
|
2741
|
-
|
|
2686
|
+
`string` \| `string`[]
|
|
2742
2687
|
|
|
2743
|
-
|
|
2688
|
+
node 列表
|
|
2744
2689
|
|
|
2745
2690
|
### vcount?
|
|
2746
2691
|
|
|
@@ -2779,9 +2724,9 @@ Defined in: [lib/consistent.ts:188](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
2779
2724
|
|
|
2780
2725
|
### key
|
|
2781
2726
|
|
|
2782
|
-
|
|
2727
|
+
`string` \| `number`
|
|
2783
2728
|
|
|
2784
|
-
|
|
2729
|
+
为给定键取 Hash,取得顺时针方向上最近的一个虚拟节点对应的实际节点
|
|
2785
2730
|
|
|
2786
2731
|
### keys?
|
|
2787
2732
|
|
|
@@ -2880,9 +2825,9 @@ hash 函数
|
|
|
2880
2825
|
|
|
2881
2826
|
### val
|
|
2882
2827
|
|
|
2883
|
-
|
|
2828
|
+
`string` \| `number`
|
|
2884
2829
|
|
|
2885
|
-
|
|
2830
|
+
要 hash 的值
|
|
2886
2831
|
|
|
2887
2832
|
## Returns
|
|
2888
2833
|
|
|
@@ -2925,7 +2870,7 @@ lib/core/functions/checkSchema.md
|
|
|
2925
2870
|
|
|
2926
2871
|
> **checkSchema**(`val`, `schema`): `string`
|
|
2927
2872
|
|
|
2928
|
-
Defined in: [lib/core.ts:
|
|
2873
|
+
Defined in: [lib/core.ts:300](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L300)
|
|
2929
2874
|
|
|
2930
2875
|
判断一个对象是否符合 JSON Schema
|
|
2931
2876
|
|
|
@@ -2960,7 +2905,7 @@ lib/core/functions/checkType.md
|
|
|
2960
2905
|
|
|
2961
2906
|
> **checkType**(`val`, `type`, `tree?`): `string`
|
|
2962
2907
|
|
|
2963
|
-
Defined in: [lib/core.ts:
|
|
2908
|
+
Defined in: [lib/core.ts:212](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L212)
|
|
2964
2909
|
|
|
2965
2910
|
判断一个对象是否符合示例组,返回空字符串代表校验通过,返回:应该的类型:位置:传入的类型
|
|
2966
2911
|
|
|
@@ -3001,7 +2946,7 @@ lib/core/functions/clone.md
|
|
|
3001
2946
|
|
|
3002
2947
|
> **clone**\<`T`\>(`obj`): `T`
|
|
3003
2948
|
|
|
3004
|
-
Defined in: [lib/core.ts:
|
|
2949
|
+
Defined in: [lib/core.ts:1001](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1001)
|
|
3005
2950
|
|
|
3006
2951
|
完整的克隆一份数组/对象
|
|
3007
2952
|
|
|
@@ -3036,7 +2981,7 @@ lib/core/functions/convert62.md
|
|
|
3036
2981
|
|
|
3037
2982
|
> **convert62**(`n`): `string`
|
|
3038
2983
|
|
|
3039
|
-
Defined in: [lib/core.ts:
|
|
2984
|
+
Defined in: [lib/core.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L153)
|
|
3040
2985
|
|
|
3041
2986
|
将 10 进制转换为 62 进制
|
|
3042
2987
|
|
|
@@ -3044,9 +2989,9 @@ Defined in: [lib/core.ts:151](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3044
2989
|
|
|
3045
2990
|
### n
|
|
3046
2991
|
|
|
3047
|
-
|
|
2992
|
+
`string` \| `number` \| `bigint`
|
|
3048
2993
|
|
|
3049
|
-
|
|
2994
|
+
10 进制数字最大 9223372036854775807n
|
|
3050
2995
|
|
|
3051
2996
|
## Returns
|
|
3052
2997
|
|
|
@@ -3065,7 +3010,7 @@ lib/core/functions/debug.md
|
|
|
3065
3010
|
|
|
3066
3011
|
> **debug**(`message?`, ...`optionalParams`): `void`
|
|
3067
3012
|
|
|
3068
|
-
Defined in: [lib/core.ts:
|
|
3013
|
+
Defined in: [lib/core.ts:1035](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1035)
|
|
3069
3014
|
|
|
3070
3015
|
打印调试信息,线上环境不会打印
|
|
3071
3016
|
|
|
@@ -3100,7 +3045,7 @@ lib/core/functions/display.md
|
|
|
3100
3045
|
|
|
3101
3046
|
> **display**(`message?`, ...`optionalParams`): `void`
|
|
3102
3047
|
|
|
3103
|
-
Defined in: [lib/core.ts:
|
|
3048
|
+
Defined in: [lib/core.ts:1048](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1048)
|
|
3104
3049
|
|
|
3105
3050
|
向控制台直接显示内容,一般情况下禁止使用
|
|
3106
3051
|
|
|
@@ -3135,7 +3080,7 @@ lib/core/functions/emptyObject.md
|
|
|
3135
3080
|
|
|
3136
3081
|
> **emptyObject**(`obj`, `deep?`): `void`
|
|
3137
3082
|
|
|
3138
|
-
Defined in: [lib/core.ts:
|
|
3083
|
+
Defined in: [lib/core.ts:438](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L438)
|
|
3139
3084
|
|
|
3140
3085
|
将对象的所有属性清除包括键,不会破坏引用关系,对象变量依然保证是引用状态
|
|
3141
3086
|
|
|
@@ -3170,7 +3115,7 @@ lib/core/functions/exec.md
|
|
|
3170
3115
|
|
|
3171
3116
|
> **exec**(`command`, `options?`): `Promise`\<`string` \| `false`\>
|
|
3172
3117
|
|
|
3173
|
-
Defined in: [lib/core.ts:
|
|
3118
|
+
Defined in: [lib/core.ts:496](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L496)
|
|
3174
3119
|
|
|
3175
3120
|
执行命令行
|
|
3176
3121
|
|
|
@@ -3205,7 +3150,7 @@ lib/core/functions/getLog.md
|
|
|
3205
3150
|
|
|
3206
3151
|
> **getLog**(`opt`): `Promise`\<`false` \| `string`[][] \| `null`\>
|
|
3207
3152
|
|
|
3208
|
-
Defined in: [lib/core.ts:
|
|
3153
|
+
Defined in: [lib/core.ts:908](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L908)
|
|
3209
3154
|
|
|
3210
3155
|
获取日志内容为一个数组
|
|
3211
3156
|
|
|
@@ -3280,7 +3225,7 @@ lib/core/functions/ip.md
|
|
|
3280
3225
|
|
|
3281
3226
|
> **ip**(`ctr`, `req?`): `string`
|
|
3282
3227
|
|
|
3283
|
-
Defined in: [lib/core.ts:
|
|
3228
|
+
Defined in: [lib/core.ts:357](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L357)
|
|
3284
3229
|
|
|
3285
3230
|
获取 IP(非安全 IP)
|
|
3286
3231
|
|
|
@@ -3288,16 +3233,45 @@ Defined in: [lib/core.ts:355](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3288
3233
|
|
|
3289
3234
|
### ctr
|
|
3290
3235
|
|
|
3291
|
-
`IncomingHttpHeaders`
|
|
3236
|
+
`IncomingHttpHeaders` \| [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
3292
3237
|
|
|
3293
3238
|
### req?
|
|
3294
3239
|
|
|
3295
|
-
`IncomingMessage`
|
|
3240
|
+
`IncomingMessage` \| `Http2ServerRequest`
|
|
3296
3241
|
|
|
3297
3242
|
## Returns
|
|
3298
3243
|
|
|
3299
3244
|
`string`
|
|
3300
3245
|
|
|
3246
|
+
lib/core/functions/loadEnv.md
|
|
3247
|
+
---
|
|
3248
|
+
|
|
3249
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
3250
|
+
|
|
3251
|
+
***
|
|
3252
|
+
|
|
3253
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / loadEnv
|
|
3254
|
+
|
|
3255
|
+
# Function: loadEnv()
|
|
3256
|
+
|
|
3257
|
+
> **loadEnv**(`dir`): `Promise`\<`void`\>
|
|
3258
|
+
|
|
3259
|
+
Defined in: [lib/core.ts:1100](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1100)
|
|
3260
|
+
|
|
3261
|
+
加载 .env 文件到 process.env,若文件不存在则跳过
|
|
3262
|
+
|
|
3263
|
+
## Parameters
|
|
3264
|
+
|
|
3265
|
+
### dir
|
|
3266
|
+
|
|
3267
|
+
`string`
|
|
3268
|
+
|
|
3269
|
+
.env 文件所在目录路径(以 / 结尾)
|
|
3270
|
+
|
|
3271
|
+
## Returns
|
|
3272
|
+
|
|
3273
|
+
`Promise`\<`void`\>
|
|
3274
|
+
|
|
3301
3275
|
lib/core/functions/log.md
|
|
3302
3276
|
---
|
|
3303
3277
|
|
|
@@ -3311,7 +3285,7 @@ lib/core/functions/log.md
|
|
|
3311
3285
|
|
|
3312
3286
|
> **log**(`opt`, `msg`, `fend?`): `void`
|
|
3313
3287
|
|
|
3314
|
-
Defined in: [lib/core.ts:
|
|
3288
|
+
Defined in: [lib/core.ts:802](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L802)
|
|
3315
3289
|
|
|
3316
3290
|
写入文件日志
|
|
3317
3291
|
|
|
@@ -3319,9 +3293,9 @@ Defined in: [lib/core.ts:800](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3319
3293
|
|
|
3320
3294
|
### opt
|
|
3321
3295
|
|
|
3322
|
-
|
|
3296
|
+
[`Ctr`](../../../sys/ctr/classes/Ctr.md) \| [`ILogOptions`](../interfaces/ILogOptions.md)
|
|
3323
3297
|
|
|
3324
|
-
|
|
3298
|
+
选项
|
|
3325
3299
|
|
|
3326
3300
|
### msg
|
|
3327
3301
|
|
|
@@ -3352,7 +3326,7 @@ lib/core/functions/ls.md
|
|
|
3352
3326
|
|
|
3353
3327
|
> **ls**(`opt`): `Promise`\<`object`[]\>
|
|
3354
3328
|
|
|
3355
|
-
Defined in: [lib/core.ts:
|
|
3329
|
+
Defined in: [lib/core.ts:962](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L962)
|
|
3356
3330
|
|
|
3357
3331
|
获取目录内文件/文件夹列表
|
|
3358
3332
|
|
|
@@ -3395,7 +3369,7 @@ lib/core/functions/muid.md
|
|
|
3395
3369
|
|
|
3396
3370
|
> **muid**(`ctr`, `opt?`): `string`
|
|
3397
3371
|
|
|
3398
|
-
Defined in: [lib/core.ts:
|
|
3372
|
+
Defined in: [lib/core.ts:317](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L317)
|
|
3399
3373
|
|
|
3400
3374
|
获取 MUID
|
|
3401
3375
|
|
|
@@ -3458,7 +3432,7 @@ lib/core/functions/objectSort.md
|
|
|
3458
3432
|
|
|
3459
3433
|
> **objectSort**\<`T`\>(`o`): `T`
|
|
3460
3434
|
|
|
3461
|
-
Defined in: [lib/core.ts:
|
|
3435
|
+
Defined in: [lib/core.ts:419](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L419)
|
|
3462
3436
|
|
|
3463
3437
|
将对象进行升序排列
|
|
3464
3438
|
|
|
@@ -3493,7 +3467,7 @@ lib/core/functions/passThroughAppend.md
|
|
|
3493
3467
|
|
|
3494
3468
|
> **passThroughAppend**(`passThrough`, `data`, `end?`): `Promise`\<`void`\>
|
|
3495
3469
|
|
|
3496
|
-
Defined in: [lib/core.ts:
|
|
3470
|
+
Defined in: [lib/core.ts:457](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L457)
|
|
3497
3471
|
|
|
3498
3472
|
调用前自行创建 passThrough,并且调用 pipe 绑定到应该绑定的对象,然后再调用本函数
|
|
3499
3473
|
|
|
@@ -3534,7 +3508,7 @@ lib/core/functions/purify.md
|
|
|
3534
3508
|
|
|
3535
3509
|
> **purify**(`text`): `string`
|
|
3536
3510
|
|
|
3537
|
-
Defined in: [lib/core.ts:
|
|
3511
|
+
Defined in: [lib/core.ts:182](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L182)
|
|
3538
3512
|
|
|
3539
3513
|
去除 html 的空白符、换行以及注释
|
|
3540
3514
|
|
|
@@ -3563,7 +3537,7 @@ lib/core/functions/rand.md
|
|
|
3563
3537
|
|
|
3564
3538
|
> **rand**(`min`, `max`, `prec?`): `number`
|
|
3565
3539
|
|
|
3566
|
-
Defined in: [lib/core.ts:
|
|
3540
|
+
Defined in: [lib/core.ts:90](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L90)
|
|
3567
3541
|
|
|
3568
3542
|
生成基础的范围随机数
|
|
3569
3543
|
|
|
@@ -3604,7 +3578,7 @@ lib/core/functions/random.md
|
|
|
3604
3578
|
|
|
3605
3579
|
> **random**(`length?`, `source?`, `block?`): `string`
|
|
3606
3580
|
|
|
3607
|
-
Defined in: [lib/core.ts:
|
|
3581
|
+
Defined in: [lib/core.ts:128](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L128)
|
|
3608
3582
|
|
|
3609
3583
|
生成随机字符串
|
|
3610
3584
|
|
|
@@ -3645,7 +3619,7 @@ lib/core/functions/realIP.md
|
|
|
3645
3619
|
|
|
3646
3620
|
> **realIP**(`ctr`, `name?`): `string`
|
|
3647
3621
|
|
|
3648
|
-
Defined in: [lib/core.ts:
|
|
3622
|
+
Defined in: [lib/core.ts:391](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L391)
|
|
3649
3623
|
|
|
3650
3624
|
获取直连 IP(安全 IP)
|
|
3651
3625
|
|
|
@@ -3678,7 +3652,7 @@ lib/core/functions/removeGlobal.md
|
|
|
3678
3652
|
|
|
3679
3653
|
> **removeGlobal**(`key`, `hosts?`): `Promise`\<`string`[]\>
|
|
3680
3654
|
|
|
3681
|
-
Defined in: [lib/core.ts:
|
|
3655
|
+
Defined in: [lib/core.ts:725](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L725)
|
|
3682
3656
|
|
|
3683
3657
|
移除某个跨线程/跨内网服务器全局变量
|
|
3684
3658
|
|
|
@@ -3700,6 +3674,35 @@ Defined in: [lib/core.ts:723](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3700
3674
|
|
|
3701
3675
|
`Promise`\<`string`[]\>
|
|
3702
3676
|
|
|
3677
|
+
lib/core/functions/resolveEnvVars.md
|
|
3678
|
+
---
|
|
3679
|
+
|
|
3680
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
3681
|
+
|
|
3682
|
+
***
|
|
3683
|
+
|
|
3684
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/core](../index.md) / resolveEnvVars
|
|
3685
|
+
|
|
3686
|
+
# Function: resolveEnvVars()
|
|
3687
|
+
|
|
3688
|
+
> **resolveEnvVars**(`obj`): `void`
|
|
3689
|
+
|
|
3690
|
+
Defined in: [lib/core.ts:1130](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1130)
|
|
3691
|
+
|
|
3692
|
+
将配置对象中的 ${ENV_VAR} 占位符替换为 process.env 的值
|
|
3693
|
+
|
|
3694
|
+
## Parameters
|
|
3695
|
+
|
|
3696
|
+
### obj
|
|
3697
|
+
|
|
3698
|
+
`Record`\<`string`, `any`\>
|
|
3699
|
+
|
|
3700
|
+
配置对象
|
|
3701
|
+
|
|
3702
|
+
## Returns
|
|
3703
|
+
|
|
3704
|
+
`void`
|
|
3705
|
+
|
|
3703
3706
|
lib/core/functions/sendNpm.md
|
|
3704
3707
|
---
|
|
3705
3708
|
|
|
@@ -3713,7 +3716,7 @@ lib/core/functions/sendNpm.md
|
|
|
3713
3716
|
|
|
3714
3717
|
> **sendNpm**(`path`, `hosts?`): `Promise`\<`string`[]\>
|
|
3715
3718
|
|
|
3716
|
-
Defined in: [lib/core.ts:
|
|
3719
|
+
Defined in: [lib/core.ts:641](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L641)
|
|
3717
3720
|
|
|
3718
3721
|
向本机或局域网 RPC 发送 npm install 操作
|
|
3719
3722
|
|
|
@@ -3727,9 +3730,9 @@ Defined in: [lib/core.ts:639](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3727
3730
|
|
|
3728
3731
|
### hosts?
|
|
3729
3732
|
|
|
3730
|
-
|
|
3733
|
+
`string`[] \| `"config"`
|
|
3731
3734
|
|
|
3732
|
-
|
|
3735
|
+
局域网列表
|
|
3733
3736
|
|
|
3734
3737
|
## Returns
|
|
3735
3738
|
|
|
@@ -3748,7 +3751,7 @@ lib/core/functions/sendPm2.md
|
|
|
3748
3751
|
|
|
3749
3752
|
> **sendPm2**(`name`, `action?`, `hosts?`): `Promise`\<`string`[]\>
|
|
3750
3753
|
|
|
3751
|
-
Defined in: [lib/core.ts:
|
|
3754
|
+
Defined in: [lib/core.ts:601](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L601)
|
|
3752
3755
|
|
|
3753
3756
|
向本机或局域网 RPC 发送 PM2 操作
|
|
3754
3757
|
|
|
@@ -3768,9 +3771,9 @@ PM2 操作类型
|
|
|
3768
3771
|
|
|
3769
3772
|
### hosts?
|
|
3770
3773
|
|
|
3771
|
-
|
|
3774
|
+
`string`[] \| `"config"`
|
|
3772
3775
|
|
|
3773
|
-
|
|
3776
|
+
局域网列表
|
|
3774
3777
|
|
|
3775
3778
|
## Returns
|
|
3776
3779
|
|
|
@@ -3789,7 +3792,7 @@ lib/core/functions/sendReload.md
|
|
|
3789
3792
|
|
|
3790
3793
|
> **sendReload**(`hosts?`): `Promise`\<`string`[]\>
|
|
3791
3794
|
|
|
3792
|
-
Defined in: [lib/core.ts:
|
|
3795
|
+
Defined in: [lib/core.ts:516](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L516)
|
|
3793
3796
|
|
|
3794
3797
|
向主进程(或局域网同代码机子)发送广播将进行 reload 操作,等待回传
|
|
3795
3798
|
主要作用除代码热更新以外的其他情况
|
|
@@ -3798,7 +3801,7 @@ Defined in: [lib/core.ts:514](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3798
3801
|
|
|
3799
3802
|
### hosts?
|
|
3800
3803
|
|
|
3801
|
-
`string`[]
|
|
3804
|
+
`string`[] \| `"config"`
|
|
3802
3805
|
|
|
3803
3806
|
## Returns
|
|
3804
3807
|
|
|
@@ -3817,7 +3820,7 @@ lib/core/functions/sendRestart.md
|
|
|
3817
3820
|
|
|
3818
3821
|
> **sendRestart**(`hosts?`): `Promise`\<`string`[]\>
|
|
3819
3822
|
|
|
3820
|
-
Defined in: [lib/core.ts:
|
|
3823
|
+
Defined in: [lib/core.ts:556](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L556)
|
|
3821
3824
|
|
|
3822
3825
|
向主进程(或局域网同代码机子)发送广播将进行 restart 操作,停止监听并启动新进程,老进程在连接全部断开后自行销毁
|
|
3823
3826
|
主要用作不间断的代码热更新
|
|
@@ -3826,7 +3829,7 @@ Defined in: [lib/core.ts:554](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3826
3829
|
|
|
3827
3830
|
### hosts?
|
|
3828
3831
|
|
|
3829
|
-
`string`[]
|
|
3832
|
+
`string`[] \| `"config"`
|
|
3830
3833
|
|
|
3831
3834
|
## Returns
|
|
3832
3835
|
|
|
@@ -3845,7 +3848,7 @@ lib/core/functions/setCookie.md
|
|
|
3845
3848
|
|
|
3846
3849
|
> **setCookie**(`ctr`, `name`, `value`, `opt?`): `void`
|
|
3847
3850
|
|
|
3848
|
-
Defined in: [lib/core.ts:
|
|
3851
|
+
Defined in: [lib/core.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L61)
|
|
3849
3852
|
|
|
3850
3853
|
设置 cookie
|
|
3851
3854
|
|
|
@@ -3892,7 +3895,7 @@ lib/core/functions/setGlobal.md
|
|
|
3892
3895
|
|
|
3893
3896
|
> **setGlobal**(`key`, `data`, `hosts?`): `Promise`\<`string`[]\>
|
|
3894
3897
|
|
|
3895
|
-
Defined in: [lib/core.ts:
|
|
3898
|
+
Defined in: [lib/core.ts:684](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L684)
|
|
3896
3899
|
|
|
3897
3900
|
设置跨线程/指定的局域网主机的全局变量
|
|
3898
3901
|
|
|
@@ -3912,9 +3915,9 @@ Defined in: [lib/core.ts:682](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
3912
3915
|
|
|
3913
3916
|
### hosts?
|
|
3914
3917
|
|
|
3915
|
-
|
|
3918
|
+
`string`[] \| `"config"`
|
|
3916
3919
|
|
|
3917
|
-
|
|
3920
|
+
局域网列表
|
|
3918
3921
|
|
|
3919
3922
|
## Returns
|
|
3920
3923
|
|
|
@@ -3933,7 +3936,7 @@ lib/core/functions/sleep.md
|
|
|
3933
3936
|
|
|
3934
3937
|
> **sleep**(`ms`): `Promise`\<`void`\>
|
|
3935
3938
|
|
|
3936
|
-
Defined in: [lib/core.ts:
|
|
3939
|
+
Defined in: [lib/core.ts:407](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L407)
|
|
3937
3940
|
|
|
3938
3941
|
间隔一段时间
|
|
3939
3942
|
|
|
@@ -3962,7 +3965,7 @@ lib/core/functions/unconvert62.md
|
|
|
3962
3965
|
|
|
3963
3966
|
> **unconvert62**(`n`): `bigint`
|
|
3964
3967
|
|
|
3965
|
-
Defined in: [lib/core.ts:
|
|
3968
|
+
Defined in: [lib/core.ts:169](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L169)
|
|
3966
3969
|
|
|
3967
3970
|
将 62 进制转换为 10 进制
|
|
3968
3971
|
|
|
@@ -3991,7 +3994,7 @@ lib/core/functions/updateCode.md
|
|
|
3991
3994
|
|
|
3992
3995
|
> **updateCode**(`sourcePath`, `path`, `hosts?`, `config?`, `strict?`): `Promise`\<`Record`\<`string`, \{ `result`: `boolean`; `return`: `string`; \}\>\>
|
|
3993
3996
|
|
|
3994
|
-
Defined in: [lib/core.ts:
|
|
3997
|
+
Defined in: [lib/core.ts:737](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L737)
|
|
3995
3998
|
|
|
3996
3999
|
上传并覆盖代码文件,config.json、kebab.json、.js.map、.ts, .gitignore 不会被覆盖和新创建
|
|
3997
4000
|
|
|
@@ -4011,9 +4014,9 @@ zip 文件
|
|
|
4011
4014
|
|
|
4012
4015
|
### hosts?
|
|
4013
4016
|
|
|
4014
|
-
|
|
4017
|
+
`string`[] \| `"config"`
|
|
4015
4018
|
|
|
4016
|
-
|
|
4019
|
+
局域网多机部署,不设置默认本机部署
|
|
4017
4020
|
|
|
4018
4021
|
### config?
|
|
4019
4022
|
|
|
@@ -4044,7 +4047,7 @@ lib/core/functions/write.md
|
|
|
4044
4047
|
|
|
4045
4048
|
> **write**(`res`, `data`): `void`
|
|
4046
4049
|
|
|
4047
|
-
Defined in: [lib/core.ts:
|
|
4050
|
+
Defined in: [lib/core.ts:1082](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1082)
|
|
4048
4051
|
|
|
4049
4052
|
向 res 发送数据
|
|
4050
4053
|
|
|
@@ -4052,15 +4055,15 @@ Defined in: [lib/core.ts:1054](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4052
4055
|
|
|
4053
4056
|
### res
|
|
4054
4057
|
|
|
4055
|
-
|
|
4058
|
+
`Socket` \| `Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
4056
4059
|
|
|
4057
|
-
|
|
4060
|
+
响应对象
|
|
4058
4061
|
|
|
4059
4062
|
### data
|
|
4060
4063
|
|
|
4061
|
-
|
|
4064
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
4062
4065
|
|
|
4063
|
-
|
|
4066
|
+
数据
|
|
4064
4067
|
|
|
4065
4068
|
## Returns
|
|
4066
4069
|
|
|
@@ -4079,13 +4082,13 @@ lib/core/functions/writeEventStreamHead.md
|
|
|
4079
4082
|
|
|
4080
4083
|
> **writeEventStreamHead**(`res`): `void`
|
|
4081
4084
|
|
|
4082
|
-
Defined in: [lib/core.ts:
|
|
4085
|
+
Defined in: [lib/core.ts:1070](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1070)
|
|
4083
4086
|
|
|
4084
4087
|
## Parameters
|
|
4085
4088
|
|
|
4086
4089
|
### res
|
|
4087
4090
|
|
|
4088
|
-
`Http2ServerResponse`\<`Http2ServerRequest`\>
|
|
4091
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
4089
4092
|
|
|
4090
4093
|
## Returns
|
|
4091
4094
|
|
|
@@ -4104,7 +4107,7 @@ lib/core/functions/writeHead.md
|
|
|
4104
4107
|
|
|
4105
4108
|
> **writeHead**(`res`, `statusCode`, `headers?`): `void`
|
|
4106
4109
|
|
|
4107
|
-
Defined in: [lib/core.ts:
|
|
4110
|
+
Defined in: [lib/core.ts:1059](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L1059)
|
|
4108
4111
|
|
|
4109
4112
|
让 res 发送头部(前提是头部没有被发送才能调用本方法
|
|
4110
4113
|
|
|
@@ -4112,9 +4115,9 @@ Defined in: [lib/core.ts:1031](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
4112
4115
|
|
|
4113
4116
|
### res
|
|
4114
4117
|
|
|
4115
|
-
|
|
4118
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
4116
4119
|
|
|
4117
|
-
|
|
4120
|
+
响应对象
|
|
4118
4121
|
|
|
4119
4122
|
### statusCode
|
|
4120
4123
|
|
|
@@ -4180,6 +4183,7 @@ lib/core/index.md
|
|
|
4180
4183
|
- [exec](functions/exec.md)
|
|
4181
4184
|
- [getLog](functions/getLog.md)
|
|
4182
4185
|
- [ip](functions/ip.md)
|
|
4186
|
+
- [loadEnv](functions/loadEnv.md)
|
|
4183
4187
|
- [log](functions/log.md)
|
|
4184
4188
|
- [ls](functions/ls.md)
|
|
4185
4189
|
- [muid](functions/muid.md)
|
|
@@ -4190,6 +4194,7 @@ lib/core/index.md
|
|
|
4190
4194
|
- [random](functions/random.md)
|
|
4191
4195
|
- [realIP](functions/realIP.md)
|
|
4192
4196
|
- [removeGlobal](functions/removeGlobal.md)
|
|
4197
|
+
- [resolveEnvVars](functions/resolveEnvVars.md)
|
|
4193
4198
|
- [sendNpm](functions/sendNpm.md)
|
|
4194
4199
|
- [sendPm2](functions/sendPm2.md)
|
|
4195
4200
|
- [sendReload](functions/sendReload.md)
|
|
@@ -4214,7 +4219,7 @@ lib/core/interfaces/ICookieOptions.md
|
|
|
4214
4219
|
|
|
4215
4220
|
# Interface: ICookieOptions
|
|
4216
4221
|
|
|
4217
|
-
Defined in: [lib/core.ts:
|
|
4222
|
+
Defined in: [lib/core.ts:45](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L45)
|
|
4218
4223
|
|
|
4219
4224
|
Cookie 设置的选项
|
|
4220
4225
|
|
|
@@ -4222,49 +4227,49 @@ Cookie 设置的选项
|
|
|
4222
4227
|
|
|
4223
4228
|
### domain?
|
|
4224
4229
|
|
|
4225
|
-
> `optional` **domain
|
|
4230
|
+
> `optional` **domain?**: `string`
|
|
4226
4231
|
|
|
4227
|
-
Defined in: [lib/core.ts:
|
|
4232
|
+
Defined in: [lib/core.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L48)
|
|
4228
4233
|
|
|
4229
4234
|
***
|
|
4230
4235
|
|
|
4231
4236
|
### httponly?
|
|
4232
4237
|
|
|
4233
|
-
> `optional` **httponly
|
|
4238
|
+
> `optional` **httponly?**: `boolean`
|
|
4234
4239
|
|
|
4235
|
-
Defined in: [lib/core.ts:
|
|
4240
|
+
Defined in: [lib/core.ts:50](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L50)
|
|
4236
4241
|
|
|
4237
4242
|
***
|
|
4238
4243
|
|
|
4239
4244
|
### path?
|
|
4240
4245
|
|
|
4241
|
-
> `optional` **path
|
|
4246
|
+
> `optional` **path?**: `string`
|
|
4242
4247
|
|
|
4243
|
-
Defined in: [lib/core.ts:
|
|
4248
|
+
Defined in: [lib/core.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L47)
|
|
4244
4249
|
|
|
4245
4250
|
***
|
|
4246
4251
|
|
|
4247
4252
|
### samesite?
|
|
4248
4253
|
|
|
4249
|
-
> `optional` **samesite
|
|
4254
|
+
> `optional` **samesite?**: `"Strict"` \| `"Lax"` \| `"None"`
|
|
4250
4255
|
|
|
4251
|
-
Defined in: [lib/core.ts:
|
|
4256
|
+
Defined in: [lib/core.ts:51](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L51)
|
|
4252
4257
|
|
|
4253
4258
|
***
|
|
4254
4259
|
|
|
4255
4260
|
### ssl?
|
|
4256
4261
|
|
|
4257
|
-
> `optional` **ssl
|
|
4262
|
+
> `optional` **ssl?**: `boolean`
|
|
4258
4263
|
|
|
4259
|
-
Defined in: [lib/core.ts:
|
|
4264
|
+
Defined in: [lib/core.ts:49](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L49)
|
|
4260
4265
|
|
|
4261
4266
|
***
|
|
4262
4267
|
|
|
4263
4268
|
### ttl?
|
|
4264
4269
|
|
|
4265
|
-
> `optional` **ttl
|
|
4270
|
+
> `optional` **ttl?**: `number`
|
|
4266
4271
|
|
|
4267
|
-
Defined in: [lib/core.ts:
|
|
4272
|
+
Defined in: [lib/core.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L46)
|
|
4268
4273
|
|
|
4269
4274
|
lib/core/interfaces/ILogOptions.md
|
|
4270
4275
|
---
|
|
@@ -4277,7 +4282,7 @@ lib/core/interfaces/ILogOptions.md
|
|
|
4277
4282
|
|
|
4278
4283
|
# Interface: ILogOptions
|
|
4279
4284
|
|
|
4280
|
-
Defined in: [lib/core.ts:
|
|
4285
|
+
Defined in: [lib/core.ts:785](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L785)
|
|
4281
4286
|
|
|
4282
4287
|
log 设置的选项
|
|
4283
4288
|
|
|
@@ -4285,65 +4290,65 @@ log 设置的选项
|
|
|
4285
4290
|
|
|
4286
4291
|
### cookie?
|
|
4287
4292
|
|
|
4288
|
-
> `optional` **cookie
|
|
4293
|
+
> `optional` **cookie?**: `Record`\<`string`, `string`\>
|
|
4289
4294
|
|
|
4290
|
-
Defined in: [lib/core.ts:
|
|
4295
|
+
Defined in: [lib/core.ts:791](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L791)
|
|
4291
4296
|
|
|
4292
4297
|
***
|
|
4293
4298
|
|
|
4294
4299
|
### get?
|
|
4295
4300
|
|
|
4296
|
-
> `optional` **get
|
|
4301
|
+
> `optional` **get?**: `Record`\<`string`, `any`\>
|
|
4297
4302
|
|
|
4298
|
-
Defined in: [lib/core.ts:
|
|
4303
|
+
Defined in: [lib/core.ts:790](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L790)
|
|
4299
4304
|
|
|
4300
4305
|
***
|
|
4301
4306
|
|
|
4302
4307
|
### headers?
|
|
4303
4308
|
|
|
4304
|
-
> `optional` **headers
|
|
4309
|
+
> `optional` **headers?**: `IncomingHttpHeaders`
|
|
4305
4310
|
|
|
4306
|
-
Defined in: [lib/core.ts:
|
|
4311
|
+
Defined in: [lib/core.ts:793](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L793)
|
|
4307
4312
|
|
|
4308
4313
|
***
|
|
4309
4314
|
|
|
4310
4315
|
### hostname?
|
|
4311
4316
|
|
|
4312
|
-
> `optional` **hostname
|
|
4317
|
+
> `optional` **hostname?**: `string`
|
|
4313
4318
|
|
|
4314
|
-
Defined in: [lib/core.ts:
|
|
4319
|
+
Defined in: [lib/core.ts:788](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L788)
|
|
4315
4320
|
|
|
4316
4321
|
***
|
|
4317
4322
|
|
|
4318
4323
|
### path?
|
|
4319
4324
|
|
|
4320
|
-
> `optional` **path
|
|
4325
|
+
> `optional` **path?**: `string`
|
|
4321
4326
|
|
|
4322
|
-
Defined in: [lib/core.ts:
|
|
4327
|
+
Defined in: [lib/core.ts:786](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L786)
|
|
4323
4328
|
|
|
4324
4329
|
***
|
|
4325
4330
|
|
|
4326
4331
|
### req?
|
|
4327
4332
|
|
|
4328
|
-
> `optional` **req
|
|
4333
|
+
> `optional` **req?**: `IncomingMessage` \| `Http2ServerRequest` \| `null`
|
|
4329
4334
|
|
|
4330
|
-
Defined in: [lib/core.ts:
|
|
4335
|
+
Defined in: [lib/core.ts:789](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L789)
|
|
4331
4336
|
|
|
4332
4337
|
***
|
|
4333
4338
|
|
|
4334
4339
|
### session?
|
|
4335
4340
|
|
|
4336
|
-
> `optional` **session
|
|
4341
|
+
> `optional` **session?**: `Record`\<`string`, `any`\>
|
|
4337
4342
|
|
|
4338
|
-
Defined in: [lib/core.ts:
|
|
4343
|
+
Defined in: [lib/core.ts:792](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L792)
|
|
4339
4344
|
|
|
4340
4345
|
***
|
|
4341
4346
|
|
|
4342
4347
|
### urlFull?
|
|
4343
4348
|
|
|
4344
|
-
> `optional` **urlFull
|
|
4349
|
+
> `optional` **urlFull?**: `string`
|
|
4345
4350
|
|
|
4346
|
-
Defined in: [lib/core.ts:
|
|
4351
|
+
Defined in: [lib/core.ts:787](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L787)
|
|
4347
4352
|
|
|
4348
4353
|
lib/core/type-aliases/TPm2Action.md
|
|
4349
4354
|
---
|
|
@@ -4358,7 +4363,7 @@ lib/core/type-aliases/TPm2Action.md
|
|
|
4358
4363
|
|
|
4359
4364
|
> **TPm2Action** = `"start"` \| `"stop"` \| `"restart"`
|
|
4360
4365
|
|
|
4361
|
-
Defined in: [lib/core.ts:
|
|
4366
|
+
Defined in: [lib/core.ts:593](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L593)
|
|
4362
4367
|
|
|
4363
4368
|
PM2 操作类型
|
|
4364
4369
|
|
|
@@ -4375,7 +4380,7 @@ lib/core/variables/global.md
|
|
|
4375
4380
|
|
|
4376
4381
|
> `const` **global**: `Record`\<`string`, `any`\> = `{}`
|
|
4377
4382
|
|
|
4378
|
-
Defined in: [lib/core.ts:
|
|
4383
|
+
Defined in: [lib/core.ts:676](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L676)
|
|
4379
4384
|
|
|
4380
4385
|
跨进程全局变量
|
|
4381
4386
|
|
|
@@ -4418,6 +4423,12 @@ Defined in: [lib/core.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4418
4423
|
|
|
4419
4424
|
> **ind**: `string`[]
|
|
4420
4425
|
|
|
4426
|
+
### logFormat
|
|
4427
|
+
|
|
4428
|
+
> **logFormat**: `"csv"` \| `"jsonl"`
|
|
4429
|
+
|
|
4430
|
+
日志格式,csv 或 jsonl,默认 jsonl
|
|
4431
|
+
|
|
4421
4432
|
### max
|
|
4422
4433
|
|
|
4423
4434
|
> **max**: `number`
|
|
@@ -4443,7 +4454,7 @@ lib/core/variables/RANDOM_L.md
|
|
|
4443
4454
|
|
|
4444
4455
|
> `const` **RANDOM\_L**: `"abcdefghijklmnopqrstuvwxyz"` = `'abcdefghijklmnopqrstuvwxyz'`
|
|
4445
4456
|
|
|
4446
|
-
Defined in: [lib/core.ts:
|
|
4457
|
+
Defined in: [lib/core.ts:107](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L107)
|
|
4447
4458
|
|
|
4448
4459
|
小写字母字符集
|
|
4449
4460
|
|
|
@@ -4460,7 +4471,7 @@ lib/core/variables/RANDOM_LN.md
|
|
|
4460
4471
|
|
|
4461
4472
|
> `const` **RANDOM\_LN**: `string`
|
|
4462
4473
|
|
|
4463
|
-
Defined in: [lib/core.ts:
|
|
4474
|
+
Defined in: [lib/core.ts:112](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L112)
|
|
4464
4475
|
|
|
4465
4476
|
小写字母 + 数字字符集
|
|
4466
4477
|
|
|
@@ -4477,7 +4488,7 @@ lib/core/variables/RANDOM_LU.md
|
|
|
4477
4488
|
|
|
4478
4489
|
> `const` **RANDOM\_LU**: `string`
|
|
4479
4490
|
|
|
4480
|
-
Defined in: [lib/core.ts:
|
|
4491
|
+
Defined in: [lib/core.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L114)
|
|
4481
4492
|
|
|
4482
4493
|
小写字母 + 大写字母字符集
|
|
4483
4494
|
|
|
@@ -4494,7 +4505,7 @@ lib/core/variables/RANDOM_LUN.md
|
|
|
4494
4505
|
|
|
4495
4506
|
> `const` **RANDOM\_LUN**: `string`
|
|
4496
4507
|
|
|
4497
|
-
Defined in: [lib/core.ts:
|
|
4508
|
+
Defined in: [lib/core.ts:116](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L116)
|
|
4498
4509
|
|
|
4499
4510
|
小写字母 + 大写字母 + 数字字符集
|
|
4500
4511
|
|
|
@@ -4511,7 +4522,7 @@ lib/core/variables/RANDOM_LUNS.md
|
|
|
4511
4522
|
|
|
4512
4523
|
> `const` **RANDOM\_LUNS**: `string`
|
|
4513
4524
|
|
|
4514
|
-
Defined in: [lib/core.ts:
|
|
4525
|
+
Defined in: [lib/core.ts:120](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L120)
|
|
4515
4526
|
|
|
4516
4527
|
小写字母 + 大写字母 + 数字字符集 + 特殊字符字符集
|
|
4517
4528
|
|
|
@@ -4528,7 +4539,7 @@ lib/core/variables/RANDOM_N.md
|
|
|
4528
4539
|
|
|
4529
4540
|
> `const` **RANDOM\_N**: `"0123456789"` = `'0123456789'`
|
|
4530
4541
|
|
|
4531
|
-
Defined in: [lib/core.ts:
|
|
4542
|
+
Defined in: [lib/core.ts:103](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L103)
|
|
4532
4543
|
|
|
4533
4544
|
数字字符集
|
|
4534
4545
|
|
|
@@ -4545,7 +4556,7 @@ lib/core/variables/RANDOM_U.md
|
|
|
4545
4556
|
|
|
4546
4557
|
> `const` **RANDOM\_U**: `"ABCDEFGHIJKLMNOPQRSTUVWXYZ"` = `'ABCDEFGHIJKLMNOPQRSTUVWXYZ'`
|
|
4547
4558
|
|
|
4548
|
-
Defined in: [lib/core.ts:
|
|
4559
|
+
Defined in: [lib/core.ts:105](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L105)
|
|
4549
4560
|
|
|
4550
4561
|
大写字母字符集
|
|
4551
4562
|
|
|
@@ -4562,7 +4573,7 @@ lib/core/variables/RANDOM_UN.md
|
|
|
4562
4573
|
|
|
4563
4574
|
> `const` **RANDOM\_UN**: `string`
|
|
4564
4575
|
|
|
4565
|
-
Defined in: [lib/core.ts:
|
|
4576
|
+
Defined in: [lib/core.ts:110](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L110)
|
|
4566
4577
|
|
|
4567
4578
|
大写字母 + 数字字符集
|
|
4568
4579
|
|
|
@@ -4579,7 +4590,7 @@ lib/core/variables/RANDOM_V.md
|
|
|
4579
4590
|
|
|
4580
4591
|
> `const` **RANDOM\_V**: `"ACEFGHJKLMNPRSTWXY34567"` = `'ACEFGHJKLMNPRSTWXY34567'`
|
|
4581
4592
|
|
|
4582
|
-
Defined in: [lib/core.ts:
|
|
4593
|
+
Defined in: [lib/core.ts:118](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L118)
|
|
4583
4594
|
|
|
4584
4595
|
验证码字符集
|
|
4585
4596
|
|
|
@@ -4596,7 +4607,7 @@ lib/core/variables/REAL_IP_CF.md
|
|
|
4596
4607
|
|
|
4597
4608
|
> `const` **REAL\_IP\_CF**: `"cf-connecting-ip"` = `'cf-connecting-ip'`
|
|
4598
4609
|
|
|
4599
|
-
Defined in: [lib/core.ts:
|
|
4610
|
+
Defined in: [lib/core.ts:384](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L384)
|
|
4600
4611
|
|
|
4601
4612
|
使用的是 Cloudflare
|
|
4602
4613
|
|
|
@@ -4613,7 +4624,7 @@ lib/core/variables/REAL_IP_X.md
|
|
|
4613
4624
|
|
|
4614
4625
|
> `const` **REAL\_IP\_X**: `"x-forwarded-for"` = `'x-forwarded-for'`
|
|
4615
4626
|
|
|
4616
|
-
Defined in: [lib/core.ts:
|
|
4627
|
+
Defined in: [lib/core.ts:382](https://github.com/maiyunnet/kebab/blob/master/lib/core.ts#L382)
|
|
4617
4628
|
|
|
4618
4629
|
使用 X-Forwarded-For 的 CDN 厂商
|
|
4619
4630
|
|
|
@@ -4630,7 +4641,7 @@ lib/cron/functions/getRegulars.md
|
|
|
4630
4641
|
|
|
4631
4642
|
> **getRegulars**(): [`IRegularData`](../interfaces/IRegularData.md)[]
|
|
4632
4643
|
|
|
4633
|
-
Defined in: [lib/cron.ts:
|
|
4644
|
+
Defined in: [lib/cron.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L18)
|
|
4634
4645
|
|
|
4635
4646
|
获取定时任务列表
|
|
4636
4647
|
|
|
@@ -4651,7 +4662,7 @@ lib/cron/functions/regular.md
|
|
|
4651
4662
|
|
|
4652
4663
|
> **regular**(`task`, `immediate?`): `Promise`\<`boolean`\>
|
|
4653
4664
|
|
|
4654
|
-
Defined in: [lib/cron.ts:
|
|
4665
|
+
Defined in: [lib/cron.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L27)
|
|
4655
4666
|
|
|
4656
4667
|
创建定时执行的计划任务
|
|
4657
4668
|
|
|
@@ -4705,7 +4716,7 @@ lib/cron/interfaces/IRegular.md
|
|
|
4705
4716
|
|
|
4706
4717
|
# Interface: IRegular
|
|
4707
4718
|
|
|
4708
|
-
Defined in: [lib/cron.ts:
|
|
4719
|
+
Defined in: [lib/cron.ts:147](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L147)
|
|
4709
4720
|
|
|
4710
4721
|
定时任务
|
|
4711
4722
|
|
|
@@ -4715,11 +4726,11 @@ Defined in: [lib/cron.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4715
4726
|
|
|
4716
4727
|
## Properties
|
|
4717
4728
|
|
|
4718
|
-
### callback
|
|
4729
|
+
### callback
|
|
4719
4730
|
|
|
4720
4731
|
> **callback**: (`date`, `immediate`) => `void` \| `Promise`\<`void`\>
|
|
4721
4732
|
|
|
4722
|
-
Defined in: [lib/cron.ts:
|
|
4733
|
+
Defined in: [lib/cron.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L153)
|
|
4723
4734
|
|
|
4724
4735
|
任务函数
|
|
4725
4736
|
|
|
@@ -4743,7 +4754,7 @@ Defined in: [lib/cron.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4743
4754
|
|
|
4744
4755
|
> **name**: `string`
|
|
4745
4756
|
|
|
4746
|
-
Defined in: [lib/cron.ts:
|
|
4757
|
+
Defined in: [lib/cron.ts:149](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L149)
|
|
4747
4758
|
|
|
4748
4759
|
任务名称,只能小写字母、数字、短横线、下划线,长度 1-32
|
|
4749
4760
|
|
|
@@ -4753,7 +4764,7 @@ Defined in: [lib/cron.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4753
4764
|
|
|
4754
4765
|
> **rule**: `string`
|
|
4755
4766
|
|
|
4756
|
-
Defined in: [lib/cron.ts:
|
|
4767
|
+
Defined in: [lib/cron.ts:151](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L151)
|
|
4757
4768
|
|
|
4758
4769
|
规则,分、时、日、月、星期,与 linux 的 cron 相同(不支持秒)
|
|
4759
4770
|
|
|
@@ -4768,7 +4779,7 @@ lib/cron/interfaces/IRegularData.md
|
|
|
4768
4779
|
|
|
4769
4780
|
# Interface: IRegularData
|
|
4770
4781
|
|
|
4771
|
-
Defined in: [lib/cron.ts:
|
|
4782
|
+
Defined in: [lib/cron.ts:156](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L156)
|
|
4772
4783
|
|
|
4773
4784
|
定时任务
|
|
4774
4785
|
|
|
@@ -4778,11 +4789,11 @@ Defined in: [lib/cron.ts:102](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4778
4789
|
|
|
4779
4790
|
## Properties
|
|
4780
4791
|
|
|
4781
|
-
### callback
|
|
4792
|
+
### callback
|
|
4782
4793
|
|
|
4783
4794
|
> **callback**: (`date`, `immediate`) => `void` \| `Promise`\<`void`\>
|
|
4784
4795
|
|
|
4785
|
-
Defined in: [lib/cron.ts:
|
|
4796
|
+
Defined in: [lib/cron.ts:153](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L153)
|
|
4786
4797
|
|
|
4787
4798
|
任务函数
|
|
4788
4799
|
|
|
@@ -4810,7 +4821,7 @@ Defined in: [lib/cron.ts:99](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4810
4821
|
|
|
4811
4822
|
> **count**: `number`
|
|
4812
4823
|
|
|
4813
|
-
Defined in: [lib/cron.ts:
|
|
4824
|
+
Defined in: [lib/cron.ts:160](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L160)
|
|
4814
4825
|
|
|
4815
4826
|
总执行次数
|
|
4816
4827
|
|
|
@@ -4820,7 +4831,7 @@ Defined in: [lib/cron.ts:106](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4820
4831
|
|
|
4821
4832
|
> **last**: `string`
|
|
4822
4833
|
|
|
4823
|
-
Defined in: [lib/cron.ts:
|
|
4834
|
+
Defined in: [lib/cron.ts:158](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L158)
|
|
4824
4835
|
|
|
4825
4836
|
上次执行时间字符串,格式:YmdHi(系统时区)
|
|
4826
4837
|
|
|
@@ -4830,7 +4841,7 @@ Defined in: [lib/cron.ts:104](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4830
4841
|
|
|
4831
4842
|
> **name**: `string`
|
|
4832
4843
|
|
|
4833
|
-
Defined in: [lib/cron.ts:
|
|
4844
|
+
Defined in: [lib/cron.ts:149](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L149)
|
|
4834
4845
|
|
|
4835
4846
|
任务名称,只能小写字母、数字、短横线、下划线,长度 1-32
|
|
4836
4847
|
|
|
@@ -4844,7 +4855,7 @@ Defined in: [lib/cron.ts:95](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
4844
4855
|
|
|
4845
4856
|
> **rcount**: `number`
|
|
4846
4857
|
|
|
4847
|
-
Defined in: [lib/cron.ts:
|
|
4858
|
+
Defined in: [lib/cron.ts:162](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L162)
|
|
4848
4859
|
|
|
4849
4860
|
定时任务重启后的执行次数
|
|
4850
4861
|
|
|
@@ -4854,7 +4865,7 @@ Defined in: [lib/cron.ts:108](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
4854
4865
|
|
|
4855
4866
|
> **rule**: `string`
|
|
4856
4867
|
|
|
4857
|
-
Defined in: [lib/cron.ts:
|
|
4868
|
+
Defined in: [lib/cron.ts:151](https://github.com/maiyunnet/kebab/blob/master/lib/cron.ts#L151)
|
|
4858
4869
|
|
|
4859
4870
|
规则,分、时、日、月、星期,与 linux 的 cron 相同(不支持秒)
|
|
4860
4871
|
|
|
@@ -4885,9 +4896,9 @@ AES 解密
|
|
|
4885
4896
|
|
|
4886
4897
|
#### encrypt
|
|
4887
4898
|
|
|
4888
|
-
|
|
4899
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
4889
4900
|
|
|
4890
|
-
|
|
4901
|
+
需解密的字符串
|
|
4891
4902
|
|
|
4892
4903
|
#### key
|
|
4893
4904
|
|
|
@@ -4927,9 +4938,9 @@ AES 解密
|
|
|
4927
4938
|
|
|
4928
4939
|
#### encrypt
|
|
4929
4940
|
|
|
4930
|
-
|
|
4941
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
4931
4942
|
|
|
4932
|
-
|
|
4943
|
+
需解密的字符串
|
|
4933
4944
|
|
|
4934
4945
|
#### key
|
|
4935
4946
|
|
|
@@ -4980,9 +4991,9 @@ AES 加密
|
|
|
4980
4991
|
|
|
4981
4992
|
#### original
|
|
4982
4993
|
|
|
4983
|
-
|
|
4994
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
4984
4995
|
|
|
4985
|
-
|
|
4996
|
+
原始字符串
|
|
4986
4997
|
|
|
4987
4998
|
#### key
|
|
4988
4999
|
|
|
@@ -5024,9 +5035,9 @@ AES 加密
|
|
|
5024
5035
|
|
|
5025
5036
|
#### original
|
|
5026
5037
|
|
|
5027
|
-
|
|
5038
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5028
5039
|
|
|
5029
|
-
|
|
5040
|
+
原始字符串
|
|
5030
5041
|
|
|
5031
5042
|
#### key
|
|
5032
5043
|
|
|
@@ -5140,9 +5151,9 @@ base64 编码
|
|
|
5140
5151
|
|
|
5141
5152
|
### data
|
|
5142
5153
|
|
|
5143
|
-
|
|
5154
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5144
5155
|
|
|
5145
|
-
|
|
5156
|
+
字符串或 Buffer
|
|
5146
5157
|
|
|
5147
5158
|
## Returns
|
|
5148
5159
|
|
|
@@ -5169,9 +5180,9 @@ cipher 解密
|
|
|
5169
5180
|
|
|
5170
5181
|
### encrypt
|
|
5171
5182
|
|
|
5172
|
-
|
|
5183
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5173
5184
|
|
|
5174
|
-
|
|
5185
|
+
需解密的字符串
|
|
5175
5186
|
|
|
5176
5187
|
### key
|
|
5177
5188
|
|
|
@@ -5193,9 +5204,9 @@ cipher 解密
|
|
|
5193
5204
|
|
|
5194
5205
|
### output?
|
|
5195
5206
|
|
|
5196
|
-
|
|
5207
|
+
`"buffer"` \| `"binary"`
|
|
5197
5208
|
|
|
5198
|
-
|
|
5209
|
+
输出类型
|
|
5199
5210
|
|
|
5200
5211
|
## Returns
|
|
5201
5212
|
|
|
@@ -5222,9 +5233,9 @@ cipher 加密,强烈不建议使用 AES_256_ECB
|
|
|
5222
5233
|
|
|
5223
5234
|
### original
|
|
5224
5235
|
|
|
5225
|
-
|
|
5236
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5226
5237
|
|
|
5227
|
-
|
|
5238
|
+
原始字符串
|
|
5228
5239
|
|
|
5229
5240
|
### key
|
|
5230
5241
|
|
|
@@ -5246,9 +5257,9 @@ cipher 加密,强烈不建议使用 AES_256_ECB
|
|
|
5246
5257
|
|
|
5247
5258
|
### output?
|
|
5248
5259
|
|
|
5249
|
-
|
|
5260
|
+
`"buffer"` \| `"base64"`
|
|
5250
5261
|
|
|
5251
|
-
|
|
5262
|
+
输出类型
|
|
5252
5263
|
|
|
5253
5264
|
## Returns
|
|
5254
5265
|
|
|
@@ -5277,9 +5288,9 @@ AES 解密
|
|
|
5277
5288
|
|
|
5278
5289
|
#### encrypt
|
|
5279
5290
|
|
|
5280
|
-
|
|
5291
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5281
5292
|
|
|
5282
|
-
|
|
5293
|
+
需解密的字符串
|
|
5283
5294
|
|
|
5284
5295
|
#### key
|
|
5285
5296
|
|
|
@@ -5309,9 +5320,9 @@ AES 解密
|
|
|
5309
5320
|
|
|
5310
5321
|
#### encrypt
|
|
5311
5322
|
|
|
5312
|
-
|
|
5323
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5313
5324
|
|
|
5314
|
-
|
|
5325
|
+
需解密的字符串
|
|
5315
5326
|
|
|
5316
5327
|
#### key
|
|
5317
5328
|
|
|
@@ -5352,9 +5363,9 @@ AES GCM 托管加密
|
|
|
5352
5363
|
|
|
5353
5364
|
#### original
|
|
5354
5365
|
|
|
5355
|
-
|
|
5366
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5356
5367
|
|
|
5357
|
-
|
|
5368
|
+
原始字符串
|
|
5358
5369
|
|
|
5359
5370
|
#### key
|
|
5360
5371
|
|
|
@@ -5384,9 +5395,9 @@ AES GCM 托管加密
|
|
|
5384
5395
|
|
|
5385
5396
|
#### original
|
|
5386
5397
|
|
|
5387
|
-
|
|
5398
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5388
5399
|
|
|
5389
|
-
|
|
5400
|
+
原始字符串
|
|
5390
5401
|
|
|
5391
5402
|
#### key
|
|
5392
5403
|
|
|
@@ -5498,9 +5509,9 @@ hash 或 hmac 加密
|
|
|
5498
5509
|
|
|
5499
5510
|
#### data
|
|
5500
5511
|
|
|
5501
|
-
|
|
5512
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5502
5513
|
|
|
5503
|
-
|
|
5514
|
+
源数据
|
|
5504
5515
|
|
|
5505
5516
|
#### key?
|
|
5506
5517
|
|
|
@@ -5510,7 +5521,7 @@ hash 或 hmac 加密
|
|
|
5510
5521
|
|
|
5511
5522
|
#### format?
|
|
5512
5523
|
|
|
5513
|
-
`"hex"`
|
|
5524
|
+
`"hex"` \| `"base64"`
|
|
5514
5525
|
|
|
5515
5526
|
### Returns
|
|
5516
5527
|
|
|
@@ -5534,15 +5545,15 @@ hash 或 hmac 加密
|
|
|
5534
5545
|
|
|
5535
5546
|
#### data
|
|
5536
5547
|
|
|
5537
|
-
|
|
5548
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5538
5549
|
|
|
5539
|
-
|
|
5550
|
+
源数据
|
|
5540
5551
|
|
|
5541
5552
|
#### key
|
|
5542
5553
|
|
|
5543
|
-
|
|
5554
|
+
`CipherKey` \| `undefined`
|
|
5544
5555
|
|
|
5545
|
-
|
|
5556
|
+
设置则采用 hmac 加密
|
|
5546
5557
|
|
|
5547
5558
|
#### format
|
|
5548
5559
|
|
|
@@ -5593,7 +5604,7 @@ hash 或 hmac 加密文件
|
|
|
5593
5604
|
|
|
5594
5605
|
#### encoding?
|
|
5595
5606
|
|
|
5596
|
-
`"hex"`
|
|
5607
|
+
`"hex"` \| `"base64"` \| `"base64url"`
|
|
5597
5608
|
|
|
5598
5609
|
### Returns
|
|
5599
5610
|
|
|
@@ -5656,15 +5667,15 @@ Defined in: [lib/crypto.ts:136](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
5656
5667
|
|
|
5657
5668
|
### key
|
|
5658
5669
|
|
|
5659
|
-
|
|
5670
|
+
`KeyLike` \| `RsaPrivateKey`
|
|
5660
5671
|
|
|
5661
|
-
|
|
5672
|
+
私钥
|
|
5662
5673
|
|
|
5663
5674
|
### buffer
|
|
5664
5675
|
|
|
5665
|
-
|
|
5676
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
5666
5677
|
|
|
5667
|
-
|
|
5678
|
+
数据
|
|
5668
5679
|
|
|
5669
5680
|
## Returns
|
|
5670
5681
|
|
|
@@ -5691,16 +5702,16 @@ Defined in: [lib/crypto.ts:114](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
5691
5702
|
|
|
5692
5703
|
### key
|
|
5693
5704
|
|
|
5694
|
-
|
|
5705
|
+
`KeyLike` \| `RsaPrivateKey`
|
|
5695
5706
|
|
|
5696
|
-
|
|
5707
|
+
私钥
|
|
5697
5708
|
|
|
5698
5709
|
### buffer
|
|
5699
5710
|
|
|
5711
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
5712
|
+
|
|
5700
5713
|
数据
|
|
5701
5714
|
|
|
5702
|
-
`string` | `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
5703
|
-
|
|
5704
5715
|
## Returns
|
|
5705
5716
|
|
|
5706
5717
|
`Buffer`
|
|
@@ -5726,15 +5737,15 @@ Defined in: [lib/crypto.ts:125](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
5726
5737
|
|
|
5727
5738
|
### key
|
|
5728
5739
|
|
|
5729
|
-
|
|
5740
|
+
`KeyLike` \| `RsaPublicKey` \| `RsaPrivateKey`
|
|
5730
5741
|
|
|
5731
|
-
|
|
5742
|
+
公钥
|
|
5732
5743
|
|
|
5733
5744
|
### buffer
|
|
5734
5745
|
|
|
5735
|
-
|
|
5746
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
5736
5747
|
|
|
5737
|
-
|
|
5748
|
+
数据
|
|
5738
5749
|
|
|
5739
5750
|
## Returns
|
|
5740
5751
|
|
|
@@ -5761,15 +5772,15 @@ Defined in: [lib/crypto.ts:103](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
5761
5772
|
|
|
5762
5773
|
### key
|
|
5763
5774
|
|
|
5764
|
-
|
|
5775
|
+
`KeyLike` \| `RsaPublicKey` \| `RsaPrivateKey`
|
|
5765
5776
|
|
|
5766
|
-
|
|
5777
|
+
公钥
|
|
5767
5778
|
|
|
5768
5779
|
### buffer
|
|
5769
5780
|
|
|
5770
|
-
|
|
5781
|
+
`string` \| `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
5771
5782
|
|
|
5772
|
-
|
|
5783
|
+
数据
|
|
5773
5784
|
|
|
5774
5785
|
## Returns
|
|
5775
5786
|
|
|
@@ -5804,15 +5815,15 @@ Defined in: [lib/crypto.ts:69](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
5804
5815
|
|
|
5805
5816
|
#### privateKey
|
|
5806
5817
|
|
|
5807
|
-
|
|
5818
|
+
`KeyLike` \| `SignKeyObjectInput` \| `SignPrivateKeyInput` \| `SignJsonWebKeyInput`
|
|
5808
5819
|
|
|
5809
|
-
|
|
5820
|
+
私钥
|
|
5810
5821
|
|
|
5811
5822
|
#### format
|
|
5812
5823
|
|
|
5813
|
-
|
|
5824
|
+
`"binary"` \| `"hex"` \| `"base64"`
|
|
5814
5825
|
|
|
5815
|
-
|
|
5826
|
+
输出格式
|
|
5816
5827
|
|
|
5817
5828
|
#### algorithm?
|
|
5818
5829
|
|
|
@@ -5842,9 +5853,9 @@ Defined in: [lib/crypto.ts:72](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
5842
5853
|
|
|
5843
5854
|
#### privateKey
|
|
5844
5855
|
|
|
5845
|
-
|
|
5856
|
+
`KeyLike` \| `SignKeyObjectInput` \| `SignPrivateKeyInput` \| `SignJsonWebKeyInput`
|
|
5846
5857
|
|
|
5847
|
-
|
|
5858
|
+
私钥
|
|
5848
5859
|
|
|
5849
5860
|
#### format?
|
|
5850
5861
|
|
|
@@ -5885,9 +5896,9 @@ SM4 解密
|
|
|
5885
5896
|
|
|
5886
5897
|
#### encrypt
|
|
5887
5898
|
|
|
5888
|
-
|
|
5899
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5889
5900
|
|
|
5890
|
-
|
|
5901
|
+
需解密的字符串
|
|
5891
5902
|
|
|
5892
5903
|
#### key
|
|
5893
5904
|
|
|
@@ -5927,9 +5938,9 @@ SM4 解密
|
|
|
5927
5938
|
|
|
5928
5939
|
#### encrypt
|
|
5929
5940
|
|
|
5930
|
-
|
|
5941
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5931
5942
|
|
|
5932
|
-
|
|
5943
|
+
需解密的字符串
|
|
5933
5944
|
|
|
5934
5945
|
#### key
|
|
5935
5946
|
|
|
@@ -5980,9 +5991,9 @@ SM4 加密
|
|
|
5980
5991
|
|
|
5981
5992
|
#### original
|
|
5982
5993
|
|
|
5983
|
-
|
|
5994
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
5984
5995
|
|
|
5985
|
-
|
|
5996
|
+
原始字符串
|
|
5986
5997
|
|
|
5987
5998
|
#### key
|
|
5988
5999
|
|
|
@@ -6022,9 +6033,9 @@ SM4 加密
|
|
|
6022
6033
|
|
|
6023
6034
|
#### original
|
|
6024
6035
|
|
|
6025
|
-
|
|
6036
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
6026
6037
|
|
|
6027
|
-
|
|
6038
|
+
原始字符串
|
|
6028
6039
|
|
|
6029
6040
|
#### key
|
|
6030
6041
|
|
|
@@ -6108,9 +6119,9 @@ Defined in: [lib/crypto.ts:90](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
6108
6119
|
|
|
6109
6120
|
### object
|
|
6110
6121
|
|
|
6111
|
-
|
|
6122
|
+
`KeyLike` \| `VerifyKeyObjectInput` \| `VerifyPublicKeyInput` \| `VerifyJsonWebKeyInput`
|
|
6112
6123
|
|
|
6113
|
-
|
|
6124
|
+
证书
|
|
6114
6125
|
|
|
6115
6126
|
### signature
|
|
6116
6127
|
|
|
@@ -6320,7 +6331,7 @@ Defined in: [lib/db/conn.ts:59](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
6320
6331
|
|
|
6321
6332
|
##### link
|
|
6322
6333
|
|
|
6323
|
-
`Connection`
|
|
6334
|
+
`Connection` \| `Client`
|
|
6324
6335
|
|
|
6325
6336
|
#### Returns
|
|
6326
6337
|
|
|
@@ -6675,14 +6686,20 @@ Defined in: [lib/db.ts:68](https://github.com/maiyunnet/kebab/blob/master/lib/db
|
|
|
6675
6686
|
|
|
6676
6687
|
### ctrEtc
|
|
6677
6688
|
|
|
6678
|
-
|
|
6689
|
+
[`IConfigDb`](../../../index/interfaces/IConfigDb.md) \| [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
6679
6690
|
|
|
6680
|
-
|
|
6691
|
+
控制器对象或数据库配置信息
|
|
6681
6692
|
|
|
6682
6693
|
### opt?
|
|
6683
6694
|
|
|
6684
6695
|
选项
|
|
6685
6696
|
|
|
6697
|
+
#### read?
|
|
6698
|
+
|
|
6699
|
+
`boolean`
|
|
6700
|
+
|
|
6701
|
+
是否使用只读库,默认 false
|
|
6702
|
+
|
|
6686
6703
|
#### service?
|
|
6687
6704
|
|
|
6688
6705
|
[`ESERVICE`](../enumerations/ESERVICE.md)
|
|
@@ -6861,22 +6878,26 @@ Defined in: [lib/db.ts:47](https://github.com/maiyunnet/kebab/blob/master/lib/db
|
|
|
6861
6878
|
|
|
6862
6879
|
Defined in: [lib/db.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/db.ts#L41)
|
|
6863
6880
|
|
|
6864
|
-
####
|
|
6881
|
+
#### Union Members
|
|
6882
|
+
|
|
6883
|
+
##### Type Literal
|
|
6865
6884
|
|
|
6866
6885
|
\{ `affected`: `number`; `insert`: `number`; \}
|
|
6867
6886
|
|
|
6868
|
-
|
|
6887
|
+
##### affected
|
|
6869
6888
|
|
|
6870
6889
|
> **affected**: `number`
|
|
6871
6890
|
|
|
6872
6891
|
受影响的行数
|
|
6873
6892
|
|
|
6874
|
-
|
|
6893
|
+
##### insert
|
|
6875
6894
|
|
|
6876
6895
|
> **insert**: `number`
|
|
6877
6896
|
|
|
6878
6897
|
插入的 id
|
|
6879
6898
|
|
|
6899
|
+
***
|
|
6900
|
+
|
|
6880
6901
|
`null`
|
|
6881
6902
|
|
|
6882
6903
|
***
|
|
@@ -6944,7 +6965,7 @@ Defined in: [lib/db/pool.ts:194](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
6944
6965
|
|
|
6945
6966
|
##### ctr
|
|
6946
6967
|
|
|
6947
|
-
[`Ctr`](../../../../sys/ctr/classes/Ctr.md)
|
|
6968
|
+
[`Ctr`](../../../../sys/ctr/classes/Ctr.md) \| `null`
|
|
6948
6969
|
|
|
6949
6970
|
#### Returns
|
|
6950
6971
|
|
|
@@ -7145,7 +7166,7 @@ Defined in: [lib/db/pool.ts:27](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
7145
7166
|
|
|
7146
7167
|
### name?
|
|
7147
7168
|
|
|
7148
|
-
> `optional` **name
|
|
7169
|
+
> `optional` **name?**: `string`
|
|
7149
7170
|
|
|
7150
7171
|
Defined in: [lib/db/pool.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/db/pool.ts#L24)
|
|
7151
7172
|
|
|
@@ -7216,7 +7237,7 @@ Defined in: [lib/db/tran.ts:28](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
7216
7237
|
|
|
7217
7238
|
##### ctr
|
|
7218
7239
|
|
|
7219
|
-
[`Ctr`](../../../../sys/ctr/classes/Ctr.md)
|
|
7240
|
+
[`Ctr`](../../../../sys/ctr/classes/Ctr.md) \| `null`
|
|
7220
7241
|
|
|
7221
7242
|
##### conn
|
|
7222
7243
|
|
|
@@ -7862,7 +7883,7 @@ Defined in: [lib/dns.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/d
|
|
|
7862
7883
|
|
|
7863
7884
|
### secretId?
|
|
7864
7885
|
|
|
7865
|
-
> `optional` **secretId
|
|
7886
|
+
> `optional` **secretId?**: `string`
|
|
7866
7887
|
|
|
7867
7888
|
Defined in: [lib/dns.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L31)
|
|
7868
7889
|
|
|
@@ -7872,7 +7893,7 @@ Defined in: [lib/dns.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/d
|
|
|
7872
7893
|
|
|
7873
7894
|
### secretKey?
|
|
7874
7895
|
|
|
7875
|
-
> `optional` **secretKey
|
|
7896
|
+
> `optional` **secretKey?**: `string`
|
|
7876
7897
|
|
|
7877
7898
|
Defined in: [lib/dns.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/dns.ts#L33)
|
|
7878
7899
|
|
|
@@ -7915,9 +7936,9 @@ Defined in: [lib/fs.ts:278](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
7915
7936
|
|
|
7916
7937
|
### mod
|
|
7917
7938
|
|
|
7918
|
-
|
|
7939
|
+
`string` \| `number`
|
|
7919
7940
|
|
|
7920
|
-
|
|
7941
|
+
权限
|
|
7921
7942
|
|
|
7922
7943
|
## Returns
|
|
7923
7944
|
|
|
@@ -8026,9 +8047,9 @@ Defined in: [lib/fs.ts:401](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
8026
8047
|
|
|
8027
8048
|
### options?
|
|
8028
8049
|
|
|
8029
|
-
|
|
8050
|
+
`BufferEncoding` \| \{ `autoClose?`: `boolean`; `encoding?`: BufferEncoding \| undefined; `end?`: `number`; `flags?`: `string`; `start?`: `number`; \}
|
|
8030
8051
|
|
|
8031
|
-
|
|
8052
|
+
编码或配置
|
|
8032
8053
|
|
|
8033
8054
|
## Returns
|
|
8034
8055
|
|
|
@@ -8061,9 +8082,9 @@ Defined in: [lib/fs.ts:448](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
8061
8082
|
|
|
8062
8083
|
### options?
|
|
8063
8084
|
|
|
8064
|
-
|
|
8085
|
+
`BufferEncoding` \| \{ `autoClose?`: `boolean`; `encoding?`: BufferEncoding \| undefined; `flags?`: `string`; `mode?`: `number`; `start?`: `number`; \}
|
|
8065
8086
|
|
|
8066
|
-
|
|
8087
|
+
编码或配置
|
|
8067
8088
|
|
|
8068
8089
|
## Returns
|
|
8069
8090
|
|
|
@@ -8130,7 +8151,7 @@ Defined in: [lib/fs.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/fs
|
|
|
8130
8151
|
|
|
8131
8152
|
#### options
|
|
8132
8153
|
|
|
8133
|
-
`BufferEncoding`
|
|
8154
|
+
`BufferEncoding` \| \{ `encoding`: `BufferEncoding`; `end?`: `number`; `start?`: `number`; \}
|
|
8134
8155
|
|
|
8135
8156
|
### Returns
|
|
8136
8157
|
|
|
@@ -8299,9 +8320,9 @@ Defined in: [lib/fs.ts:93](https://github.com/maiyunnet/kebab/blob/master/lib/fs
|
|
|
8299
8320
|
|
|
8300
8321
|
### data
|
|
8301
8322
|
|
|
8302
|
-
|
|
8323
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
8303
8324
|
|
|
8304
|
-
|
|
8325
|
+
要写入的内容
|
|
8305
8326
|
|
|
8306
8327
|
### options?
|
|
8307
8328
|
|
|
@@ -8418,21 +8439,21 @@ Defined in: [lib/fs.ts:479](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
8418
8439
|
|
|
8419
8440
|
### req
|
|
8420
8441
|
|
|
8421
|
-
|
|
8442
|
+
`IncomingMessage` \| `Http2ServerRequest`
|
|
8422
8443
|
|
|
8423
|
-
|
|
8444
|
+
http 请求对象
|
|
8424
8445
|
|
|
8425
8446
|
### res
|
|
8426
8447
|
|
|
8427
|
-
|
|
8448
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
8428
8449
|
|
|
8429
|
-
|
|
8450
|
+
http 响应对象
|
|
8430
8451
|
|
|
8431
8452
|
### stat?
|
|
8432
8453
|
|
|
8433
|
-
|
|
8454
|
+
`Stats` \| `null`
|
|
8434
8455
|
|
|
8435
|
-
|
|
8456
|
+
文件的 stat(如果有)
|
|
8436
8457
|
|
|
8437
8458
|
## Returns
|
|
8438
8459
|
|
|
@@ -8593,9 +8614,9 @@ Defined in: [lib/fs.ts:132](https://github.com/maiyunnet/kebab/blob/master/lib/f
|
|
|
8593
8614
|
|
|
8594
8615
|
### type?
|
|
8595
8616
|
|
|
8596
|
-
|
|
8617
|
+
`"file"` \| `"dir"` \| `"junction"`
|
|
8597
8618
|
|
|
8598
|
-
|
|
8619
|
+
仅 Windows,类型,默认 file
|
|
8599
8620
|
|
|
8600
8621
|
## Returns
|
|
8601
8622
|
|
|
@@ -8725,7 +8746,7 @@ Defined in: [lib/kv.ts:115](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8725
8746
|
|
|
8726
8747
|
##### val
|
|
8727
8748
|
|
|
8728
|
-
`string`
|
|
8749
|
+
`string` \| `number` \| `object`
|
|
8729
8750
|
|
|
8730
8751
|
##### ttl?
|
|
8731
8752
|
|
|
@@ -8785,11 +8806,11 @@ Defined in: [lib/kv.ts:741](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8785
8806
|
|
|
8786
8807
|
##### soo
|
|
8787
8808
|
|
|
8788
|
-
`"LEFT"`
|
|
8809
|
+
`"LEFT"` \| `"RIGHT"`
|
|
8789
8810
|
|
|
8790
8811
|
##### deo
|
|
8791
8812
|
|
|
8792
|
-
`"LEFT"`
|
|
8813
|
+
`"LEFT"` \| `"RIGHT"`
|
|
8793
8814
|
|
|
8794
8815
|
##### timeout
|
|
8795
8816
|
|
|
@@ -8811,7 +8832,7 @@ Defined in: [lib/kv.ts:780](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8811
8832
|
|
|
8812
8833
|
##### key
|
|
8813
8834
|
|
|
8814
|
-
`string`
|
|
8835
|
+
`string` \| `string`[]
|
|
8815
8836
|
|
|
8816
8837
|
##### timeout
|
|
8817
8838
|
|
|
@@ -8861,7 +8882,7 @@ Defined in: [lib/kv.ts:335](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8861
8882
|
|
|
8862
8883
|
##### keys
|
|
8863
8884
|
|
|
8864
|
-
`string`
|
|
8885
|
+
`string` \| `string`[]
|
|
8865
8886
|
|
|
8866
8887
|
#### Returns
|
|
8867
8888
|
|
|
@@ -8881,9 +8902,9 @@ Defined in: [lib/kv.ts:194](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8881
8902
|
|
|
8882
8903
|
##### keys
|
|
8883
8904
|
|
|
8884
|
-
|
|
8905
|
+
`string` \| `string`[]
|
|
8885
8906
|
|
|
8886
|
-
|
|
8907
|
+
单个或序列
|
|
8887
8908
|
|
|
8888
8909
|
#### Returns
|
|
8889
8910
|
|
|
@@ -8987,9 +9008,9 @@ Defined in: [lib/kv.ts:643](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
8987
9008
|
|
|
8988
9009
|
##### fields
|
|
8989
9010
|
|
|
8990
|
-
|
|
9011
|
+
`string` \| `string`[]
|
|
8991
9012
|
|
|
8992
|
-
|
|
9013
|
+
值序列
|
|
8993
9014
|
|
|
8994
9015
|
#### Returns
|
|
8995
9016
|
|
|
@@ -9219,15 +9240,15 @@ key 名
|
|
|
9219
9240
|
|
|
9220
9241
|
##### val
|
|
9221
9242
|
|
|
9222
|
-
|
|
9243
|
+
`string` \| `number` \| `object`
|
|
9223
9244
|
|
|
9224
|
-
|
|
9245
|
+
值
|
|
9225
9246
|
|
|
9226
9247
|
##### mod?
|
|
9227
9248
|
|
|
9228
|
-
|
|
9249
|
+
`""` \| `"nx"`
|
|
9229
9250
|
|
|
9230
|
-
|
|
9251
|
+
空,nx(key不存在才建立)
|
|
9231
9252
|
|
|
9232
9253
|
#### Returns
|
|
9233
9254
|
|
|
@@ -9501,9 +9522,9 @@ Defined in: [lib/kv.ts:129](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9501
9522
|
|
|
9502
9523
|
##### val
|
|
9503
9524
|
|
|
9504
|
-
|
|
9525
|
+
`string` \| `number` \| `object`
|
|
9505
9526
|
|
|
9506
|
-
|
|
9527
|
+
值
|
|
9507
9528
|
|
|
9508
9529
|
##### ttl?
|
|
9509
9530
|
|
|
@@ -9605,7 +9626,7 @@ Defined in: [lib/kv.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/kv
|
|
|
9605
9626
|
|
|
9606
9627
|
##### val
|
|
9607
9628
|
|
|
9608
|
-
`string`
|
|
9629
|
+
`string` \| `number` \| `object`
|
|
9609
9630
|
|
|
9610
9631
|
##### ttl?
|
|
9611
9632
|
|
|
@@ -9615,9 +9636,9 @@ Defined in: [lib/kv.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/kv
|
|
|
9615
9636
|
|
|
9616
9637
|
##### mod?
|
|
9617
9638
|
|
|
9618
|
-
|
|
9639
|
+
`""` \| `"nx"` \| `"xx"`
|
|
9619
9640
|
|
|
9620
|
-
|
|
9641
|
+
设置模式: 空,nx(key不存在才建立),xx(key存在才修改)
|
|
9621
9642
|
|
|
9622
9643
|
#### Returns
|
|
9623
9644
|
|
|
@@ -9673,9 +9694,9 @@ key 名
|
|
|
9673
9694
|
|
|
9674
9695
|
###### member
|
|
9675
9696
|
|
|
9676
|
-
|
|
9697
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
9677
9698
|
|
|
9678
|
-
|
|
9699
|
+
成员
|
|
9679
9700
|
|
|
9680
9701
|
##### Returns
|
|
9681
9702
|
|
|
@@ -9850,9 +9871,9 @@ Defined in: [lib/kv.ts:956](https://github.com/maiyunnet/kebab/blob/master/lib/k
|
|
|
9850
9871
|
|
|
9851
9872
|
### ctrEtc
|
|
9852
9873
|
|
|
9853
|
-
|
|
9874
|
+
[`IConfigKv`](../../../index/interfaces/IConfigKv.md) \| [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
9854
9875
|
|
|
9855
|
-
|
|
9876
|
+
控制器或配置信息
|
|
9856
9877
|
|
|
9857
9878
|
### oetc?
|
|
9858
9879
|
|
|
@@ -9962,7 +9983,7 @@ Defined in: [lib/kv.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/kv
|
|
|
9962
9983
|
|
|
9963
9984
|
### by?
|
|
9964
9985
|
|
|
9965
|
-
> `optional` **by
|
|
9986
|
+
> `optional` **by?**: `"SCORE"` \| `"LEX"`
|
|
9966
9987
|
|
|
9967
9988
|
Defined in: [lib/kv.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L22)
|
|
9968
9989
|
|
|
@@ -9975,7 +9996,7 @@ Range query type.
|
|
|
9975
9996
|
|
|
9976
9997
|
### count?
|
|
9977
9998
|
|
|
9978
|
-
> `optional` **count
|
|
9999
|
+
> `optional` **count?**: `number`
|
|
9979
10000
|
|
|
9980
10001
|
Defined in: [lib/kv.ts:37](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L37)
|
|
9981
10002
|
|
|
@@ -9985,7 +10006,7 @@ Pagination count. Must be used together with offset.
|
|
|
9985
10006
|
|
|
9986
10007
|
### offset?
|
|
9987
10008
|
|
|
9988
|
-
> `optional` **offset
|
|
10009
|
+
> `optional` **offset?**: `number`
|
|
9989
10010
|
|
|
9990
10011
|
Defined in: [lib/kv.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L32)
|
|
9991
10012
|
|
|
@@ -9995,7 +10016,7 @@ Pagination offset. Must be used together with count.
|
|
|
9995
10016
|
|
|
9996
10017
|
### rev?
|
|
9997
10018
|
|
|
9998
|
-
> `optional` **rev
|
|
10019
|
+
> `optional` **rev?**: `boolean`
|
|
9999
10020
|
|
|
10000
10021
|
Defined in: [lib/kv.ts:27](https://github.com/maiyunnet/kebab/blob/master/lib/kv.ts#L27)
|
|
10001
10022
|
|
|
@@ -10181,7 +10202,7 @@ Defined in: [lib/net/formdata.ts:37](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
10181
10202
|
|
|
10182
10203
|
> **new FormData**(`options?`): `FormData`
|
|
10183
10204
|
|
|
10184
|
-
Defined in: node\_modules/@types/node/stream.d.ts:
|
|
10205
|
+
Defined in: node\_modules/@types/node/stream.d.ts:99
|
|
10185
10206
|
|
|
10186
10207
|
#### Parameters
|
|
10187
10208
|
|
|
@@ -10389,73 +10410,83 @@ Defined in: [lib/net/formdata.ts:12](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
10389
10410
|
|
|
10390
10411
|
Item 对象
|
|
10391
10412
|
|
|
10392
|
-
##
|
|
10413
|
+
## Union Members
|
|
10414
|
+
|
|
10415
|
+
### Type Literal
|
|
10393
10416
|
|
|
10394
10417
|
\{ `key`: `string`; `path`: `""`; `type`: `"string"`; `value`: `string`; \}
|
|
10395
10418
|
|
|
10396
|
-
|
|
10419
|
+
#### key
|
|
10397
10420
|
|
|
10398
10421
|
> **key**: `string`
|
|
10399
10422
|
|
|
10400
10423
|
key 键
|
|
10401
10424
|
|
|
10402
|
-
|
|
10425
|
+
#### path
|
|
10403
10426
|
|
|
10404
10427
|
> **path**: `""`
|
|
10405
10428
|
|
|
10406
|
-
|
|
10429
|
+
#### type
|
|
10407
10430
|
|
|
10408
10431
|
> **type**: `"string"`
|
|
10409
10432
|
|
|
10410
|
-
|
|
10433
|
+
#### value
|
|
10411
10434
|
|
|
10412
10435
|
> **value**: `string`
|
|
10413
10436
|
|
|
10414
10437
|
字符串值
|
|
10415
10438
|
|
|
10439
|
+
***
|
|
10440
|
+
|
|
10441
|
+
### Type Literal
|
|
10442
|
+
|
|
10416
10443
|
\{ `key`: `string`; `path`: `string`; `type`: `"file"`; `value`: `string`; \}
|
|
10417
10444
|
|
|
10418
|
-
|
|
10445
|
+
#### key
|
|
10419
10446
|
|
|
10420
10447
|
> **key**: `string`
|
|
10421
10448
|
|
|
10422
10449
|
key 键
|
|
10423
10450
|
|
|
10424
|
-
|
|
10451
|
+
#### path
|
|
10425
10452
|
|
|
10426
10453
|
> **path**: `string`
|
|
10427
10454
|
|
|
10428
10455
|
文件路径
|
|
10429
10456
|
|
|
10430
|
-
|
|
10457
|
+
#### type
|
|
10431
10458
|
|
|
10432
10459
|
> **type**: `"file"`
|
|
10433
10460
|
|
|
10434
|
-
|
|
10461
|
+
#### value
|
|
10435
10462
|
|
|
10436
10463
|
> **value**: `string`
|
|
10437
10464
|
|
|
10438
10465
|
文件名
|
|
10439
10466
|
|
|
10467
|
+
***
|
|
10468
|
+
|
|
10469
|
+
### Type Literal
|
|
10470
|
+
|
|
10440
10471
|
\{ `key`: `string`; `path`: `Buffer`; `type`: `"buffer"`; `value`: `string`; \}
|
|
10441
10472
|
|
|
10442
|
-
|
|
10473
|
+
#### key
|
|
10443
10474
|
|
|
10444
10475
|
> **key**: `string`
|
|
10445
10476
|
|
|
10446
10477
|
key 键
|
|
10447
10478
|
|
|
10448
|
-
|
|
10479
|
+
#### path
|
|
10449
10480
|
|
|
10450
10481
|
> **path**: `Buffer`
|
|
10451
10482
|
|
|
10452
10483
|
Buffer 数据
|
|
10453
10484
|
|
|
10454
|
-
|
|
10485
|
+
#### type
|
|
10455
10486
|
|
|
10456
10487
|
> **type**: `"buffer"`
|
|
10457
10488
|
|
|
10458
|
-
|
|
10489
|
+
#### value
|
|
10459
10490
|
|
|
10460
10491
|
> **value**: `string`
|
|
10461
10492
|
|
|
@@ -10517,9 +10548,9 @@ Defined in: [lib/net.ts:133](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10517
10548
|
|
|
10518
10549
|
### input
|
|
10519
10550
|
|
|
10520
|
-
|
|
10551
|
+
`string` \| `Request` \| `URL`
|
|
10521
10552
|
|
|
10522
|
-
|
|
10553
|
+
请求的 URL 或 Request 对象
|
|
10523
10554
|
|
|
10524
10555
|
### init?
|
|
10525
10556
|
|
|
@@ -10552,15 +10583,15 @@ Defined in: [lib/net.ts:717](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10552
10583
|
|
|
10553
10584
|
### headers
|
|
10554
10585
|
|
|
10555
|
-
|
|
10586
|
+
`IncomingHttpHeaders` \| `IncomingHttpHeaders` \| [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
10556
10587
|
|
|
10557
|
-
|
|
10588
|
+
剔除前的 header
|
|
10558
10589
|
|
|
10559
10590
|
### res?
|
|
10560
10591
|
|
|
10561
|
-
|
|
10592
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
10562
10593
|
|
|
10563
|
-
|
|
10594
|
+
直接设置头部而不返回,可置空
|
|
10564
10595
|
|
|
10565
10596
|
### filter?
|
|
10566
10597
|
|
|
@@ -10774,9 +10805,9 @@ Defined in: [lib/net.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/n
|
|
|
10774
10805
|
|
|
10775
10806
|
### data
|
|
10776
10807
|
|
|
10777
|
-
|
|
10808
|
+
`string` \| `Record`\<`string`, `any`\> \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
10778
10809
|
|
|
10779
|
-
|
|
10810
|
+
要发送的数据
|
|
10780
10811
|
|
|
10781
10812
|
### opt?
|
|
10782
10813
|
|
|
@@ -10815,9 +10846,9 @@ Defined in: [lib/net.ts:94](https://github.com/maiyunnet/kebab/blob/master/lib/n
|
|
|
10815
10846
|
|
|
10816
10847
|
### data
|
|
10817
10848
|
|
|
10818
|
-
|
|
10849
|
+
`any`[] \| `Record`\<`string`, `any`\>
|
|
10819
10850
|
|
|
10820
|
-
|
|
10851
|
+
数据
|
|
10821
10852
|
|
|
10822
10853
|
### opt?
|
|
10823
10854
|
|
|
@@ -10856,9 +10887,9 @@ Defined in: [lib/net.ts:111](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10856
10887
|
|
|
10857
10888
|
### data
|
|
10858
10889
|
|
|
10859
|
-
|
|
10890
|
+
`any`[] \| `Record`\<`string`, `any`\>
|
|
10860
10891
|
|
|
10861
|
-
|
|
10892
|
+
数据
|
|
10862
10893
|
|
|
10863
10894
|
### opt?
|
|
10864
10895
|
|
|
@@ -10897,7 +10928,7 @@ Defined in: [lib/net.ts:283](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
10897
10928
|
|
|
10898
10929
|
### data?
|
|
10899
10930
|
|
|
10900
|
-
`string`
|
|
10931
|
+
`string` \| `Record`\<`string`, `any`\> \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
10901
10932
|
|
|
10902
10933
|
### opt?
|
|
10903
10934
|
|
|
@@ -11177,9 +11208,9 @@ Defined in: [lib/net.ts:907](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11177
11208
|
|
|
11178
11209
|
## Properties
|
|
11179
11210
|
|
|
11180
|
-
### filter
|
|
11211
|
+
### filter?
|
|
11181
11212
|
|
|
11182
|
-
> `optional` **filter
|
|
11213
|
+
> `optional` **filter?**: (`h`) => `boolean`
|
|
11183
11214
|
|
|
11184
11215
|
Defined in: [lib/net.ts:916](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L916)
|
|
11185
11216
|
|
|
@@ -11199,7 +11230,7 @@ Defined in: [lib/net.ts:916](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11199
11230
|
|
|
11200
11231
|
### follow?
|
|
11201
11232
|
|
|
11202
|
-
> `optional` **follow
|
|
11233
|
+
> `optional` **follow?**: `number`
|
|
11203
11234
|
|
|
11204
11235
|
Defined in: [lib/net.ts:910](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L910)
|
|
11205
11236
|
|
|
@@ -11207,7 +11238,7 @@ Defined in: [lib/net.ts:910](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11207
11238
|
|
|
11208
11239
|
### headers?
|
|
11209
11240
|
|
|
11210
|
-
> `optional` **headers
|
|
11241
|
+
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11211
11242
|
|
|
11212
11243
|
Defined in: [lib/net.ts:914](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L914)
|
|
11213
11244
|
|
|
@@ -11215,7 +11246,7 @@ Defined in: [lib/net.ts:914](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11215
11246
|
|
|
11216
11247
|
### hosts?
|
|
11217
11248
|
|
|
11218
|
-
> `optional` **hosts
|
|
11249
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11219
11250
|
|
|
11220
11251
|
Defined in: [lib/net.ts:912](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L912)
|
|
11221
11252
|
|
|
@@ -11225,7 +11256,7 @@ Defined in: [lib/net.ts:912](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11225
11256
|
|
|
11226
11257
|
### local?
|
|
11227
11258
|
|
|
11228
|
-
> `optional` **local
|
|
11259
|
+
> `optional` **local?**: `string`
|
|
11229
11260
|
|
|
11230
11261
|
Defined in: [lib/net.ts:913](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L913)
|
|
11231
11262
|
|
|
@@ -11233,7 +11264,7 @@ Defined in: [lib/net.ts:913](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11233
11264
|
|
|
11234
11265
|
### reuse?
|
|
11235
11266
|
|
|
11236
|
-
> `optional` **reuse
|
|
11267
|
+
> `optional` **reuse?**: `string`
|
|
11237
11268
|
|
|
11238
11269
|
Defined in: [lib/net.ts:918](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L918)
|
|
11239
11270
|
|
|
@@ -11243,7 +11274,7 @@ Defined in: [lib/net.ts:918](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11243
11274
|
|
|
11244
11275
|
### timeout?
|
|
11245
11276
|
|
|
11246
|
-
> `optional` **timeout
|
|
11277
|
+
> `optional` **timeout?**: `number`
|
|
11247
11278
|
|
|
11248
11279
|
Defined in: [lib/net.ts:909](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L909)
|
|
11249
11280
|
|
|
@@ -11268,7 +11299,7 @@ Defined in: [lib/net.ts:876](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11268
11299
|
|
|
11269
11300
|
### cookie?
|
|
11270
11301
|
|
|
11271
|
-
> `optional` **cookie
|
|
11302
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](ICookie.md)\>
|
|
11272
11303
|
|
|
11273
11304
|
Defined in: [lib/net.ts:901](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L901)
|
|
11274
11305
|
|
|
@@ -11278,7 +11309,7 @@ cookie 托管对象
|
|
|
11278
11309
|
|
|
11279
11310
|
### follow?
|
|
11280
11311
|
|
|
11281
|
-
> `optional` **follow
|
|
11312
|
+
> `optional` **follow?**: `number`
|
|
11282
11313
|
|
|
11283
11314
|
Defined in: [lib/net.ts:882](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L882)
|
|
11284
11315
|
|
|
@@ -11288,7 +11319,7 @@ Defined in: [lib/net.ts:882](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11288
11319
|
|
|
11289
11320
|
### headers?
|
|
11290
11321
|
|
|
11291
|
-
> `optional` **headers
|
|
11322
|
+
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11292
11323
|
|
|
11293
11324
|
Defined in: [lib/net.ts:887](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L887)
|
|
11294
11325
|
|
|
@@ -11296,7 +11327,7 @@ Defined in: [lib/net.ts:887](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11296
11327
|
|
|
11297
11328
|
### hosts?
|
|
11298
11329
|
|
|
11299
|
-
> `optional` **hosts
|
|
11330
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11300
11331
|
|
|
11301
11332
|
Defined in: [lib/net.ts:884](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L884)
|
|
11302
11333
|
|
|
@@ -11306,7 +11337,7 @@ Defined in: [lib/net.ts:884](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11306
11337
|
|
|
11307
11338
|
### keep?
|
|
11308
11339
|
|
|
11309
|
-
> `optional` **keep
|
|
11340
|
+
> `optional` **keep?**: `boolean`
|
|
11310
11341
|
|
|
11311
11342
|
Defined in: [lib/net.ts:897](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L897)
|
|
11312
11343
|
|
|
@@ -11316,7 +11347,7 @@ Defined in: [lib/net.ts:897](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11316
11347
|
|
|
11317
11348
|
### local?
|
|
11318
11349
|
|
|
11319
|
-
> `optional` **local
|
|
11350
|
+
> `optional` **local?**: `string`
|
|
11320
11351
|
|
|
11321
11352
|
Defined in: [lib/net.ts:886](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L886)
|
|
11322
11353
|
|
|
@@ -11324,7 +11355,7 @@ Defined in: [lib/net.ts:886](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11324
11355
|
|
|
11325
11356
|
### log?
|
|
11326
11357
|
|
|
11327
|
-
> `optional` **log
|
|
11358
|
+
> `optional` **log?**: `boolean`
|
|
11328
11359
|
|
|
11329
11360
|
Defined in: [lib/net.ts:903](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L903)
|
|
11330
11361
|
|
|
@@ -11334,7 +11365,7 @@ Defined in: [lib/net.ts:903](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11334
11365
|
|
|
11335
11366
|
### method?
|
|
11336
11367
|
|
|
11337
|
-
> `optional` **method
|
|
11368
|
+
> `optional` **method?**: `"GET"` \| `"POST"` \| `"PUT"` \| `"DELETE"` \| `"OPTIONS"`
|
|
11338
11369
|
|
|
11339
11370
|
Defined in: [lib/net.ts:877](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L877)
|
|
11340
11371
|
|
|
@@ -11342,7 +11373,7 @@ Defined in: [lib/net.ts:877](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11342
11373
|
|
|
11343
11374
|
### mproxy?
|
|
11344
11375
|
|
|
11345
|
-
> `optional` **mproxy
|
|
11376
|
+
> `optional` **mproxy?**: `object`
|
|
11346
11377
|
|
|
11347
11378
|
Defined in: [lib/net.ts:889](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L889)
|
|
11348
11379
|
|
|
@@ -11354,11 +11385,11 @@ Defined in: [lib/net.ts:889](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11354
11385
|
|
|
11355
11386
|
#### data?
|
|
11356
11387
|
|
|
11357
|
-
> `optional` **data
|
|
11388
|
+
> `optional` **data?**: `any`
|
|
11358
11389
|
|
|
11359
11390
|
#### hosts?
|
|
11360
11391
|
|
|
11361
|
-
> `optional` **hosts
|
|
11392
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11362
11393
|
|
|
11363
11394
|
落地端自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11364
11395
|
|
|
@@ -11370,7 +11401,7 @@ Defined in: [lib/net.ts:889](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11370
11401
|
|
|
11371
11402
|
### reuse?
|
|
11372
11403
|
|
|
11373
|
-
> `optional` **reuse
|
|
11404
|
+
> `optional` **reuse?**: `string`
|
|
11374
11405
|
|
|
11375
11406
|
Defined in: [lib/net.ts:899](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L899)
|
|
11376
11407
|
|
|
@@ -11380,7 +11411,7 @@ Defined in: [lib/net.ts:899](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11380
11411
|
|
|
11381
11412
|
### save?
|
|
11382
11413
|
|
|
11383
|
-
> `optional` **save
|
|
11414
|
+
> `optional` **save?**: `string`
|
|
11384
11415
|
|
|
11385
11416
|
Defined in: [lib/net.ts:885](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L885)
|
|
11386
11417
|
|
|
@@ -11388,7 +11419,7 @@ Defined in: [lib/net.ts:885](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11388
11419
|
|
|
11389
11420
|
### timeout?
|
|
11390
11421
|
|
|
11391
|
-
> `optional` **timeout
|
|
11422
|
+
> `optional` **timeout?**: `number`
|
|
11392
11423
|
|
|
11393
11424
|
Defined in: [lib/net.ts:880](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L880)
|
|
11394
11425
|
|
|
@@ -11398,7 +11429,7 @@ Defined in: [lib/net.ts:880](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11398
11429
|
|
|
11399
11430
|
### type?
|
|
11400
11431
|
|
|
11401
|
-
> `optional` **type
|
|
11432
|
+
> `optional` **type?**: `"form"` \| `"json"`
|
|
11402
11433
|
|
|
11403
11434
|
Defined in: [lib/net.ts:878](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L878)
|
|
11404
11435
|
|
|
@@ -11419,9 +11450,9 @@ Defined in: [lib/net.ts:922](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11419
11450
|
|
|
11420
11451
|
## Properties
|
|
11421
11452
|
|
|
11422
|
-
### filter
|
|
11453
|
+
### filter?
|
|
11423
11454
|
|
|
11424
|
-
> `optional` **filter
|
|
11455
|
+
> `optional` **filter?**: (`h`) => `boolean`
|
|
11425
11456
|
|
|
11426
11457
|
Defined in: [lib/net.ts:931](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L931)
|
|
11427
11458
|
|
|
@@ -11441,7 +11472,7 @@ Defined in: [lib/net.ts:931](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11441
11472
|
|
|
11442
11473
|
### follow?
|
|
11443
11474
|
|
|
11444
|
-
> `optional` **follow
|
|
11475
|
+
> `optional` **follow?**: `number`
|
|
11445
11476
|
|
|
11446
11477
|
Defined in: [lib/net.ts:925](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L925)
|
|
11447
11478
|
|
|
@@ -11449,7 +11480,7 @@ Defined in: [lib/net.ts:925](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11449
11480
|
|
|
11450
11481
|
### headers?
|
|
11451
11482
|
|
|
11452
|
-
> `optional` **headers
|
|
11483
|
+
> `optional` **headers?**: [`THttpHeaders`](../type-aliases/THttpHeaders.md)
|
|
11453
11484
|
|
|
11454
11485
|
Defined in: [lib/net.ts:929](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L929)
|
|
11455
11486
|
|
|
@@ -11457,7 +11488,7 @@ Defined in: [lib/net.ts:929](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11457
11488
|
|
|
11458
11489
|
### hosts?
|
|
11459
11490
|
|
|
11460
|
-
> `optional` **hosts
|
|
11491
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11461
11492
|
|
|
11462
11493
|
Defined in: [lib/net.ts:927](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L927)
|
|
11463
11494
|
|
|
@@ -11467,7 +11498,7 @@ Defined in: [lib/net.ts:927](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11467
11498
|
|
|
11468
11499
|
### local?
|
|
11469
11500
|
|
|
11470
|
-
> `optional` **local
|
|
11501
|
+
> `optional` **local?**: `string`
|
|
11471
11502
|
|
|
11472
11503
|
Defined in: [lib/net.ts:928](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L928)
|
|
11473
11504
|
|
|
@@ -11475,7 +11506,7 @@ Defined in: [lib/net.ts:928](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11475
11506
|
|
|
11476
11507
|
### mproxy?
|
|
11477
11508
|
|
|
11478
|
-
> `optional` **mproxy
|
|
11509
|
+
> `optional` **mproxy?**: `object`
|
|
11479
11510
|
|
|
11480
11511
|
Defined in: [lib/net.ts:933](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L933)
|
|
11481
11512
|
|
|
@@ -11487,11 +11518,11 @@ Defined in: [lib/net.ts:933](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11487
11518
|
|
|
11488
11519
|
#### data?
|
|
11489
11520
|
|
|
11490
|
-
> `optional` **data
|
|
11521
|
+
> `optional` **data?**: `any`
|
|
11491
11522
|
|
|
11492
11523
|
#### hosts?
|
|
11493
11524
|
|
|
11494
|
-
> `optional` **hosts
|
|
11525
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
11495
11526
|
|
|
11496
11527
|
落地端自定义 host 映射,如 {'www.maiyun.net': '127.0.0.1'},或全部映射到一个 host
|
|
11497
11528
|
|
|
@@ -11503,7 +11534,7 @@ Defined in: [lib/net.ts:933](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11503
11534
|
|
|
11504
11535
|
### reuse?
|
|
11505
11536
|
|
|
11506
|
-
> `optional` **reuse
|
|
11537
|
+
> `optional` **reuse?**: `string`
|
|
11507
11538
|
|
|
11508
11539
|
Defined in: [lib/net.ts:941](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L941)
|
|
11509
11540
|
|
|
@@ -11513,7 +11544,7 @@ Defined in: [lib/net.ts:941](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
11513
11544
|
|
|
11514
11545
|
### timeout?
|
|
11515
11546
|
|
|
11516
|
-
> `optional` **timeout
|
|
11547
|
+
> `optional` **timeout?**: `number`
|
|
11517
11548
|
|
|
11518
11549
|
Defined in: [lib/net.ts:924](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L924)
|
|
11519
11550
|
|
|
@@ -11564,9 +11595,9 @@ Defined in: [lib/net/request.ts:29](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11564
11595
|
|
|
11565
11596
|
##### data
|
|
11566
11597
|
|
|
11567
|
-
|
|
11598
|
+
`string` \| `Record`\<`string`, `any`\> \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
11568
11599
|
|
|
11569
|
-
|
|
11600
|
+
数据
|
|
11570
11601
|
|
|
11571
11602
|
#### Returns
|
|
11572
11603
|
|
|
@@ -11640,7 +11671,7 @@ Defined in: [lib/net/request.ts:95](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11640
11671
|
|
|
11641
11672
|
##### hosts
|
|
11642
11673
|
|
|
11643
|
-
`string`
|
|
11674
|
+
`string` \| `Record`\<`string`, `string`\>
|
|
11644
11675
|
|
|
11645
11676
|
#### Returns
|
|
11646
11677
|
|
|
@@ -11694,7 +11725,7 @@ Defined in: [lib/net/request.ts:38](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11694
11725
|
|
|
11695
11726
|
##### method
|
|
11696
11727
|
|
|
11697
|
-
`"GET"`
|
|
11728
|
+
`"GET"` \| `"POST"`
|
|
11698
11729
|
|
|
11699
11730
|
#### Returns
|
|
11700
11731
|
|
|
@@ -11814,7 +11845,7 @@ Defined in: [lib/net/request.ts:61](https://github.com/maiyunnet/kebab/blob/mast
|
|
|
11814
11845
|
|
|
11815
11846
|
##### type
|
|
11816
11847
|
|
|
11817
|
-
`"form"`
|
|
11848
|
+
`"form"` \| `"json"`
|
|
11818
11849
|
|
|
11819
11850
|
#### Returns
|
|
11820
11851
|
|
|
@@ -11860,7 +11891,7 @@ Defined in: [lib/net/response.ts:23](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11860
11891
|
|
|
11861
11892
|
##### req
|
|
11862
11893
|
|
|
11863
|
-
`IResponse`
|
|
11894
|
+
`IResponse` \| `null`
|
|
11864
11895
|
|
|
11865
11896
|
#### Returns
|
|
11866
11897
|
|
|
@@ -11940,59 +11971,250 @@ Defined in: [lib/net/response.ts:46](https://github.com/maiyunnet/kebab/blob/mas
|
|
|
11940
11971
|
|
|
11941
11972
|
##### v
|
|
11942
11973
|
|
|
11974
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
11975
|
+
|
|
11943
11976
|
内容值
|
|
11944
11977
|
|
|
11945
|
-
|
|
11978
|
+
#### Returns
|
|
11979
|
+
|
|
11980
|
+
`void`
|
|
11981
|
+
|
|
11982
|
+
lib/net/response/index.md
|
|
11983
|
+
---
|
|
11984
|
+
|
|
11985
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
11986
|
+
|
|
11987
|
+
***
|
|
11988
|
+
|
|
11989
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / lib/net/response
|
|
11990
|
+
|
|
11991
|
+
# lib/net/response
|
|
11992
|
+
|
|
11993
|
+
## Classes
|
|
11994
|
+
|
|
11995
|
+
- [Response](classes/Response.md)
|
|
11996
|
+
|
|
11997
|
+
lib/net/type-aliases/THttpHeaders.md
|
|
11998
|
+
---
|
|
11999
|
+
|
|
12000
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
12001
|
+
|
|
12002
|
+
***
|
|
12003
|
+
|
|
12004
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/net](../index.md) / THttpHeaders
|
|
12005
|
+
|
|
12006
|
+
# Type Alias: THttpHeaders
|
|
12007
|
+
|
|
12008
|
+
> **THttpHeaders** = `http.IncomingHttpHeaders` & `object`
|
|
12009
|
+
|
|
12010
|
+
Defined in: [lib/net.ts:946](https://github.com/maiyunnet/kebab/blob/master/lib/net.ts#L946)
|
|
12011
|
+
|
|
12012
|
+
http headers
|
|
12013
|
+
|
|
12014
|
+
## Type Declaration
|
|
12015
|
+
|
|
12016
|
+
### http-code?
|
|
12017
|
+
|
|
12018
|
+
> `optional` **http-code?**: `number`
|
|
12019
|
+
|
|
12020
|
+
### http-url?
|
|
12021
|
+
|
|
12022
|
+
> `optional` **http-url?**: `string`
|
|
12023
|
+
|
|
12024
|
+
### http-version?
|
|
12025
|
+
|
|
12026
|
+
> `optional` **http-version?**: `"1.1"` \| `"2.0"`
|
|
12027
|
+
|
|
12028
|
+
lib/ratelimit/functions/check.md
|
|
12029
|
+
---
|
|
12030
|
+
|
|
12031
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
12032
|
+
|
|
12033
|
+
***
|
|
12034
|
+
|
|
12035
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ratelimit](../index.md) / check
|
|
12036
|
+
|
|
12037
|
+
# Function: check()
|
|
12038
|
+
|
|
12039
|
+
> **check**(`kv`, `key`, `opt?`): `Promise`\<[`ICheckResult`](../interfaces/ICheckResult.md)\>
|
|
12040
|
+
|
|
12041
|
+
Defined in: [lib/ratelimit.ts:18](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L18)
|
|
12042
|
+
|
|
12043
|
+
检查指定 key 是否超速,使用多段近似滑动窗口算法
|
|
12044
|
+
|
|
12045
|
+
## Parameters
|
|
12046
|
+
|
|
12047
|
+
### kv
|
|
12048
|
+
|
|
12049
|
+
[`Kv`](../../kv/classes/Kv.md)
|
|
12050
|
+
|
|
12051
|
+
KV 实例
|
|
12052
|
+
|
|
12053
|
+
### key
|
|
12054
|
+
|
|
12055
|
+
`string`
|
|
12056
|
+
|
|
12057
|
+
限速标识(如 IP、用户 UID 等)
|
|
12058
|
+
|
|
12059
|
+
### opt?
|
|
12060
|
+
|
|
12061
|
+
限速选项
|
|
12062
|
+
|
|
12063
|
+
#### max?
|
|
12064
|
+
|
|
12065
|
+
`number`
|
|
12066
|
+
|
|
12067
|
+
窗口内最大请求数,默认 60
|
|
12068
|
+
|
|
12069
|
+
#### pre?
|
|
12070
|
+
|
|
12071
|
+
`string`
|
|
12072
|
+
|
|
12073
|
+
key 前缀,默认 rl:
|
|
12074
|
+
|
|
12075
|
+
#### window?
|
|
12076
|
+
|
|
12077
|
+
`number`
|
|
12078
|
+
|
|
12079
|
+
窗口时间(秒),默认 60
|
|
12080
|
+
|
|
12081
|
+
## Returns
|
|
12082
|
+
|
|
12083
|
+
`Promise`\<[`ICheckResult`](../interfaces/ICheckResult.md)\>
|
|
12084
|
+
|
|
12085
|
+
返回结果对象
|
|
12086
|
+
|
|
12087
|
+
lib/ratelimit/functions/checkFixed.md
|
|
12088
|
+
---
|
|
12089
|
+
|
|
12090
|
+
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
12091
|
+
|
|
12092
|
+
***
|
|
12093
|
+
|
|
12094
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ratelimit](../index.md) / checkFixed
|
|
12095
|
+
|
|
12096
|
+
# Function: checkFixed()
|
|
12097
|
+
|
|
12098
|
+
> **checkFixed**(`kv`, `key`, `opt?`): `Promise`\<[`ICheckResult`](../interfaces/ICheckResult.md)\>
|
|
12099
|
+
|
|
12100
|
+
Defined in: [lib/ratelimit.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L77)
|
|
12101
|
+
|
|
12102
|
+
简易固定窗口限速检查(性能更高,精度较低)
|
|
12103
|
+
|
|
12104
|
+
## Parameters
|
|
12105
|
+
|
|
12106
|
+
### kv
|
|
12107
|
+
|
|
12108
|
+
[`Kv`](../../kv/classes/Kv.md)
|
|
12109
|
+
|
|
12110
|
+
KV 实例
|
|
12111
|
+
|
|
12112
|
+
### key
|
|
12113
|
+
|
|
12114
|
+
`string`
|
|
12115
|
+
|
|
12116
|
+
限速标识
|
|
12117
|
+
|
|
12118
|
+
### opt?
|
|
12119
|
+
|
|
12120
|
+
限速选项
|
|
12121
|
+
|
|
12122
|
+
#### max?
|
|
12123
|
+
|
|
12124
|
+
`number`
|
|
12125
|
+
|
|
12126
|
+
窗口内最大请求数,默认 60
|
|
12127
|
+
|
|
12128
|
+
#### pre?
|
|
12129
|
+
|
|
12130
|
+
`string`
|
|
12131
|
+
|
|
12132
|
+
key 前缀,默认 rl:
|
|
12133
|
+
|
|
12134
|
+
#### window?
|
|
12135
|
+
|
|
12136
|
+
`number`
|
|
12137
|
+
|
|
12138
|
+
窗口时间(秒),默认 60
|
|
12139
|
+
|
|
12140
|
+
## Returns
|
|
12141
|
+
|
|
12142
|
+
`Promise`\<[`ICheckResult`](../interfaces/ICheckResult.md)\>
|
|
12143
|
+
|
|
12144
|
+
lib/ratelimit/index.md
|
|
12145
|
+
---
|
|
12146
|
+
|
|
12147
|
+
[**Documents for @maiyunnet/kebab**](../../index.md)
|
|
12148
|
+
|
|
12149
|
+
***
|
|
12150
|
+
|
|
12151
|
+
[Documents for @maiyunnet/kebab](../../index.md) / lib/ratelimit
|
|
12152
|
+
|
|
12153
|
+
# lib/ratelimit
|
|
12154
|
+
|
|
12155
|
+
## Interfaces
|
|
12156
|
+
|
|
12157
|
+
- [ICheckResult](interfaces/ICheckResult.md)
|
|
11946
12158
|
|
|
11947
|
-
|
|
12159
|
+
## Functions
|
|
11948
12160
|
|
|
11949
|
-
|
|
12161
|
+
- [check](functions/check.md)
|
|
12162
|
+
- [checkFixed](functions/checkFixed.md)
|
|
11950
12163
|
|
|
11951
|
-
lib/
|
|
12164
|
+
lib/ratelimit/interfaces/ICheckResult.md
|
|
11952
12165
|
---
|
|
11953
12166
|
|
|
11954
12167
|
[**Documents for @maiyunnet/kebab**](../../../index.md)
|
|
11955
12168
|
|
|
11956
12169
|
***
|
|
11957
12170
|
|
|
11958
|
-
[Documents for @maiyunnet/kebab](../../../index.md) / lib/
|
|
12171
|
+
[Documents for @maiyunnet/kebab](../../../index.md) / [lib/ratelimit](../index.md) / ICheckResult
|
|
11959
12172
|
|
|
11960
|
-
#
|
|
12173
|
+
# Interface: ICheckResult
|
|
11961
12174
|
|
|
11962
|
-
|
|
12175
|
+
Defined in: [lib/ratelimit.ts:117](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L117)
|
|
11963
12176
|
|
|
11964
|
-
|
|
12177
|
+
限速检查结果
|
|
11965
12178
|
|
|
11966
|
-
|
|
11967
|
-
---
|
|
12179
|
+
## Properties
|
|
11968
12180
|
|
|
11969
|
-
|
|
12181
|
+
### allowed
|
|
12182
|
+
|
|
12183
|
+
> **allowed**: `boolean`
|
|
12184
|
+
|
|
12185
|
+
Defined in: [lib/ratelimit.ts:119](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L119)
|
|
12186
|
+
|
|
12187
|
+
是否允许通过
|
|
11970
12188
|
|
|
11971
12189
|
***
|
|
11972
12190
|
|
|
11973
|
-
|
|
12191
|
+
### limit
|
|
11974
12192
|
|
|
11975
|
-
|
|
12193
|
+
> **limit**: `number`
|
|
11976
12194
|
|
|
11977
|
-
|
|
12195
|
+
Defined in: [lib/ratelimit.ts:123](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L123)
|
|
11978
12196
|
|
|
11979
|
-
|
|
12197
|
+
总限额
|
|
11980
12198
|
|
|
11981
|
-
|
|
12199
|
+
***
|
|
11982
12200
|
|
|
11983
|
-
|
|
12201
|
+
### remaining
|
|
11984
12202
|
|
|
11985
|
-
|
|
12203
|
+
> **remaining**: `number`
|
|
11986
12204
|
|
|
11987
|
-
|
|
12205
|
+
Defined in: [lib/ratelimit.ts:121](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L121)
|
|
11988
12206
|
|
|
11989
|
-
|
|
12207
|
+
剩余可用次数
|
|
12208
|
+
|
|
12209
|
+
***
|
|
11990
12210
|
|
|
11991
|
-
|
|
12211
|
+
### reset
|
|
11992
12212
|
|
|
11993
|
-
|
|
12213
|
+
> **reset**: `number`
|
|
11994
12214
|
|
|
11995
|
-
|
|
12215
|
+
Defined in: [lib/ratelimit.ts:125](https://github.com/maiyunnet/kebab/blob/master/lib/ratelimit.ts#L125)
|
|
12216
|
+
|
|
12217
|
+
窗口重置时间(Unix 时间戳秒)
|
|
11996
12218
|
|
|
11997
12219
|
lib/s3/classes/S3.md
|
|
11998
12220
|
---
|
|
@@ -12176,15 +12398,21 @@ Defined in: [lib/s3.ts:103](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
12176
12398
|
|
|
12177
12399
|
##### content
|
|
12178
12400
|
|
|
12179
|
-
|
|
12401
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\> \| `Readable`
|
|
12180
12402
|
|
|
12181
|
-
|
|
12403
|
+
内容
|
|
12182
12404
|
|
|
12183
12405
|
##### length?
|
|
12184
12406
|
|
|
12407
|
+
`number` \| \{ `bucket?`: `string`; `disposition?`: `string`; `length?`: `number`; `type?`: `string`; \}
|
|
12408
|
+
|
|
12185
12409
|
设置 contentLength,如果是流模式则需要设置此项,也可以设置为对象参数
|
|
12186
12410
|
|
|
12187
|
-
`number`
|
|
12411
|
+
`number`
|
|
12412
|
+
|
|
12413
|
+
***
|
|
12414
|
+
|
|
12415
|
+
###### Type Literal
|
|
12188
12416
|
|
|
12189
12417
|
\{ `bucket?`: `string`; `disposition?`: `string`; `length?`: `number`; `type?`: `string`; \}
|
|
12190
12418
|
|
|
@@ -12366,7 +12594,7 @@ Defined in: [lib/s3.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/s3
|
|
|
12366
12594
|
|
|
12367
12595
|
### account?
|
|
12368
12596
|
|
|
12369
|
-
> `optional` **account
|
|
12597
|
+
> `optional` **account?**: `string`
|
|
12370
12598
|
|
|
12371
12599
|
Defined in: [lib/s3.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L32)
|
|
12372
12600
|
|
|
@@ -12376,7 +12604,7 @@ cf r2 使用
|
|
|
12376
12604
|
|
|
12377
12605
|
### bucket?
|
|
12378
12606
|
|
|
12379
|
-
> `optional` **bucket
|
|
12607
|
+
> `optional` **bucket?**: `string`
|
|
12380
12608
|
|
|
12381
12609
|
Defined in: [lib/s3.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L40)
|
|
12382
12610
|
|
|
@@ -12386,7 +12614,7 @@ Defined in: [lib/s3.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/s3
|
|
|
12386
12614
|
|
|
12387
12615
|
### region?
|
|
12388
12616
|
|
|
12389
|
-
> `optional` **region
|
|
12617
|
+
> `optional` **region?**: `string`
|
|
12390
12618
|
|
|
12391
12619
|
Defined in: [lib/s3.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L38)
|
|
12392
12620
|
|
|
@@ -12396,7 +12624,7 @@ Defined in: [lib/s3.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/s3
|
|
|
12396
12624
|
|
|
12397
12625
|
### secretId?
|
|
12398
12626
|
|
|
12399
|
-
> `optional` **secretId
|
|
12627
|
+
> `optional` **secretId?**: `string`
|
|
12400
12628
|
|
|
12401
12629
|
Defined in: [lib/s3.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L34)
|
|
12402
12630
|
|
|
@@ -12406,7 +12634,7 @@ Defined in: [lib/s3.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/s3
|
|
|
12406
12634
|
|
|
12407
12635
|
### secretKey?
|
|
12408
12636
|
|
|
12409
|
-
> `optional` **secretKey
|
|
12637
|
+
> `optional` **secretKey?**: `string`
|
|
12410
12638
|
|
|
12411
12639
|
Defined in: [lib/s3.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/s3.ts#L36)
|
|
12412
12640
|
|
|
@@ -12447,7 +12675,7 @@ Defined in: [lib/scan.ts:58](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12447
12675
|
|
|
12448
12676
|
##### link
|
|
12449
12677
|
|
|
12450
|
-
[`Pool`](../../db/pool/classes/Pool.md)
|
|
12678
|
+
[`Pool`](../../db/pool/classes/Pool.md) \| [`Kv`](../../kv/classes/Kv.md)
|
|
12451
12679
|
|
|
12452
12680
|
##### token?
|
|
12453
12681
|
|
|
@@ -12574,7 +12802,7 @@ Defined in: [lib/scan.ts:251](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
12574
12802
|
|
|
12575
12803
|
### link
|
|
12576
12804
|
|
|
12577
|
-
[`Pool`](../../db/pool/classes/Pool.md)
|
|
12805
|
+
[`Pool`](../../db/pool/classes/Pool.md) \| [`Kv`](../../kv/classes/Kv.md)
|
|
12578
12806
|
|
|
12579
12807
|
### token?
|
|
12580
12808
|
|
|
@@ -12611,9 +12839,9 @@ Defined in: [lib/scan.ts:265](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
12611
12839
|
|
|
12612
12840
|
### link
|
|
12613
12841
|
|
|
12614
|
-
|
|
12842
|
+
[`Pool`](../../db/pool/classes/Pool.md) \| [`Kv`](../../kv/classes/Kv.md)
|
|
12615
12843
|
|
|
12616
|
-
|
|
12844
|
+
Db 或 Kv
|
|
12617
12845
|
|
|
12618
12846
|
### token
|
|
12619
12847
|
|
|
@@ -12652,7 +12880,7 @@ Defined in: [lib/scan.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
12652
12880
|
|
|
12653
12881
|
### link
|
|
12654
12882
|
|
|
12655
|
-
[`Pool`](../../db/pool/classes/Pool.md)
|
|
12883
|
+
[`Pool`](../../db/pool/classes/Pool.md) \| [`Kv`](../../kv/classes/Kv.md)
|
|
12656
12884
|
|
|
12657
12885
|
### token
|
|
12658
12886
|
|
|
@@ -12660,7 +12888,7 @@ Defined in: [lib/scan.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
12660
12888
|
|
|
12661
12889
|
### data
|
|
12662
12890
|
|
|
12663
|
-
`string`
|
|
12891
|
+
`string` \| `number` \| `Record`\<`string`, `any`\>
|
|
12664
12892
|
|
|
12665
12893
|
### opt?
|
|
12666
12894
|
|
|
@@ -12715,7 +12943,7 @@ Scan 设置的选项
|
|
|
12715
12943
|
|
|
12716
12944
|
### ctr?
|
|
12717
12945
|
|
|
12718
|
-
> `optional` **ctr
|
|
12946
|
+
> `optional` **ctr?**: [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
12719
12947
|
|
|
12720
12948
|
Defined in: [lib/scan.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L32)
|
|
12721
12949
|
|
|
@@ -12723,7 +12951,7 @@ Defined in: [lib/scan.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12723
12951
|
|
|
12724
12952
|
### name?
|
|
12725
12953
|
|
|
12726
|
-
> `optional` **name
|
|
12954
|
+
> `optional` **name?**: `string`
|
|
12727
12955
|
|
|
12728
12956
|
Defined in: [lib/scan.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L34)
|
|
12729
12957
|
|
|
@@ -12731,7 +12959,7 @@ Defined in: [lib/scan.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12731
12959
|
|
|
12732
12960
|
### pre?
|
|
12733
12961
|
|
|
12734
|
-
> `optional` **pre
|
|
12962
|
+
> `optional` **pre?**: `string`
|
|
12735
12963
|
|
|
12736
12964
|
Defined in: [lib/scan.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L33)
|
|
12737
12965
|
|
|
@@ -12739,7 +12967,7 @@ Defined in: [lib/scan.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12739
12967
|
|
|
12740
12968
|
### ttl?
|
|
12741
12969
|
|
|
12742
|
-
> `optional` **ttl
|
|
12970
|
+
> `optional` **ttl?**: `number`
|
|
12743
12971
|
|
|
12744
12972
|
Defined in: [lib/scan.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L31)
|
|
12745
12973
|
|
|
@@ -12762,7 +12990,7 @@ scanned 函数的选项
|
|
|
12762
12990
|
|
|
12763
12991
|
### ctr?
|
|
12764
12992
|
|
|
12765
|
-
> `optional` **ctr
|
|
12993
|
+
> `optional` **ctr?**: [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
12766
12994
|
|
|
12767
12995
|
Defined in: [lib/scan.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L39)
|
|
12768
12996
|
|
|
@@ -12770,7 +12998,7 @@ Defined in: [lib/scan.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12770
12998
|
|
|
12771
12999
|
### name?
|
|
12772
13000
|
|
|
12773
|
-
> `optional` **name
|
|
13001
|
+
> `optional` **name?**: `string`
|
|
12774
13002
|
|
|
12775
13003
|
Defined in: [lib/scan.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L41)
|
|
12776
13004
|
|
|
@@ -12778,7 +13006,7 @@ Defined in: [lib/scan.ts:41](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
12778
13006
|
|
|
12779
13007
|
### pre?
|
|
12780
13008
|
|
|
12781
|
-
> `optional` **pre
|
|
13009
|
+
> `optional` **pre?**: `string`
|
|
12782
13010
|
|
|
12783
13011
|
Defined in: [lib/scan.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/scan.ts#L40)
|
|
12784
13012
|
|
|
@@ -12853,9 +13081,9 @@ Defined in: [lib/session.ts:67](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12853
13081
|
|
|
12854
13082
|
##### link
|
|
12855
13083
|
|
|
12856
|
-
|
|
13084
|
+
[`Pool`](../../db/pool/classes/Pool.md) \| [`Kv`](../../kv/classes/Kv.md)
|
|
12857
13085
|
|
|
12858
|
-
|
|
13086
|
+
Kv 或 Db 实例
|
|
12859
13087
|
|
|
12860
13088
|
##### auth?
|
|
12861
13089
|
|
|
@@ -12925,7 +13153,7 @@ Defined in: [lib/session.ts:30](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12925
13153
|
|
|
12926
13154
|
### domain?
|
|
12927
13155
|
|
|
12928
|
-
> `optional` **domain
|
|
13156
|
+
> `optional` **domain?**: `string`
|
|
12929
13157
|
|
|
12930
13158
|
Defined in: [lib/session.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L34)
|
|
12931
13159
|
|
|
@@ -12933,7 +13161,7 @@ Defined in: [lib/session.ts:34](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12933
13161
|
|
|
12934
13162
|
### name?
|
|
12935
13163
|
|
|
12936
|
-
> `optional` **name
|
|
13164
|
+
> `optional` **name?**: `string`
|
|
12937
13165
|
|
|
12938
13166
|
Defined in: [lib/session.ts:31](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L31)
|
|
12939
13167
|
|
|
@@ -12941,7 +13169,7 @@ Defined in: [lib/session.ts:31](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12941
13169
|
|
|
12942
13170
|
### sqlPre?
|
|
12943
13171
|
|
|
12944
|
-
> `optional` **sqlPre
|
|
13172
|
+
> `optional` **sqlPre?**: `string`
|
|
12945
13173
|
|
|
12946
13174
|
Defined in: [lib/session.ts:35](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L35)
|
|
12947
13175
|
|
|
@@ -12949,7 +13177,7 @@ Defined in: [lib/session.ts:35](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12949
13177
|
|
|
12950
13178
|
### ssl?
|
|
12951
13179
|
|
|
12952
|
-
> `optional` **ssl
|
|
13180
|
+
> `optional` **ssl?**: `boolean`
|
|
12953
13181
|
|
|
12954
13182
|
Defined in: [lib/session.ts:33](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L33)
|
|
12955
13183
|
|
|
@@ -12957,7 +13185,7 @@ Defined in: [lib/session.ts:33](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12957
13185
|
|
|
12958
13186
|
### token?
|
|
12959
13187
|
|
|
12960
|
-
> `optional` **token
|
|
13188
|
+
> `optional` **token?**: `string`
|
|
12961
13189
|
|
|
12962
13190
|
Defined in: [lib/session.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L36)
|
|
12963
13191
|
|
|
@@ -12965,7 +13193,7 @@ Defined in: [lib/session.ts:36](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
12965
13193
|
|
|
12966
13194
|
### ttl?
|
|
12967
13195
|
|
|
12968
|
-
> `optional` **ttl
|
|
13196
|
+
> `optional` **ttl?**: `number`
|
|
12969
13197
|
|
|
12970
13198
|
Defined in: [lib/session.ts:32](https://github.com/maiyunnet/kebab/blob/master/lib/session.ts#L32)
|
|
12971
13199
|
|
|
@@ -13046,7 +13274,7 @@ Defined in: [lib/socket.ts:12](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13046
13274
|
|
|
13047
13275
|
### cookie?
|
|
13048
13276
|
|
|
13049
|
-
> `optional` **cookie
|
|
13277
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../net/interfaces/ICookie.md)\>
|
|
13050
13278
|
|
|
13051
13279
|
Defined in: [lib/socket.ts:19](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L19)
|
|
13052
13280
|
|
|
@@ -13056,7 +13284,7 @@ cookie 托管对象
|
|
|
13056
13284
|
|
|
13057
13285
|
### headers?
|
|
13058
13286
|
|
|
13059
|
-
> `optional` **headers
|
|
13287
|
+
> `optional` **headers?**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
|
|
13060
13288
|
|
|
13061
13289
|
Defined in: [lib/socket.ts:17](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L17)
|
|
13062
13290
|
|
|
@@ -13064,7 +13292,7 @@ Defined in: [lib/socket.ts:17](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13064
13292
|
|
|
13065
13293
|
### hosts?
|
|
13066
13294
|
|
|
13067
|
-
> `optional` **hosts
|
|
13295
|
+
> `optional` **hosts?**: `Record`\<`string`, `string`\>
|
|
13068
13296
|
|
|
13069
13297
|
Defined in: [lib/socket.ts:15](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L15)
|
|
13070
13298
|
|
|
@@ -13072,7 +13300,7 @@ Defined in: [lib/socket.ts:15](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13072
13300
|
|
|
13073
13301
|
### local?
|
|
13074
13302
|
|
|
13075
|
-
> `optional` **local
|
|
13303
|
+
> `optional` **local?**: `string`
|
|
13076
13304
|
|
|
13077
13305
|
Defined in: [lib/socket.ts:16](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L16)
|
|
13078
13306
|
|
|
@@ -13080,7 +13308,7 @@ Defined in: [lib/socket.ts:16](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13080
13308
|
|
|
13081
13309
|
### masking?
|
|
13082
13310
|
|
|
13083
|
-
> `optional` **masking
|
|
13311
|
+
> `optional` **masking?**: `boolean`
|
|
13084
13312
|
|
|
13085
13313
|
Defined in: [lib/socket.ts:23](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L23)
|
|
13086
13314
|
|
|
@@ -13090,7 +13318,7 @@ Defined in: [lib/socket.ts:23](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13090
13318
|
|
|
13091
13319
|
### mode?
|
|
13092
13320
|
|
|
13093
|
-
> `optional` **mode
|
|
13321
|
+
> `optional` **mode?**: [`EFrameReceiveMode`](../../ws/enumerations/EFrameReceiveMode.md)
|
|
13094
13322
|
|
|
13095
13323
|
Defined in: [lib/socket.ts:21](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L21)
|
|
13096
13324
|
|
|
@@ -13100,7 +13328,7 @@ Defined in: [lib/socket.ts:21](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13100
13328
|
|
|
13101
13329
|
### mproxy?
|
|
13102
13330
|
|
|
13103
|
-
> `optional` **mproxy
|
|
13331
|
+
> `optional` **mproxy?**: `object`
|
|
13104
13332
|
|
|
13105
13333
|
Defined in: [lib/socket.ts:25](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L25)
|
|
13106
13334
|
|
|
@@ -13118,7 +13346,7 @@ Defined in: [lib/socket.ts:25](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
13118
13346
|
|
|
13119
13347
|
### timeout?
|
|
13120
13348
|
|
|
13121
|
-
> `optional` **timeout
|
|
13349
|
+
> `optional` **timeout?**: `number`
|
|
13122
13350
|
|
|
13123
13351
|
Defined in: [lib/socket.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/socket.ts#L14)
|
|
13124
13352
|
|
|
@@ -13211,15 +13439,15 @@ ORDER BY
|
|
|
13211
13439
|
|
|
13212
13440
|
##### c
|
|
13213
13441
|
|
|
13214
|
-
|
|
13442
|
+
`string` \| (`string` \| `string`[])[]
|
|
13215
13443
|
|
|
13216
|
-
|
|
13444
|
+
字段字符串或数组
|
|
13217
13445
|
|
|
13218
13446
|
##### d?
|
|
13219
13447
|
|
|
13220
|
-
|
|
13448
|
+
`"DESC"` \| `"ASC"`
|
|
13221
13449
|
|
|
13222
|
-
|
|
13450
|
+
排序规则
|
|
13223
13451
|
|
|
13224
13452
|
#### Returns
|
|
13225
13453
|
|
|
@@ -13239,9 +13467,9 @@ Defined in: [lib/sql.ts:740](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13239
13467
|
|
|
13240
13468
|
##### f?
|
|
13241
13469
|
|
|
13242
|
-
|
|
13470
|
+
`string` \| `string`[]
|
|
13243
13471
|
|
|
13244
|
-
|
|
13472
|
+
可为空,可设置新对象的 table 名变化
|
|
13245
13473
|
|
|
13246
13474
|
##### opt?
|
|
13247
13475
|
|
|
@@ -13329,7 +13557,7 @@ Defined in: [lib/sql.ts:927](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13329
13557
|
|
|
13330
13558
|
##### str
|
|
13331
13559
|
|
|
13332
|
-
`string`
|
|
13560
|
+
`string` \| `number` \| \[`string`, `string`[]\]
|
|
13333
13561
|
|
|
13334
13562
|
##### pre?
|
|
13335
13563
|
|
|
@@ -13467,9 +13695,9 @@ GROUP BY
|
|
|
13467
13695
|
|
|
13468
13696
|
##### c
|
|
13469
13697
|
|
|
13470
|
-
|
|
13698
|
+
`string` \| `string`[]
|
|
13471
13699
|
|
|
13472
|
-
|
|
13700
|
+
字段字符串或数组
|
|
13473
13701
|
|
|
13474
13702
|
#### Returns
|
|
13475
13703
|
|
|
@@ -13745,15 +13973,15 @@ Defined in: [lib/sql.ts:206](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13745
13973
|
|
|
13746
13974
|
##### c
|
|
13747
13975
|
|
|
13748
|
-
|
|
13976
|
+
`string` \| (`string` \| `any`[])[]
|
|
13749
13977
|
|
|
13750
|
-
|
|
13978
|
+
字段字符串或字段数组
|
|
13751
13979
|
|
|
13752
13980
|
##### f
|
|
13753
13981
|
|
|
13754
|
-
|
|
13982
|
+
`string` \| `string`[]
|
|
13755
13983
|
|
|
13756
|
-
|
|
13984
|
+
表,允许多张表
|
|
13757
13985
|
|
|
13758
13986
|
#### Returns
|
|
13759
13987
|
|
|
@@ -13857,9 +14085,9 @@ Defined in: [lib/sql.ts:172](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13857
14085
|
|
|
13858
14086
|
##### conflict?
|
|
13859
14087
|
|
|
13860
|
-
|
|
14088
|
+
`string` \| `string`[]
|
|
13861
14089
|
|
|
13862
|
-
|
|
14090
|
+
冲突字段,PostgreSQL 用于指定 ON CONFLICT 字段;MySQL 时忽略,因为会对所有唯一键冲突执行更新
|
|
13863
14091
|
|
|
13864
14092
|
#### Returns
|
|
13865
14093
|
|
|
@@ -13879,15 +14107,15 @@ Defined in: [lib/sql.ts:114](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
13879
14107
|
|
|
13880
14108
|
##### cs
|
|
13881
14109
|
|
|
13882
|
-
[]
|
|
14110
|
+
`string`[] \| `Record`\<`string`, [`DbValue`](../../../index/type-aliases/DbValue.md)\>
|
|
13883
14111
|
|
|
13884
|
-
|
|
14112
|
+
[] 数据列或字段列
|
|
13885
14113
|
|
|
13886
14114
|
##### vs?
|
|
13887
14115
|
|
|
13888
|
-
[]
|
|
14116
|
+
[`DbValue`](../../../index/type-aliases/DbValue.md)[] \| [`DbValue`](../../../index/type-aliases/DbValue.md)[][]
|
|
13889
14117
|
|
|
13890
|
-
[
|
|
14118
|
+
[] | [][] 数据
|
|
13891
14119
|
|
|
13892
14120
|
#### Returns
|
|
13893
14121
|
|
|
@@ -14442,7 +14670,7 @@ Defined in: [lib/ssh.ts:13](https://github.com/maiyunnet/kebab/blob/master/lib/s
|
|
|
14442
14670
|
|
|
14443
14671
|
### mproxy?
|
|
14444
14672
|
|
|
14445
|
-
> `optional` **mproxy
|
|
14673
|
+
> `optional` **mproxy?**: `object`
|
|
14446
14674
|
|
|
14447
14675
|
Defined in: [lib/ssh.ts:14](https://github.com/maiyunnet/kebab/blob/master/lib/ssh.ts#L14)
|
|
14448
14676
|
|
|
@@ -14540,9 +14768,9 @@ Defined in: [lib/ssh/sftp.ts:333](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14540
14768
|
|
|
14541
14769
|
##### mode
|
|
14542
14770
|
|
|
14543
|
-
|
|
14771
|
+
`string` \| `number`
|
|
14544
14772
|
|
|
14545
|
-
|
|
14773
|
+
权限
|
|
14546
14774
|
|
|
14547
14775
|
#### Returns
|
|
14548
14776
|
|
|
@@ -14608,9 +14836,9 @@ Defined in: [lib/ssh/sftp.ts:418](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14608
14836
|
|
|
14609
14837
|
##### options?
|
|
14610
14838
|
|
|
14611
|
-
|
|
14839
|
+
`BufferEncoding` \| `WriteStreamOptions`
|
|
14612
14840
|
|
|
14613
|
-
|
|
14841
|
+
编码或配置
|
|
14614
14842
|
|
|
14615
14843
|
#### Returns
|
|
14616
14844
|
|
|
@@ -14704,7 +14932,7 @@ Defined in: [lib/ssh/sftp.ts:29](https://github.com/maiyunnet/kebab/blob/master/
|
|
|
14704
14932
|
|
|
14705
14933
|
###### options
|
|
14706
14934
|
|
|
14707
|
-
`BufferEncoding`
|
|
14935
|
+
`BufferEncoding` \| \{ `encoding`: `BufferEncoding`; `end?`: `number`; `start?`: `number`; \}
|
|
14708
14936
|
|
|
14709
14937
|
##### Returns
|
|
14710
14938
|
|
|
@@ -14844,9 +15072,9 @@ Defined in: [lib/ssh/sftp.ts:109](https://github.com/maiyunnet/kebab/blob/master
|
|
|
14844
15072
|
|
|
14845
15073
|
##### data
|
|
14846
15074
|
|
|
14847
|
-
|
|
15075
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
14848
15076
|
|
|
14849
|
-
|
|
15077
|
+
要写入的内容
|
|
14850
15078
|
|
|
14851
15079
|
##### options?
|
|
14852
15080
|
|
|
@@ -15154,9 +15382,9 @@ Defined in: [lib/ssh/shell.ts:77](https://github.com/maiyunnet/kebab/blob/master
|
|
|
15154
15382
|
|
|
15155
15383
|
##### cmd?
|
|
15156
15384
|
|
|
15157
|
-
|
|
15385
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
15158
15386
|
|
|
15159
|
-
|
|
15387
|
+
命令
|
|
15160
15388
|
|
|
15161
15389
|
##### encoding?
|
|
15162
15390
|
|
|
@@ -15218,9 +15446,9 @@ Defined in: [lib/ssh/shell.ts:23](https://github.com/maiyunnet/kebab/blob/master
|
|
|
15218
15446
|
|
|
15219
15447
|
##### cmd
|
|
15220
15448
|
|
|
15221
|
-
|
|
15449
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
15222
15450
|
|
|
15223
|
-
|
|
15451
|
+
指令
|
|
15224
15452
|
|
|
15225
15453
|
##### encoding?
|
|
15226
15454
|
|
|
@@ -16193,9 +16421,9 @@ Defined in: [lib/text.ts:589](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16193
16421
|
|
|
16194
16422
|
### space?
|
|
16195
16423
|
|
|
16196
|
-
|
|
16424
|
+
`string` \| `number`
|
|
16197
16425
|
|
|
16198
|
-
|
|
16426
|
+
美化方式
|
|
16199
16427
|
|
|
16200
16428
|
## Returns
|
|
16201
16429
|
|
|
@@ -16672,9 +16900,9 @@ Defined in: [lib/time.ts:167](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16672
16900
|
|
|
16673
16901
|
### zone
|
|
16674
16902
|
|
|
16675
|
-
|
|
16903
|
+
`number` \| [`Ctr`](../../../sys/ctr/classes/Ctr.md) \| `null`
|
|
16676
16904
|
|
|
16677
|
-
|
|
16905
|
+
时区小时或 ctr 对象,如 8,设置 null 则以系统时区为准
|
|
16678
16906
|
|
|
16679
16907
|
### f
|
|
16680
16908
|
|
|
@@ -16684,9 +16912,9 @@ Defined in: [lib/time.ts:167](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16684
16912
|
|
|
16685
16913
|
### date?
|
|
16686
16914
|
|
|
16687
|
-
|
|
16915
|
+
`number` \| `Date`
|
|
16688
16916
|
|
|
16689
|
-
|
|
16917
|
+
时间对象秒/毫秒级数字均可
|
|
16690
16918
|
|
|
16691
16919
|
## Returns
|
|
16692
16920
|
|
|
@@ -16773,15 +17001,15 @@ Defined in: [lib/time.ts:122](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
16773
17001
|
|
|
16774
17002
|
### date?
|
|
16775
17003
|
|
|
16776
|
-
Date
|
|
17004
|
+
`string` \| `Date`
|
|
16777
17005
|
|
|
16778
|
-
|
|
17006
|
+
Date 对象可选
|
|
16779
17007
|
|
|
16780
17008
|
### zone?
|
|
16781
17009
|
|
|
16782
|
-
|
|
17010
|
+
`number` \| [`Ctr`](../../../sys/ctr/classes/Ctr.md) \| `null`
|
|
16783
17011
|
|
|
16784
|
-
|
|
17012
|
+
时区小时或 ctr 对象,如 8,设置 null 则以系统时区为准
|
|
16785
17013
|
|
|
16786
17014
|
## Returns
|
|
16787
17015
|
|
|
@@ -16836,7 +17064,7 @@ Defined in: [lib/time.ts:8](https://github.com/maiyunnet/kebab/blob/master/lib/t
|
|
|
16836
17064
|
|
|
16837
17065
|
### data?
|
|
16838
17066
|
|
|
16839
|
-
> `optional` **data
|
|
17067
|
+
> `optional` **data?**: `string` \| `number`
|
|
16840
17068
|
|
|
16841
17069
|
Defined in: [lib/time.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L12)
|
|
16842
17070
|
|
|
@@ -16846,7 +17074,7 @@ Defined in: [lib/time.ts:12](https://github.com/maiyunnet/kebab/blob/master/lib/
|
|
|
16846
17074
|
|
|
16847
17075
|
### zone?
|
|
16848
17076
|
|
|
16849
|
-
> `optional` **zone
|
|
17077
|
+
> `optional` **zone?**: `number`
|
|
16850
17078
|
|
|
16851
17079
|
Defined in: [lib/time.ts:10](https://github.com/maiyunnet/kebab/blob/master/lib/time.ts#L10)
|
|
16852
17080
|
|
|
@@ -17158,9 +17386,9 @@ Defined in: [lib/vector.ts:165](https://github.com/maiyunnet/kebab/blob/master/l
|
|
|
17158
17386
|
|
|
17159
17387
|
### ctrEtc
|
|
17160
17388
|
|
|
17161
|
-
|
|
17389
|
+
[`IConfigVector`](../../../index/interfaces/IConfigVector.md) \| [`Ctr`](../../../sys/ctr/classes/Ctr.md)
|
|
17162
17390
|
|
|
17163
|
-
|
|
17391
|
+
控制器或配置信息
|
|
17164
17392
|
|
|
17165
17393
|
## Returns
|
|
17166
17394
|
|
|
@@ -17208,7 +17436,7 @@ Defined in: [lib/vector.ts:18](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
17208
17436
|
|
|
17209
17437
|
### host?
|
|
17210
17438
|
|
|
17211
|
-
> `optional` **host
|
|
17439
|
+
> `optional` **host?**: `string`
|
|
17212
17440
|
|
|
17213
17441
|
Defined in: [lib/vector.ts:20](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L20)
|
|
17214
17442
|
|
|
@@ -17218,7 +17446,7 @@ Defined in: [lib/vector.ts:20](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
17218
17446
|
|
|
17219
17447
|
### name?
|
|
17220
17448
|
|
|
17221
|
-
> `optional` **name
|
|
17449
|
+
> `optional` **name?**: `string`
|
|
17222
17450
|
|
|
17223
17451
|
Defined in: [lib/vector.ts:24](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L24)
|
|
17224
17452
|
|
|
@@ -17228,7 +17456,7 @@ Defined in: [lib/vector.ts:24](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
17228
17456
|
|
|
17229
17457
|
### port?
|
|
17230
17458
|
|
|
17231
|
-
> `optional` **port
|
|
17459
|
+
> `optional` **port?**: `number`
|
|
17232
17460
|
|
|
17233
17461
|
Defined in: [lib/vector.ts:22](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L22)
|
|
17234
17462
|
|
|
@@ -17238,7 +17466,7 @@ Defined in: [lib/vector.ts:22](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
17238
17466
|
|
|
17239
17467
|
### pwd?
|
|
17240
17468
|
|
|
17241
|
-
> `optional` **pwd
|
|
17469
|
+
> `optional` **pwd?**: `string`
|
|
17242
17470
|
|
|
17243
17471
|
Defined in: [lib/vector.ts:28](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L28)
|
|
17244
17472
|
|
|
@@ -17248,7 +17476,7 @@ Defined in: [lib/vector.ts:28](https://github.com/maiyunnet/kebab/blob/master/li
|
|
|
17248
17476
|
|
|
17249
17477
|
### user?
|
|
17250
17478
|
|
|
17251
|
-
> `optional` **user
|
|
17479
|
+
> `optional` **user?**: `string`
|
|
17252
17480
|
|
|
17253
17481
|
Defined in: [lib/vector.ts:26](https://github.com/maiyunnet/kebab/blob/master/lib/vector.ts#L26)
|
|
17254
17482
|
|
|
@@ -17433,7 +17661,7 @@ Defined in: [lib/ws.ts:323](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17433
17661
|
|
|
17434
17662
|
##### event
|
|
17435
17663
|
|
|
17436
|
-
`"error"`
|
|
17664
|
+
`"error"` \| `"message"` \| `"end"` \| `"close"` \| `"timeout"` \| `"drain"`
|
|
17437
17665
|
|
|
17438
17666
|
#### Returns
|
|
17439
17667
|
|
|
@@ -17499,7 +17727,7 @@ Defined in: [lib/ws.ts:287](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17499
17727
|
|
|
17500
17728
|
###### event
|
|
17501
17729
|
|
|
17502
|
-
`"end"`
|
|
17730
|
+
`"end"` \| `"close"` \| `"timeout"` \| `"drain"`
|
|
17503
17731
|
|
|
17504
17732
|
###### cb
|
|
17505
17733
|
|
|
@@ -17523,7 +17751,7 @@ Defined in: [lib/ws.ts:383](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17523
17751
|
|
|
17524
17752
|
##### data?
|
|
17525
17753
|
|
|
17526
|
-
`string`
|
|
17754
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
17527
17755
|
|
|
17528
17756
|
#### Returns
|
|
17529
17757
|
|
|
@@ -17543,7 +17771,7 @@ Defined in: [lib/ws.ts:394](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17543
17771
|
|
|
17544
17772
|
##### data?
|
|
17545
17773
|
|
|
17546
|
-
`string`
|
|
17774
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
17547
17775
|
|
|
17548
17776
|
#### Returns
|
|
17549
17777
|
|
|
@@ -17563,7 +17791,7 @@ Defined in: [lib/ws.ts:353](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17563
17791
|
|
|
17564
17792
|
##### data
|
|
17565
17793
|
|
|
17566
|
-
`string`
|
|
17794
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\> \| (`string` \| `Buffer`\<`ArrayBufferLike`\>)[]
|
|
17567
17795
|
|
|
17568
17796
|
#### Returns
|
|
17569
17797
|
|
|
@@ -17603,7 +17831,7 @@ Defined in: [lib/ws.ts:337](https://github.com/maiyunnet/kebab/blob/master/lib/w
|
|
|
17603
17831
|
|
|
17604
17832
|
##### data
|
|
17605
17833
|
|
|
17606
|
-
`string`
|
|
17834
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\> \| (`string` \| `Buffer`\<`ArrayBufferLike`\>)[]
|
|
17607
17835
|
|
|
17608
17836
|
#### Returns
|
|
17609
17837
|
|
|
@@ -17972,7 +18200,7 @@ Defined in: [lib/ws.ts:34](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17972
18200
|
|
|
17973
18201
|
### cookie?
|
|
17974
18202
|
|
|
17975
|
-
> `optional` **cookie
|
|
18203
|
+
> `optional` **cookie?**: `Record`\<`string`, [`ICookie`](../../net/interfaces/ICookie.md)\>
|
|
17976
18204
|
|
|
17977
18205
|
Defined in: [lib/ws.ts:42](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L42)
|
|
17978
18206
|
|
|
@@ -17982,7 +18210,7 @@ cookie 托管对象
|
|
|
17982
18210
|
|
|
17983
18211
|
### headers?
|
|
17984
18212
|
|
|
17985
|
-
> `optional` **headers
|
|
18213
|
+
> `optional` **headers?**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
|
|
17986
18214
|
|
|
17987
18215
|
Defined in: [lib/ws.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L40)
|
|
17988
18216
|
|
|
@@ -17990,7 +18218,7 @@ Defined in: [lib/ws.ts:40](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
17990
18218
|
|
|
17991
18219
|
### hosts?
|
|
17992
18220
|
|
|
17993
|
-
> `optional` **hosts
|
|
18221
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
17994
18222
|
|
|
17995
18223
|
Defined in: [lib/ws.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L38)
|
|
17996
18224
|
|
|
@@ -18000,7 +18228,7 @@ Defined in: [lib/ws.ts:38](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18000
18228
|
|
|
18001
18229
|
### local?
|
|
18002
18230
|
|
|
18003
|
-
> `optional` **local
|
|
18231
|
+
> `optional` **local?**: `string`
|
|
18004
18232
|
|
|
18005
18233
|
Defined in: [lib/ws.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L39)
|
|
18006
18234
|
|
|
@@ -18008,7 +18236,7 @@ Defined in: [lib/ws.ts:39](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18008
18236
|
|
|
18009
18237
|
### masking?
|
|
18010
18238
|
|
|
18011
|
-
> `optional` **masking
|
|
18239
|
+
> `optional` **masking?**: `boolean`
|
|
18012
18240
|
|
|
18013
18241
|
Defined in: [lib/ws.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L46)
|
|
18014
18242
|
|
|
@@ -18018,7 +18246,7 @@ Defined in: [lib/ws.ts:46](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18018
18246
|
|
|
18019
18247
|
### mode?
|
|
18020
18248
|
|
|
18021
|
-
> `optional` **mode
|
|
18249
|
+
> `optional` **mode?**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
|
|
18022
18250
|
|
|
18023
18251
|
Defined in: [lib/ws.ts:44](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L44)
|
|
18024
18252
|
|
|
@@ -18028,7 +18256,7 @@ Defined in: [lib/ws.ts:44](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18028
18256
|
|
|
18029
18257
|
### mproxy?
|
|
18030
18258
|
|
|
18031
|
-
> `optional` **mproxy
|
|
18259
|
+
> `optional` **mproxy?**: `object`
|
|
18032
18260
|
|
|
18033
18261
|
Defined in: [lib/ws.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L48)
|
|
18034
18262
|
|
|
@@ -18046,7 +18274,7 @@ Defined in: [lib/ws.ts:48](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18046
18274
|
|
|
18047
18275
|
### timeout?
|
|
18048
18276
|
|
|
18049
|
-
> `optional` **timeout
|
|
18277
|
+
> `optional` **timeout?**: `number`
|
|
18050
18278
|
|
|
18051
18279
|
Defined in: [lib/ws.ts:36](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L36)
|
|
18052
18280
|
|
|
@@ -18069,9 +18297,9 @@ Defined in: [lib/ws.ts:55](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18069
18297
|
|
|
18070
18298
|
## Properties
|
|
18071
18299
|
|
|
18072
|
-
### filter
|
|
18300
|
+
### filter?
|
|
18073
18301
|
|
|
18074
|
-
> `optional` **filter
|
|
18302
|
+
> `optional` **filter?**: (`h`) => `boolean`
|
|
18075
18303
|
|
|
18076
18304
|
Defined in: [lib/ws.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L63)
|
|
18077
18305
|
|
|
@@ -18091,7 +18319,7 @@ Defined in: [lib/ws.ts:63](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18091
18319
|
|
|
18092
18320
|
### headers?
|
|
18093
18321
|
|
|
18094
|
-
> `optional` **headers
|
|
18322
|
+
> `optional` **headers?**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
|
|
18095
18323
|
|
|
18096
18324
|
Defined in: [lib/ws.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L61)
|
|
18097
18325
|
|
|
@@ -18099,7 +18327,7 @@ Defined in: [lib/ws.ts:61](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18099
18327
|
|
|
18100
18328
|
### hosts?
|
|
18101
18329
|
|
|
18102
|
-
> `optional` **hosts
|
|
18330
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18103
18331
|
|
|
18104
18332
|
Defined in: [lib/ws.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L59)
|
|
18105
18333
|
|
|
@@ -18109,7 +18337,7 @@ Defined in: [lib/ws.ts:59](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18109
18337
|
|
|
18110
18338
|
### local?
|
|
18111
18339
|
|
|
18112
|
-
> `optional` **local
|
|
18340
|
+
> `optional` **local?**: `string`
|
|
18113
18341
|
|
|
18114
18342
|
Defined in: [lib/ws.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L60)
|
|
18115
18343
|
|
|
@@ -18117,7 +18345,7 @@ Defined in: [lib/ws.ts:60](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18117
18345
|
|
|
18118
18346
|
### masking?
|
|
18119
18347
|
|
|
18120
|
-
> `optional` **masking
|
|
18348
|
+
> `optional` **masking?**: `boolean`
|
|
18121
18349
|
|
|
18122
18350
|
Defined in: [lib/ws.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L67)
|
|
18123
18351
|
|
|
@@ -18127,7 +18355,7 @@ Defined in: [lib/ws.ts:67](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18127
18355
|
|
|
18128
18356
|
### mode?
|
|
18129
18357
|
|
|
18130
|
-
> `optional` **mode
|
|
18358
|
+
> `optional` **mode?**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
|
|
18131
18359
|
|
|
18132
18360
|
Defined in: [lib/ws.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L65)
|
|
18133
18361
|
|
|
@@ -18137,7 +18365,7 @@ Defined in: [lib/ws.ts:65](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18137
18365
|
|
|
18138
18366
|
### timeout?
|
|
18139
18367
|
|
|
18140
|
-
> `optional` **timeout
|
|
18368
|
+
> `optional` **timeout?**: `number`
|
|
18141
18369
|
|
|
18142
18370
|
Defined in: [lib/ws.ts:57](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L57)
|
|
18143
18371
|
|
|
@@ -18160,9 +18388,9 @@ Defined in: [lib/ws.ts:71](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18160
18388
|
|
|
18161
18389
|
## Properties
|
|
18162
18390
|
|
|
18163
|
-
### filter
|
|
18391
|
+
### filter?
|
|
18164
18392
|
|
|
18165
|
-
> `optional` **filter
|
|
18393
|
+
> `optional` **filter?**: (`h`) => `boolean`
|
|
18166
18394
|
|
|
18167
18395
|
Defined in: [lib/ws.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L79)
|
|
18168
18396
|
|
|
@@ -18182,7 +18410,7 @@ Defined in: [lib/ws.ts:79](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18182
18410
|
|
|
18183
18411
|
### headers?
|
|
18184
18412
|
|
|
18185
|
-
> `optional` **headers
|
|
18413
|
+
> `optional` **headers?**: [`THttpHeaders`](../../net/type-aliases/THttpHeaders.md)
|
|
18186
18414
|
|
|
18187
18415
|
Defined in: [lib/ws.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L77)
|
|
18188
18416
|
|
|
@@ -18190,7 +18418,7 @@ Defined in: [lib/ws.ts:77](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18190
18418
|
|
|
18191
18419
|
### hosts?
|
|
18192
18420
|
|
|
18193
|
-
> `optional` **hosts
|
|
18421
|
+
> `optional` **hosts?**: `string` \| `Record`\<`string`, `string`\>
|
|
18194
18422
|
|
|
18195
18423
|
Defined in: [lib/ws.ts:75](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L75)
|
|
18196
18424
|
|
|
@@ -18200,7 +18428,7 @@ Defined in: [lib/ws.ts:75](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18200
18428
|
|
|
18201
18429
|
### local?
|
|
18202
18430
|
|
|
18203
|
-
> `optional` **local
|
|
18431
|
+
> `optional` **local?**: `string`
|
|
18204
18432
|
|
|
18205
18433
|
Defined in: [lib/ws.ts:76](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L76)
|
|
18206
18434
|
|
|
@@ -18208,7 +18436,7 @@ Defined in: [lib/ws.ts:76](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18208
18436
|
|
|
18209
18437
|
### masking?
|
|
18210
18438
|
|
|
18211
|
-
> `optional` **masking
|
|
18439
|
+
> `optional` **masking?**: `boolean`
|
|
18212
18440
|
|
|
18213
18441
|
Defined in: [lib/ws.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L83)
|
|
18214
18442
|
|
|
@@ -18218,7 +18446,7 @@ Defined in: [lib/ws.ts:83](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18218
18446
|
|
|
18219
18447
|
### mode?
|
|
18220
18448
|
|
|
18221
|
-
> `optional` **mode
|
|
18449
|
+
> `optional` **mode?**: [`EFrameReceiveMode`](../enumerations/EFrameReceiveMode.md)
|
|
18222
18450
|
|
|
18223
18451
|
Defined in: [lib/ws.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L81)
|
|
18224
18452
|
|
|
@@ -18228,7 +18456,7 @@ Defined in: [lib/ws.ts:81](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18228
18456
|
|
|
18229
18457
|
### mproxy?
|
|
18230
18458
|
|
|
18231
|
-
> `optional` **mproxy
|
|
18459
|
+
> `optional` **mproxy?**: `object`
|
|
18232
18460
|
|
|
18233
18461
|
Defined in: [lib/ws.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L85)
|
|
18234
18462
|
|
|
@@ -18246,7 +18474,7 @@ Defined in: [lib/ws.ts:85](https://github.com/maiyunnet/kebab/blob/master/lib/ws
|
|
|
18246
18474
|
|
|
18247
18475
|
### timeout?
|
|
18248
18476
|
|
|
18249
|
-
> `optional` **timeout
|
|
18477
|
+
> `optional` **timeout?**: `number`
|
|
18250
18478
|
|
|
18251
18479
|
Defined in: [lib/ws.ts:73](https://github.com/maiyunnet/kebab/blob/master/lib/ws.ts#L73)
|
|
18252
18480
|
|
|
@@ -19167,9 +19395,9 @@ Defined in: [lib/zlib.ts:249](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
19167
19395
|
|
|
19168
19396
|
### buffer
|
|
19169
19397
|
|
|
19170
|
-
|
|
19398
|
+
`InputType` \| `null`
|
|
19171
19399
|
|
|
19172
|
-
|
|
19400
|
+
段
|
|
19173
19401
|
|
|
19174
19402
|
### options?
|
|
19175
19403
|
|
|
@@ -19422,9 +19650,9 @@ Defined in: [lib/zlib.ts:290](https://github.com/maiyunnet/kebab/blob/master/lib
|
|
|
19422
19650
|
|
|
19423
19651
|
### buffer
|
|
19424
19652
|
|
|
19425
|
-
|
|
19653
|
+
`InputType` \| `null`
|
|
19426
19654
|
|
|
19427
|
-
|
|
19655
|
+
段
|
|
19428
19656
|
|
|
19429
19657
|
## Returns
|
|
19430
19658
|
|
|
@@ -19695,11 +19923,11 @@ Defined in: [sys/ctr.ts:106](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
19695
19923
|
|
|
19696
19924
|
##### req
|
|
19697
19925
|
|
|
19698
|
-
`IncomingMessage`
|
|
19926
|
+
`IncomingMessage` \| `Http2ServerRequest`
|
|
19699
19927
|
|
|
19700
19928
|
##### res?
|
|
19701
19929
|
|
|
19702
|
-
`Http2ServerResponse`\<`Http2ServerRequest`\>
|
|
19930
|
+
`Http2ServerResponse`\<`Http2ServerRequest`\> \| `ServerResponse`\<`IncomingMessage`\>
|
|
19703
19931
|
|
|
19704
19932
|
#### Returns
|
|
19705
19933
|
|
|
@@ -19903,13 +20131,13 @@ Defined in: [sys/ctr.ts:98](https://github.com/maiyunnet/kebab/blob/master/sys/c
|
|
|
19903
20131
|
|
|
19904
20132
|
### \_timer?
|
|
19905
20133
|
|
|
19906
|
-
> `protected` `optional` **\_timer
|
|
20134
|
+
> `protected` `optional` **\_timer?**: `object`
|
|
19907
20135
|
|
|
19908
20136
|
Defined in: [sys/ctr.ts:125](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L125)
|
|
19909
20137
|
|
|
19910
20138
|
timeout 的 timer
|
|
19911
20139
|
|
|
19912
|
-
#### callback
|
|
20140
|
+
#### callback
|
|
19913
20141
|
|
|
19914
20142
|
> **callback**: () => `void`
|
|
19915
20143
|
|
|
@@ -20013,7 +20241,7 @@ Defined in: [sys/ctr.ts:173](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20013
20241
|
|
|
20014
20242
|
> `protected` **\_checkInput**(`input`, `rule`, `rtn`): `boolean`
|
|
20015
20243
|
|
|
20016
|
-
Defined in: [sys/ctr.ts:
|
|
20244
|
+
Defined in: [sys/ctr.ts:512](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L512)
|
|
20017
20245
|
|
|
20018
20246
|
检测提交的数据类型
|
|
20019
20247
|
|
|
@@ -20047,7 +20275,7 @@ Defined in: [sys/ctr.ts:370](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20047
20275
|
|
|
20048
20276
|
> `protected` **\_checkXInput**(`input`, `rule`, `rtn`): `boolean`
|
|
20049
20277
|
|
|
20050
|
-
Defined in: [sys/ctr.ts:
|
|
20278
|
+
Defined in: [sys/ctr.ts:690](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L690)
|
|
20051
20279
|
|
|
20052
20280
|
检测提交的数据类型(会检测 XSRF)
|
|
20053
20281
|
|
|
@@ -20079,12 +20307,42 @@ Defined in: [sys/ctr.ts:548](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20079
20307
|
|
|
20080
20308
|
### \_cross()
|
|
20081
20309
|
|
|
20082
|
-
> `protected` **\_cross**(): `boolean`
|
|
20310
|
+
> `protected` **\_cross**(`opt?`): `boolean`
|
|
20083
20311
|
|
|
20084
|
-
Defined in: [sys/ctr.ts:
|
|
20312
|
+
Defined in: [sys/ctr.ts:904](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L904)
|
|
20085
20313
|
|
|
20086
20314
|
开启跨域请求
|
|
20087
|
-
|
|
20315
|
+
|
|
20316
|
+
#### Parameters
|
|
20317
|
+
|
|
20318
|
+
##### opt?
|
|
20319
|
+
|
|
20320
|
+
可选 CORS 配置
|
|
20321
|
+
返回 true 接续执行,返回 false 需要中断用户本次访问(options 请求)
|
|
20322
|
+
|
|
20323
|
+
###### credentials?
|
|
20324
|
+
|
|
20325
|
+
`boolean`
|
|
20326
|
+
|
|
20327
|
+
是否允许发送凭据(cookie),默认 false
|
|
20328
|
+
|
|
20329
|
+
###### headers?
|
|
20330
|
+
|
|
20331
|
+
`string`
|
|
20332
|
+
|
|
20333
|
+
允许的请求头
|
|
20334
|
+
|
|
20335
|
+
###### methods?
|
|
20336
|
+
|
|
20337
|
+
`string`
|
|
20338
|
+
|
|
20339
|
+
允许的方法
|
|
20340
|
+
|
|
20341
|
+
###### origins?
|
|
20342
|
+
|
|
20343
|
+
`string`[]
|
|
20344
|
+
|
|
20345
|
+
允许的来源列表,留空为 '*'
|
|
20088
20346
|
|
|
20089
20347
|
#### Returns
|
|
20090
20348
|
|
|
@@ -20096,7 +20354,7 @@ Defined in: [sys/ctr.ts:765](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20096
20354
|
|
|
20097
20355
|
> `protected` **\_device**(): `"unknown"` \| `"android"` \| `"linux"` \| `"windows"` \| `"macintosh"` \| `"ipad"`
|
|
20098
20356
|
|
|
20099
|
-
Defined in: [sys/ctr.ts:
|
|
20357
|
+
Defined in: [sys/ctr.ts:732](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L732)
|
|
20100
20358
|
|
|
20101
20359
|
根据用户 ua 获取当前用户的设备类型
|
|
20102
20360
|
|
|
@@ -20110,7 +20368,7 @@ Defined in: [sys/ctr.ts:590](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20110
20368
|
|
|
20111
20369
|
> `protected` **\_enabledXsrf**(`opt?`): `void`
|
|
20112
20370
|
|
|
20113
|
-
Defined in: [sys/ctr.ts:
|
|
20371
|
+
Defined in: [sys/ctr.ts:701](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L701)
|
|
20114
20372
|
|
|
20115
20373
|
当前页面开启 XSRF 支持(主要检测 cookie 是否存在)
|
|
20116
20374
|
如果当前页面有 CDN,请不要使用
|
|
@@ -20133,7 +20391,7 @@ Defined in: [sys/ctr.ts:559](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20133
20391
|
|
|
20134
20392
|
> `protected` **\_end**(): `void`
|
|
20135
20393
|
|
|
20136
|
-
Defined in: [sys/ctr.ts:
|
|
20394
|
+
Defined in: [sys/ctr.ts:1012](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1012)
|
|
20137
20395
|
|
|
20138
20396
|
主动关闭当前 socket 连接
|
|
20139
20397
|
|
|
@@ -20147,7 +20405,7 @@ Defined in: [sys/ctr.ts:848](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20147
20405
|
|
|
20148
20406
|
> `protected` **\_getBasicAuth**(`user`, `pwd`): `string`
|
|
20149
20407
|
|
|
20150
|
-
Defined in: [sys/ctr.ts:
|
|
20408
|
+
Defined in: [sys/ctr.ts:725](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L725)
|
|
20151
20409
|
|
|
20152
20410
|
获取 Auth 字符串,用于客户端提交
|
|
20153
20411
|
|
|
@@ -20175,7 +20433,7 @@ Defined in: [sys/ctr.ts:583](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20175
20433
|
|
|
20176
20434
|
> `protected` **\_getLocale**(): `string`
|
|
20177
20435
|
|
|
20178
|
-
Defined in: [sys/ctr.ts:
|
|
20436
|
+
Defined in: [sys/ctr.ts:895](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L895)
|
|
20179
20437
|
|
|
20180
20438
|
获取当前语言名
|
|
20181
20439
|
|
|
@@ -20189,7 +20447,7 @@ Defined in: [sys/ctr.ts:757](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20189
20447
|
|
|
20190
20448
|
> `protected` **\_getLocaleJsonString**(): `string`
|
|
20191
20449
|
|
|
20192
|
-
Defined in: [sys/ctr.ts:
|
|
20450
|
+
Defined in: [sys/ctr.ts:883](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L883)
|
|
20193
20451
|
|
|
20194
20452
|
根据当前后台语言包设置情况获取 JSON 字符串传输到前台
|
|
20195
20453
|
|
|
@@ -20241,7 +20499,7 @@ Defined in: [sys/ctr.ts:315](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20241
20499
|
|
|
20242
20500
|
> `protected` **\_handleFormData**(`events?`): `Promise`\<`boolean`\>
|
|
20243
20501
|
|
|
20244
|
-
Defined in: [sys/ctr.ts:
|
|
20502
|
+
Defined in: [sys/ctr.ts:1020](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1020)
|
|
20245
20503
|
|
|
20246
20504
|
获取 formdata 的信息
|
|
20247
20505
|
|
|
@@ -20273,7 +20531,7 @@ Defined in: [sys/ctr.ts:856](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20273
20531
|
|
|
20274
20532
|
> **\_l**(`key`, `data?`): `string`
|
|
20275
20533
|
|
|
20276
|
-
Defined in: [sys/ctr.ts:
|
|
20534
|
+
Defined in: [sys/ctr.ts:947](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L947)
|
|
20277
20535
|
|
|
20278
20536
|
获取语言包值
|
|
20279
20537
|
|
|
@@ -20299,7 +20557,7 @@ Defined in: [sys/ctr.ts:783](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20299
20557
|
|
|
20300
20558
|
> `protected` **\_loadData**(`path`): `Promise`\<`Record`\<`string`, `string`\> \| `null`\>
|
|
20301
20559
|
|
|
20302
|
-
Defined in: [sys/ctr.ts:
|
|
20560
|
+
Defined in: [sys/ctr.ts:786](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L786)
|
|
20303
20561
|
|
|
20304
20562
|
获取 data 数据
|
|
20305
20563
|
|
|
@@ -20321,7 +20579,7 @@ Defined in: [sys/ctr.ts:648](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20321
20579
|
|
|
20322
20580
|
> `protected` **\_loadLocale**(`loc`, `pkg?`): `Promise`\<`boolean`\>
|
|
20323
20581
|
|
|
20324
|
-
Defined in: [sys/ctr.ts:
|
|
20582
|
+
Defined in: [sys/ctr.ts:834](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L834)
|
|
20325
20583
|
|
|
20326
20584
|
设定语言并加载语言包
|
|
20327
20585
|
|
|
@@ -20345,6 +20603,75 @@ Defined in: [sys/ctr.ts:696](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20345
20603
|
|
|
20346
20604
|
***
|
|
20347
20605
|
|
|
20606
|
+
### \_loadReactPage()
|
|
20607
|
+
|
|
20608
|
+
> `protected` **\_loadReactPage**(`path`, `props?`, `opt?`): `Promise`\<`string`\>
|
|
20609
|
+
|
|
20610
|
+
Defined in: [sys/ctr.ts:359](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L359)
|
|
20611
|
+
|
|
20612
|
+
加载 React 全页面进行 SSR 渲染,组件需渲染完整 HTML 文档(含 html/head/body),无需 EJS
|
|
20613
|
+
框架自动注入 props:_urlBase/_urlFull/_urlStc/_staticVer/_staticPath/_staticPathFull
|
|
20614
|
+
多语言:自动注入 _locale(当前语言名)和 _localeData(已载语言包的合并键值对)
|
|
20615
|
+
组件内创建:const l = (key: string, ...args: string[]): string => { let i = 0; return (_localeData[key] ?? key).replace(/\?/g, () => args[i++] ?? ''); };
|
|
20616
|
+
|
|
20617
|
+
#### Parameters
|
|
20618
|
+
|
|
20619
|
+
##### path
|
|
20620
|
+
|
|
20621
|
+
`string`
|
|
20622
|
+
|
|
20623
|
+
页面组件路径(相对于 stc/ 目录,不含扩展名,tsx 编译后的 .js)
|
|
20624
|
+
|
|
20625
|
+
##### props?
|
|
20626
|
+
|
|
20627
|
+
`Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\> = `{}`
|
|
20628
|
+
|
|
20629
|
+
传入组件的 props,框架常量自动合并,整体序列化为内联 JSON 供客户端水合复用
|
|
20630
|
+
|
|
20631
|
+
##### opt?
|
|
20632
|
+
|
|
20633
|
+
可选配置
|
|
20634
|
+
|
|
20635
|
+
###### hydrate?
|
|
20636
|
+
|
|
20637
|
+
`boolean`
|
|
20638
|
+
|
|
20639
|
+
是否注入客户端水合脚本(import map + hydrateRoot),默认 true
|
|
20640
|
+
|
|
20641
|
+
###### reactVer?
|
|
20642
|
+
|
|
20643
|
+
`string`
|
|
20644
|
+
|
|
20645
|
+
react/react-dom/react-router-dom 版本号,用于 esm.sh CDN,默认 19
|
|
20646
|
+
|
|
20647
|
+
###### router?
|
|
20648
|
+
|
|
20649
|
+
`"browser"`
|
|
20650
|
+
|
|
20651
|
+
路由模式,不传则不注入任何 Router,组件自行管理路由(如 MemoryRouter)或无路由
|
|
20652
|
+
'browser':服务端用 StaticRouter,客户端用 BrowserRouter,地址栏与路由联动
|
|
20653
|
+
组件本身只需使用 Routes/Route/Link 等,不要包含任何 Router 包裹层
|
|
20654
|
+
|
|
20655
|
+
###### routerBase?
|
|
20656
|
+
|
|
20657
|
+
`string`
|
|
20658
|
+
|
|
20659
|
+
BrowserRouter 的 basename,相对于 urlBase,默认空字符串
|
|
20660
|
+
例如组件挂载在 /test/react-router-page,则填 'test/react-router-page'
|
|
20661
|
+
|
|
20662
|
+
###### staticPath?
|
|
20663
|
+
|
|
20664
|
+
`string`
|
|
20665
|
+
|
|
20666
|
+
静态资源基础路径,覆盖 config.set.staticPath,用于指定 CDN 或自定义路径
|
|
20667
|
+
影响 _staticPath prop 以及水合脚本中 JS 文件的 URL 前缀
|
|
20668
|
+
|
|
20669
|
+
#### Returns
|
|
20670
|
+
|
|
20671
|
+
`Promise`\<`string`\>
|
|
20672
|
+
|
|
20673
|
+
***
|
|
20674
|
+
|
|
20348
20675
|
### \_loadView()
|
|
20349
20676
|
|
|
20350
20677
|
> `protected` **\_loadView**(`path`, `data?`): `Promise`\<`string`\>
|
|
@@ -20373,7 +20700,7 @@ Defined in: [sys/ctr.ts:332](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20373
20700
|
|
|
20374
20701
|
> `protected` **\_location**(`location`): `false`
|
|
20375
20702
|
|
|
20376
|
-
Defined in: [sys/ctr.ts:
|
|
20703
|
+
Defined in: [sys/ctr.ts:804](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L804)
|
|
20377
20704
|
|
|
20378
20705
|
跳转(302临时跳转),支持相对本项目根路径的路径或绝对路径
|
|
20379
20706
|
|
|
@@ -20395,7 +20722,7 @@ Defined in: [sys/ctr.ts:666](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20395
20722
|
|
|
20396
20723
|
> `protected` **\_ping**(`data?`): `boolean`
|
|
20397
20724
|
|
|
20398
|
-
Defined in: [sys/ctr.ts:
|
|
20725
|
+
Defined in: [sys/ctr.ts:997](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L997)
|
|
20399
20726
|
|
|
20400
20727
|
发送 socket ping
|
|
20401
20728
|
|
|
@@ -20403,9 +20730,9 @@ Defined in: [sys/ctr.ts:833](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20403
20730
|
|
|
20404
20731
|
##### data?
|
|
20405
20732
|
|
|
20406
|
-
|
|
20733
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
20407
20734
|
|
|
20408
|
-
|
|
20735
|
+
要发送的信息
|
|
20409
20736
|
|
|
20410
20737
|
#### Returns
|
|
20411
20738
|
|
|
@@ -20417,7 +20744,7 @@ Defined in: [sys/ctr.ts:833](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20417
20744
|
|
|
20418
20745
|
> `protected` **\_pong**(`data?`): `boolean`
|
|
20419
20746
|
|
|
20420
|
-
Defined in: [sys/ctr.ts:
|
|
20747
|
+
Defined in: [sys/ctr.ts:1005](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L1005)
|
|
20421
20748
|
|
|
20422
20749
|
发送 socket pong
|
|
20423
20750
|
|
|
@@ -20425,9 +20752,9 @@ Defined in: [sys/ctr.ts:841](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20425
20752
|
|
|
20426
20753
|
##### data?
|
|
20427
20754
|
|
|
20428
|
-
|
|
20755
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
20429
20756
|
|
|
20430
|
-
|
|
20757
|
+
要发送的信息
|
|
20431
20758
|
|
|
20432
20759
|
#### Returns
|
|
20433
20760
|
|
|
@@ -20439,7 +20766,7 @@ Defined in: [sys/ctr.ts:841](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20439
20766
|
|
|
20440
20767
|
> `protected` **\_startSession**(`link`, `auth?`, `opt?`): `Promise`\<`boolean`\>
|
|
20441
20768
|
|
|
20442
|
-
Defined in: [sys/ctr.ts:
|
|
20769
|
+
Defined in: [sys/ctr.ts:818](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L818)
|
|
20443
20770
|
|
|
20444
20771
|
开启 Session
|
|
20445
20772
|
|
|
@@ -20447,9 +20774,9 @@ Defined in: [sys/ctr.ts:680](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20447
20774
|
|
|
20448
20775
|
##### link
|
|
20449
20776
|
|
|
20450
|
-
|
|
20777
|
+
[`Pool`](../../../lib/db/pool/classes/Pool.md) \| [`Kv`](../../../lib/kv/classes/Kv.md)
|
|
20451
20778
|
|
|
20452
|
-
|
|
20779
|
+
Kv 或 Db 实例
|
|
20453
20780
|
|
|
20454
20781
|
##### auth?
|
|
20455
20782
|
|
|
@@ -20473,7 +20800,7 @@ Kv 或 Db 实例
|
|
|
20473
20800
|
|
|
20474
20801
|
> `protected` **\_writeBinary**(`data`): `boolean`
|
|
20475
20802
|
|
|
20476
|
-
Defined in: [sys/ctr.ts:
|
|
20803
|
+
Defined in: [sys/ctr.ts:989](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L989)
|
|
20477
20804
|
|
|
20478
20805
|
发送 socket 二进制
|
|
20479
20806
|
|
|
@@ -20481,9 +20808,9 @@ Defined in: [sys/ctr.ts:825](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20481
20808
|
|
|
20482
20809
|
##### data
|
|
20483
20810
|
|
|
20484
|
-
|
|
20811
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\> \| (`string` \| `Buffer`\<`ArrayBufferLike`\>)[]
|
|
20485
20812
|
|
|
20486
|
-
|
|
20813
|
+
要发送的信息
|
|
20487
20814
|
|
|
20488
20815
|
#### Returns
|
|
20489
20816
|
|
|
@@ -20495,7 +20822,7 @@ Defined in: [sys/ctr.ts:825](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20495
20822
|
|
|
20496
20823
|
> `protected` **\_writeResult**(`data`): `boolean`
|
|
20497
20824
|
|
|
20498
|
-
Defined in: [sys/ctr.ts:
|
|
20825
|
+
Defined in: [sys/ctr.ts:981](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L981)
|
|
20499
20826
|
|
|
20500
20827
|
发送结果对象文本
|
|
20501
20828
|
|
|
@@ -20517,7 +20844,7 @@ Defined in: [sys/ctr.ts:817](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20517
20844
|
|
|
20518
20845
|
> `protected` **\_writeText**(`data`): `boolean`
|
|
20519
20846
|
|
|
20520
|
-
Defined in: [sys/ctr.ts:
|
|
20847
|
+
Defined in: [sys/ctr.ts:973](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L973)
|
|
20521
20848
|
|
|
20522
20849
|
发送 socket 文本
|
|
20523
20850
|
|
|
@@ -20525,9 +20852,9 @@ Defined in: [sys/ctr.ts:809](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20525
20852
|
|
|
20526
20853
|
##### data
|
|
20527
20854
|
|
|
20528
|
-
|
|
20855
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\> \| (`string` \| `Buffer`\<`ArrayBufferLike`\>)[]
|
|
20529
20856
|
|
|
20530
|
-
|
|
20857
|
+
要发送的信息
|
|
20531
20858
|
|
|
20532
20859
|
#### Returns
|
|
20533
20860
|
|
|
@@ -20537,15 +20864,15 @@ Defined in: [sys/ctr.ts:809](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20537
20864
|
|
|
20538
20865
|
### getAuthorization()
|
|
20539
20866
|
|
|
20540
|
-
> **getAuthorization**(): `
|
|
20867
|
+
> **getAuthorization**(): `false` \| \{ `pwd`: `string`; `user`: `string`; \}
|
|
20541
20868
|
|
|
20542
|
-
Defined in: [sys/ctr.ts:
|
|
20869
|
+
Defined in: [sys/ctr.ts:753](https://github.com/maiyunnet/kebab/blob/master/sys/ctr.ts#L753)
|
|
20543
20870
|
|
|
20544
|
-
通过 header 或 _auth
|
|
20871
|
+
通过 header 或 _auth 获取 Basic Auth 鉴权信息
|
|
20545
20872
|
|
|
20546
20873
|
#### Returns
|
|
20547
20874
|
|
|
20548
|
-
`
|
|
20875
|
+
`false` \| \{ `pwd`: `string`; `user`: `string`; \}
|
|
20549
20876
|
|
|
20550
20877
|
***
|
|
20551
20878
|
|
|
@@ -20671,7 +20998,7 @@ Defined in: [sys/ctr.ts:203](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20671
20998
|
|
|
20672
20999
|
###### name
|
|
20673
21000
|
|
|
20674
|
-
`"_get"`
|
|
21001
|
+
`"_get"` \| `"_rawPost"` \| `"_post"` \| `"_session"`
|
|
20675
21002
|
|
|
20676
21003
|
##### Returns
|
|
20677
21004
|
|
|
@@ -20741,9 +21068,9 @@ WebSocket 下当收到数据时会自动被调用的事件,即只文本和二
|
|
|
20741
21068
|
|
|
20742
21069
|
##### data
|
|
20743
21070
|
|
|
20744
|
-
|
|
21071
|
+
`string` \| `Buffer`\<`ArrayBufferLike`\>
|
|
20745
21072
|
|
|
20746
|
-
|
|
21073
|
+
数据
|
|
20747
21074
|
|
|
20748
21075
|
##### opcode
|
|
20749
21076
|
|
|
@@ -20877,9 +21204,9 @@ Defined in: [sys/ctr.ts:242](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20877
21204
|
|
|
20878
21205
|
##### rtn
|
|
20879
21206
|
|
|
20880
|
-
|
|
21207
|
+
`string` \| `boolean` \| [`DbValue`](../../../index/type-aliases/DbValue.md)[]
|
|
20881
21208
|
|
|
20882
|
-
|
|
21209
|
+
之前用户的输出结果
|
|
20883
21210
|
|
|
20884
21211
|
#### Returns
|
|
20885
21212
|
|
|
@@ -20905,11 +21232,11 @@ WebSocket 配置参数,包含自定义 header 和超时时间
|
|
|
20905
21232
|
|
|
20906
21233
|
##### headers?
|
|
20907
21234
|
|
|
20908
|
-
> `optional` **headers
|
|
21235
|
+
> `optional` **headers?**: `OutgoingHttpHeaders`
|
|
20909
21236
|
|
|
20910
21237
|
##### timeout?
|
|
20911
21238
|
|
|
20912
|
-
> `optional` **timeout
|
|
21239
|
+
> `optional` **timeout?**: `number`
|
|
20913
21240
|
|
|
20914
21241
|
***
|
|
20915
21242
|
|
|
@@ -20929,7 +21256,7 @@ Defined in: [sys/ctr.ts:211](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
20929
21256
|
|
|
20930
21257
|
##### val
|
|
20931
21258
|
|
|
20932
|
-
`string`
|
|
21259
|
+
`string` \| `string`[] \| `Record`\<`string`, `any`\> \| `IncomingHttpHeaders` \| [`Session`](../../../lib/session/classes/Session.md) \| [`Socket`](../../../lib/ws/classes/Socket.md) \| `null`
|
|
20933
21260
|
|
|
20934
21261
|
#### Returns
|
|
20935
21262
|
|
|
@@ -21070,7 +21397,7 @@ Defined in: [sys/mod.ts:92](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
21070
21397
|
|
|
21071
21398
|
### \_ctr?
|
|
21072
21399
|
|
|
21073
|
-
> `protected` `optional` **\_ctr
|
|
21400
|
+
> `protected` `optional` **\_ctr?**: [`Ctr`](../../ctr/classes/Ctr.md) = `undefined`
|
|
21074
21401
|
|
|
21075
21402
|
Defined in: [sys/mod.ts:107](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L107)
|
|
21076
21403
|
|
|
@@ -21170,7 +21497,7 @@ Defined in: [sys/mod.ts:74](https://github.com/maiyunnet/kebab/blob/master/sys/m
|
|
|
21170
21497
|
|
|
21171
21498
|
### \_$pre?
|
|
21172
21499
|
|
|
21173
|
-
> `protected` `static` `optional` **\_$pre
|
|
21500
|
+
> `protected` `static` `optional` **\_$pre?**: `string`
|
|
21174
21501
|
|
|
21175
21502
|
Defined in: [sys/mod.ts:80](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L80)
|
|
21176
21503
|
|
|
@@ -21316,15 +21643,15 @@ ORDER BY
|
|
|
21316
21643
|
|
|
21317
21644
|
##### c
|
|
21318
21645
|
|
|
21319
|
-
|
|
21646
|
+
`string` \| (`string` \| `string`[])[]
|
|
21320
21647
|
|
|
21321
|
-
|
|
21648
|
+
字段字符串或数组
|
|
21322
21649
|
|
|
21323
21650
|
##### d?
|
|
21324
21651
|
|
|
21325
|
-
|
|
21652
|
+
`"DESC"` \| `"ASC"`
|
|
21326
21653
|
|
|
21327
|
-
|
|
21654
|
+
排序规则
|
|
21328
21655
|
|
|
21329
21656
|
#### Returns
|
|
21330
21657
|
|
|
@@ -21714,9 +22041,9 @@ GROUP BY
|
|
|
21714
22041
|
|
|
21715
22042
|
##### c
|
|
21716
22043
|
|
|
21717
|
-
|
|
22044
|
+
`string` \| `string`[]
|
|
21718
22045
|
|
|
21719
|
-
|
|
22046
|
+
字段字符串或数组
|
|
21720
22047
|
|
|
21721
22048
|
#### Returns
|
|
21722
22049
|
|
|
@@ -22174,9 +22501,9 @@ Defined in: [sys/mod.ts:1080](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
22174
22501
|
|
|
22175
22502
|
##### f
|
|
22176
22503
|
|
|
22177
|
-
|
|
22504
|
+
`string` \| `string`[] \| [`Sql`](../../../lib/sql/classes/Sql.md) \| [`IModUnionItem`](../interfaces/IModUnionItem.md) \| [`IModUnionItem`](../interfaces/IModUnionItem.md)[]
|
|
22178
22505
|
|
|
22179
|
-
|
|
22506
|
+
要联合查询的表列表、单个表、sql 对象
|
|
22180
22507
|
|
|
22181
22508
|
##### type?
|
|
22182
22509
|
|
|
@@ -22202,9 +22529,9 @@ Defined in: [sys/mod.ts:1110](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
22202
22529
|
|
|
22203
22530
|
##### f
|
|
22204
22531
|
|
|
22205
|
-
|
|
22532
|
+
`string` \| `string`[] \| [`Sql`](../../../lib/sql/classes/Sql.md) \| [`IModUnionItem`](../interfaces/IModUnionItem.md) \| [`IModUnionItem`](../interfaces/IModUnionItem.md)[]
|
|
22206
22533
|
|
|
22207
|
-
|
|
22534
|
+
要联合查询的表列表、单个表、sql 对象
|
|
22208
22535
|
|
|
22209
22536
|
#### Returns
|
|
22210
22537
|
|
|
@@ -22252,9 +22579,9 @@ Defined in: [sys/mod.ts:920](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22252
22579
|
|
|
22253
22580
|
##### conflict
|
|
22254
22581
|
|
|
22255
|
-
|
|
22582
|
+
`string` \| `string`[]
|
|
22256
22583
|
|
|
22257
|
-
|
|
22584
|
+
冲突字段,不能为 _$key 或 _$primary,应该是你要判断的唯一索引字段
|
|
22258
22585
|
|
|
22259
22586
|
#### Returns
|
|
22260
22587
|
|
|
@@ -22334,15 +22661,15 @@ Defined in: [sys/mod.ts:610](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22334
22661
|
|
|
22335
22662
|
##### db
|
|
22336
22663
|
|
|
22337
|
-
|
|
22664
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22338
22665
|
|
|
22339
|
-
|
|
22666
|
+
数据库对象
|
|
22340
22667
|
|
|
22341
22668
|
##### val
|
|
22342
22669
|
|
|
22343
|
-
|
|
22670
|
+
`string` \| `number` \| `null`
|
|
22344
22671
|
|
|
22345
|
-
|
|
22672
|
+
主键值
|
|
22346
22673
|
|
|
22347
22674
|
##### opt?
|
|
22348
22675
|
|
|
@@ -22394,9 +22721,9 @@ Defined in: [sys/mod.ts:592](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22394
22721
|
|
|
22395
22722
|
##### db
|
|
22396
22723
|
|
|
22397
|
-
|
|
22724
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22398
22725
|
|
|
22399
|
-
|
|
22726
|
+
数据库对象
|
|
22400
22727
|
|
|
22401
22728
|
##### opt?
|
|
22402
22729
|
|
|
@@ -22432,21 +22759,21 @@ Defined in: [sys/mod.ts:194](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22432
22759
|
|
|
22433
22760
|
##### db
|
|
22434
22761
|
|
|
22435
|
-
|
|
22762
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22436
22763
|
|
|
22437
|
-
|
|
22764
|
+
数据库对象
|
|
22438
22765
|
|
|
22439
22766
|
##### cs
|
|
22440
22767
|
|
|
22441
|
-
|
|
22768
|
+
`string`[] \| `Record`\<`string`, `any`\>
|
|
22442
22769
|
|
|
22443
|
-
|
|
22770
|
+
字段列表
|
|
22444
22771
|
|
|
22445
22772
|
##### vs?
|
|
22446
22773
|
|
|
22447
|
-
|
|
22774
|
+
`any`[] \| `any`[][]
|
|
22448
22775
|
|
|
22449
|
-
|
|
22776
|
+
数据列表
|
|
22450
22777
|
|
|
22451
22778
|
##### opt?
|
|
22452
22779
|
|
|
@@ -22486,21 +22813,21 @@ Defined in: [sys/mod.ts:254](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22486
22813
|
|
|
22487
22814
|
##### db
|
|
22488
22815
|
|
|
22489
|
-
|
|
22816
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22490
22817
|
|
|
22491
|
-
|
|
22818
|
+
数据库对象
|
|
22492
22819
|
|
|
22493
22820
|
##### cs
|
|
22494
22821
|
|
|
22495
|
-
|
|
22822
|
+
`string`[] \| `Record`\<`string`, `any`\>
|
|
22496
22823
|
|
|
22497
|
-
|
|
22824
|
+
字段列表
|
|
22498
22825
|
|
|
22499
22826
|
##### vs?
|
|
22500
22827
|
|
|
22501
|
-
|
|
22828
|
+
`any`[] \| `any`[][]
|
|
22502
22829
|
|
|
22503
|
-
|
|
22830
|
+
数据列表
|
|
22504
22831
|
|
|
22505
22832
|
##### opt?
|
|
22506
22833
|
|
|
@@ -22574,7 +22901,7 @@ Defined in: [sys/mod.ts:637](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22574
22901
|
|
|
22575
22902
|
###### db
|
|
22576
22903
|
|
|
22577
|
-
[`Transaction`](../../../lib/db/tran/classes/Transaction.md)
|
|
22904
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22578
22905
|
|
|
22579
22906
|
###### s
|
|
22580
22907
|
|
|
@@ -22626,7 +22953,7 @@ Defined in: [sys/mod.ts:649](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22626
22953
|
|
|
22627
22954
|
###### db
|
|
22628
22955
|
|
|
22629
|
-
[`Transaction`](../../../lib/db/tran/classes/Transaction.md)
|
|
22956
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22630
22957
|
|
|
22631
22958
|
###### s
|
|
22632
22959
|
|
|
@@ -22676,9 +23003,9 @@ Defined in: [sys/mod.ts:724](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22676
23003
|
|
|
22677
23004
|
##### db
|
|
22678
23005
|
|
|
22679
|
-
|
|
23006
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22680
23007
|
|
|
22681
|
-
|
|
23008
|
+
数据库对象
|
|
22682
23009
|
|
|
22683
23010
|
##### s
|
|
22684
23011
|
|
|
@@ -22724,9 +23051,9 @@ Defined in: [sys/mod.ts:744](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22724
23051
|
|
|
22725
23052
|
##### db
|
|
22726
23053
|
|
|
22727
|
-
|
|
23054
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22728
23055
|
|
|
22729
|
-
|
|
23056
|
+
数据库对象
|
|
22730
23057
|
|
|
22731
23058
|
##### where?
|
|
22732
23059
|
|
|
@@ -22768,9 +23095,9 @@ Defined in: [sys/mod.ts:280](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22768
23095
|
|
|
22769
23096
|
##### db
|
|
22770
23097
|
|
|
22771
|
-
|
|
23098
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22772
23099
|
|
|
22773
|
-
|
|
23100
|
+
数据库对象
|
|
22774
23101
|
|
|
22775
23102
|
##### where
|
|
22776
23103
|
|
|
@@ -22820,9 +23147,9 @@ Defined in: [sys/mod.ts:324](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22820
23147
|
|
|
22821
23148
|
##### db
|
|
22822
23149
|
|
|
22823
|
-
|
|
23150
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22824
23151
|
|
|
22825
|
-
|
|
23152
|
+
数据库对象
|
|
22826
23153
|
|
|
22827
23154
|
##### where
|
|
22828
23155
|
|
|
@@ -22878,15 +23205,15 @@ select 自定字段
|
|
|
22878
23205
|
|
|
22879
23206
|
##### db
|
|
22880
23207
|
|
|
22881
|
-
|
|
23208
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22882
23209
|
|
|
22883
|
-
|
|
23210
|
+
数据库对象
|
|
22884
23211
|
|
|
22885
23212
|
##### c
|
|
22886
23213
|
|
|
22887
|
-
|
|
23214
|
+
`string` \| `string`[]
|
|
22888
23215
|
|
|
22889
|
-
|
|
23216
|
+
字段字符串或字段数组
|
|
22890
23217
|
|
|
22891
23218
|
##### opt?
|
|
22892
23219
|
|
|
@@ -22966,9 +23293,9 @@ Defined in: [sys/mod.ts:357](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
22966
23293
|
|
|
22967
23294
|
##### db
|
|
22968
23295
|
|
|
22969
|
-
|
|
23296
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
22970
23297
|
|
|
22971
|
-
|
|
23298
|
+
数据库对象
|
|
22972
23299
|
|
|
22973
23300
|
##### data
|
|
22974
23301
|
|
|
@@ -23024,9 +23351,9 @@ Defined in: [sys/mod.ts:403](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
23024
23351
|
|
|
23025
23352
|
##### db
|
|
23026
23353
|
|
|
23027
|
-
|
|
23354
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
23028
23355
|
|
|
23029
|
-
|
|
23356
|
+
数据库对象
|
|
23030
23357
|
|
|
23031
23358
|
##### data
|
|
23032
23359
|
|
|
@@ -23082,9 +23409,9 @@ Defined in: [sys/mod.ts:437](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
23082
23409
|
|
|
23083
23410
|
##### db
|
|
23084
23411
|
|
|
23085
|
-
|
|
23412
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
23086
23413
|
|
|
23087
|
-
|
|
23414
|
+
数据库对象
|
|
23088
23415
|
|
|
23089
23416
|
##### data
|
|
23090
23417
|
|
|
@@ -23138,9 +23465,9 @@ Defined in: [sys/mod.ts:563](https://github.com/maiyunnet/kebab/blob/master/sys/
|
|
|
23138
23465
|
|
|
23139
23466
|
##### db
|
|
23140
23467
|
|
|
23141
|
-
|
|
23468
|
+
[`Transaction`](../../../lib/db/tran/classes/Transaction.md) \| [`Pool`](../../../lib/db/pool/classes/Pool.md)
|
|
23142
23469
|
|
|
23143
|
-
|
|
23470
|
+
数据库对象
|
|
23144
23471
|
|
|
23145
23472
|
##### s?
|
|
23146
23473
|
|
|
@@ -23403,7 +23730,7 @@ Defined in: [sys/mod.ts:1809](https://github.com/maiyunnet/kebab/blob/master/sys
|
|
|
23403
23730
|
|
|
23404
23731
|
### where?
|
|
23405
23732
|
|
|
23406
|
-
> `optional` **where
|
|
23733
|
+
> `optional` **where?**: `any`
|
|
23407
23734
|
|
|
23408
23735
|
Defined in: [sys/mod.ts:1810](https://github.com/maiyunnet/kebab/blob/master/sys/mod.ts#L1810)
|
|
23409
23736
|
|
|
@@ -23523,9 +23850,9 @@ sys/route/functions/getFormData.md
|
|
|
23523
23850
|
|
|
23524
23851
|
# Function: getFormData()
|
|
23525
23852
|
|
|
23526
|
-
> **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)\>; \}\>
|
|
23853
|
+
> **getFormData**(`req`, `events?`, `limits?`): `Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|
|
23527
23854
|
|
|
23528
|
-
Defined in: [sys/route.ts:
|
|
23855
|
+
Defined in: [sys/route.ts:933](https://github.com/maiyunnet/kebab/blob/master/sys/route.ts#L933)
|
|
23529
23856
|
|
|
23530
23857
|
获取 formdata 的 post
|
|
23531
23858
|
|
|
@@ -23533,9 +23860,9 @@ Defined in: [sys/route.ts:932](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
23533
23860
|
|
|
23534
23861
|
### req
|
|
23535
23862
|
|
|
23536
|
-
|
|
23863
|
+
`IncomingMessage` \| `Http2ServerRequest`
|
|
23537
23864
|
|
|
23538
|
-
|
|
23865
|
+
请求头
|
|
23539
23866
|
|
|
23540
23867
|
### events?
|
|
23541
23868
|
|
|
@@ -23559,6 +23886,22 @@ Defined in: [sys/route.ts:932](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
23559
23886
|
|
|
23560
23887
|
文件开始上传时触发,返回 true 则跳过该文件的保存
|
|
23561
23888
|
|
|
23889
|
+
### limits?
|
|
23890
|
+
|
|
23891
|
+
文件上传限制
|
|
23892
|
+
|
|
23893
|
+
#### allowedExts?
|
|
23894
|
+
|
|
23895
|
+
`string`[]
|
|
23896
|
+
|
|
23897
|
+
允许的文件扩展名(含点号),如 ['.jpg', '.png', '.pdf']
|
|
23898
|
+
|
|
23899
|
+
#### maxFileSize?
|
|
23900
|
+
|
|
23901
|
+
`number`
|
|
23902
|
+
|
|
23903
|
+
单个文件最大字节数
|
|
23904
|
+
|
|
23562
23905
|
## Returns
|
|
23563
23906
|
|
|
23564
23907
|
`Promise`\<`false` \| \{ `files`: `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>; `post`: `Record`\<`string`, [`Json`](../../../index/type-aliases/Json.md)\>; \}\>
|
|
@@ -23584,9 +23927,9 @@ Defined in: [sys/route.ts:866](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
23584
23927
|
|
|
23585
23928
|
### req
|
|
23586
23929
|
|
|
23587
|
-
|
|
23930
|
+
`IncomingMessage` \| `Http2ServerRequest`
|
|
23588
23931
|
|
|
23589
|
-
|
|
23932
|
+
请求对象
|
|
23590
23933
|
|
|
23591
23934
|
## Returns
|
|
23592
23935
|
|
|
@@ -23700,9 +24043,9 @@ Defined in: [sys/route.ts:825](https://github.com/maiyunnet/kebab/blob/master/sy
|
|
|
23700
24043
|
|
|
23701
24044
|
### cctr
|
|
23702
24045
|
|
|
23703
|
-
Ctr
|
|
24046
|
+
[`Ctr`](../../ctr/classes/Ctr.md) \| `Record`\<`string`, [`IPostFile`](../../../index/interfaces/IPostFile.md) \| [`IPostFile`](../../../index/interfaces/IPostFile.md)[]\>
|
|
23704
24047
|
|
|
23705
|
-
|
|
24048
|
+
Ctr 对象 或 files
|
|
23706
24049
|
|
|
23707
24050
|
## Returns
|
|
23708
24051
|
|