@visulima/fs 2.3.7 → 3.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/CHANGELOG.md +31 -0
- package/README.md +1531 -1166
- package/dist/index.cjs +4 -12
- package/dist/index.d.cts +11 -24
- package/dist/index.d.mts +11 -24
- package/dist/index.d.ts +11 -24
- package/dist/index.mjs +4 -8
- package/dist/packem_shared/observable-like.d-BlD8q22s.d.cts +40 -0
- package/dist/packem_shared/observable-like.d-BlD8q22s.d.mjs +40 -0
- package/dist/packem_shared/observable-like.d-BlD8q22s.d.mts +40 -0
- package/dist/packem_shared/{observable-like.d-CJo2GVD9.d.cts → types-CiwAWOQj.d.cts} +1 -40
- package/dist/packem_shared/{observable-like.d-CJo2GVD9.d.mjs → types-CiwAWOQj.d.mjs} +1 -40
- package/dist/packem_shared/{observable-like.d-CJo2GVD9.d.mts → types-CiwAWOQj.d.mts} +1 -40
- package/dist/packem_shared/{writeFile-DKu5-M8x.cjs → writeFile-CnWc2ZOW.cjs} +3 -3
- package/dist/packem_shared/{writeFile-B7dhfseN.mjs → writeFile-CzpkxDqy.mjs} +3 -3
- package/dist/packem_shared/{writeFileSync-mMGYqOc8.mjs → writeFileSync-DYRpumrj.mjs} +3 -3
- package/dist/packem_shared/{writeFileSync-Db6pmY0q.cjs → writeFileSync-da4qD9Nz.cjs} +3 -3
- package/dist/packem_shared/{writeJson-DtnnjTix.cjs → writeJson-9_C3v2B3.cjs} +1 -1
- package/dist/packem_shared/{writeJson-BSQE2uFN.mjs → writeJson-V9KBXfw2.mjs} +1 -1
- package/dist/packem_shared/{writeJsonSync-Dz5-B2PD.cjs → writeJsonSync-C5kkxqE7.cjs} +1 -1
- package/dist/packem_shared/{writeJsonSync-C_i6LsGT.mjs → writeJsonSync-CyaXNy3X.mjs} +1 -1
- package/dist/packem_shared/{writeYaml-B-KoZN0E.cjs → writeYaml-DDLK7NDr.cjs} +1 -1
- package/dist/packem_shared/{writeYaml-DSTzKc0_.mjs → writeYaml-DJ17fqNj.mjs} +1 -1
- package/dist/packem_shared/{writeYamlSync-agxYIea0.mjs → writeYamlSync-C6nrcP2e.mjs} +1 -1
- package/dist/packem_shared/{writeYamlSync-D6borSP1.cjs → writeYamlSync-DST-W6N7.cjs} +1 -1
- package/dist/utils.d.cts +2 -1
- package/dist/utils.d.mts +2 -1
- package/dist/utils.d.ts +2 -1
- package/dist/yaml.cjs +15 -0
- package/dist/yaml.d.cts +19 -0
- package/dist/yaml.d.mts +19 -0
- package/dist/yaml.d.ts +19 -0
- package/dist/yaml.mjs +4 -0
- package/package.json +21 -73
package/README.md
CHANGED
|
@@ -39,6 +39,22 @@ yarn add @visulima/fs
|
|
|
39
39
|
pnpm add @visulima/fs
|
|
40
40
|
```
|
|
41
41
|
|
|
42
|
+
> **Note:** If you want to parse or write YAML, you'll need to install `yaml` as well.
|
|
43
|
+
|
|
44
|
+
```sh
|
|
45
|
+
npm install yaml
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
```sh
|
|
49
|
+
yarn add yaml
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
```sh
|
|
53
|
+
pnpm add yaml
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
> After installing `yaml`, you can use the `readYaml`, `readYamlSync` and `writeYaml`, `writeYamlSync` functions from `@visulima/fs/yaml`.
|
|
57
|
+
|
|
42
58
|
## Usage
|
|
43
59
|
|
|
44
60
|
## walk
|
|
@@ -443,6 +459,8 @@ The printable section of the JSON which produces the error.
|
|
|
443
459
|
|
|
444
460
|
### AlreadyExistsError
|
|
445
461
|
|
|
462
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/already-exists-error.ts#L4)
|
|
463
|
+
|
|
446
464
|
Error thrown when file already exists.
|
|
447
465
|
|
|
448
466
|
#### Extends
|
|
@@ -457,11 +475,15 @@ Error thrown when file already exists.
|
|
|
457
475
|
new AlreadyExistsError(message): AlreadyExistsError
|
|
458
476
|
```
|
|
459
477
|
|
|
478
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/already-exists-error.ts#L9)
|
|
479
|
+
|
|
460
480
|
Creates a new instance.
|
|
461
481
|
|
|
462
482
|
###### Parameters
|
|
463
483
|
|
|
464
|
-
|
|
484
|
+
###### message
|
|
485
|
+
|
|
486
|
+
`string`
|
|
465
487
|
|
|
466
488
|
The error message.
|
|
467
489
|
|
|
@@ -471,61 +493,81 @@ The error message.
|
|
|
471
493
|
|
|
472
494
|
###### Overrides
|
|
473
495
|
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
[packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/already-exists-error.ts#L9)
|
|
496
|
+
```ts
|
|
497
|
+
Error.constructor
|
|
498
|
+
```
|
|
479
499
|
|
|
480
500
|
#### Accessors
|
|
481
501
|
|
|
482
502
|
##### code
|
|
483
503
|
|
|
504
|
+
###### Get Signature
|
|
505
|
+
|
|
484
506
|
```ts
|
|
485
507
|
get code(): string
|
|
486
508
|
```
|
|
487
509
|
|
|
510
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/already-exists-error.ts#L14)
|
|
511
|
+
|
|
512
|
+
###### Returns
|
|
513
|
+
|
|
514
|
+
`string`
|
|
515
|
+
|
|
516
|
+
###### Set Signature
|
|
517
|
+
|
|
488
518
|
```ts
|
|
489
519
|
set code(_name): void
|
|
490
520
|
```
|
|
491
521
|
|
|
492
|
-
|
|
522
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:19](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/already-exists-error.ts#L19)
|
|
493
523
|
|
|
494
|
-
|
|
524
|
+
###### Parameters
|
|
495
525
|
|
|
496
|
-
######
|
|
526
|
+
###### \_name
|
|
497
527
|
|
|
498
528
|
`string`
|
|
499
529
|
|
|
500
|
-
######
|
|
530
|
+
###### Returns
|
|
501
531
|
|
|
502
|
-
|
|
532
|
+
`void`
|
|
503
533
|
|
|
504
534
|
##### name
|
|
505
535
|
|
|
536
|
+
###### Get Signature
|
|
537
|
+
|
|
506
538
|
```ts
|
|
507
539
|
get name(): string
|
|
508
540
|
```
|
|
509
541
|
|
|
542
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/already-exists-error.ts#L24)
|
|
543
|
+
|
|
544
|
+
###### Returns
|
|
545
|
+
|
|
546
|
+
`string`
|
|
547
|
+
|
|
548
|
+
###### Set Signature
|
|
549
|
+
|
|
510
550
|
```ts
|
|
511
551
|
set name(_name): void
|
|
512
552
|
```
|
|
513
553
|
|
|
514
|
-
|
|
554
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:29](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/already-exists-error.ts#L29)
|
|
515
555
|
|
|
516
|
-
|
|
556
|
+
###### Parameters
|
|
517
557
|
|
|
518
|
-
######
|
|
558
|
+
###### \_name
|
|
519
559
|
|
|
520
560
|
`string`
|
|
521
561
|
|
|
522
|
-
######
|
|
562
|
+
###### Returns
|
|
523
563
|
|
|
524
|
-
`
|
|
564
|
+
`void`
|
|
525
565
|
|
|
526
|
-
######
|
|
566
|
+
###### Overrides
|
|
527
567
|
|
|
528
|
-
|
|
568
|
+
```ts
|
|
569
|
+
Error.name
|
|
570
|
+
```
|
|
529
571
|
|
|
530
572
|
#### Methods
|
|
531
573
|
|
|
@@ -535,13 +577,19 @@ set name(_name): void
|
|
|
535
577
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
536
578
|
```
|
|
537
579
|
|
|
580
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
581
|
+
|
|
538
582
|
Create .stack property on a target object
|
|
539
583
|
|
|
540
584
|
###### Parameters
|
|
541
585
|
|
|
542
|
-
|
|
586
|
+
###### targetObject
|
|
543
587
|
|
|
544
|
-
|
|
588
|
+
`object`
|
|
589
|
+
|
|
590
|
+
###### constructorOpt?
|
|
591
|
+
|
|
592
|
+
`Function`
|
|
545
593
|
|
|
546
594
|
###### Returns
|
|
547
595
|
|
|
@@ -549,11 +597,9 @@ Create .stack property on a target object
|
|
|
549
597
|
|
|
550
598
|
###### Inherited from
|
|
551
599
|
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
600
|
+
```ts
|
|
601
|
+
Error.captureStackTrace
|
|
602
|
+
```
|
|
557
603
|
|
|
558
604
|
#### Properties
|
|
559
605
|
|
|
@@ -563,13 +609,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
563
609
|
optional cause: unknown;
|
|
564
610
|
```
|
|
565
611
|
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
`Error.cause`
|
|
612
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
569
613
|
|
|
570
|
-
######
|
|
614
|
+
###### Inherited from
|
|
571
615
|
|
|
572
|
-
|
|
616
|
+
```ts
|
|
617
|
+
Error.cause
|
|
618
|
+
```
|
|
573
619
|
|
|
574
620
|
##### message
|
|
575
621
|
|
|
@@ -577,13 +623,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
577
623
|
message: string;
|
|
578
624
|
```
|
|
579
625
|
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
`Error.message`
|
|
626
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
583
627
|
|
|
584
|
-
######
|
|
628
|
+
###### Inherited from
|
|
585
629
|
|
|
586
|
-
|
|
630
|
+
```ts
|
|
631
|
+
Error.message
|
|
632
|
+
```
|
|
587
633
|
|
|
588
634
|
##### stack?
|
|
589
635
|
|
|
@@ -591,13 +637,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
591
637
|
optional stack: string;
|
|
592
638
|
```
|
|
593
639
|
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
`Error.stack`
|
|
640
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
597
641
|
|
|
598
|
-
######
|
|
642
|
+
###### Inherited from
|
|
599
643
|
|
|
600
|
-
|
|
644
|
+
```ts
|
|
645
|
+
Error.stack
|
|
646
|
+
```
|
|
601
647
|
|
|
602
648
|
##### prepareStackTrace()?
|
|
603
649
|
|
|
@@ -605,13 +651,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
605
651
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
606
652
|
```
|
|
607
653
|
|
|
654
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
655
|
+
|
|
608
656
|
Optional override for formatting stack traces
|
|
609
657
|
|
|
610
658
|
###### Parameters
|
|
611
659
|
|
|
612
|
-
|
|
660
|
+
###### err
|
|
661
|
+
|
|
662
|
+
`Error`
|
|
663
|
+
|
|
664
|
+
###### stackTraces
|
|
613
665
|
|
|
614
|
-
|
|
666
|
+
`CallSite`[]
|
|
615
667
|
|
|
616
668
|
###### Returns
|
|
617
669
|
|
|
@@ -623,11 +675,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
623
675
|
|
|
624
676
|
###### Inherited from
|
|
625
677
|
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
678
|
+
```ts
|
|
679
|
+
Error.prepareStackTrace
|
|
680
|
+
```
|
|
631
681
|
|
|
632
682
|
##### stackTraceLimit
|
|
633
683
|
|
|
@@ -635,18 +685,20 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
635
685
|
static stackTraceLimit: number;
|
|
636
686
|
```
|
|
637
687
|
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
`Error.stackTraceLimit`
|
|
688
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
641
689
|
|
|
642
|
-
######
|
|
690
|
+
###### Inherited from
|
|
643
691
|
|
|
644
|
-
|
|
692
|
+
```ts
|
|
693
|
+
Error.stackTraceLimit
|
|
694
|
+
```
|
|
645
695
|
|
|
646
|
-
|
|
696
|
+
***
|
|
647
697
|
|
|
648
698
|
### DirectoryError
|
|
649
699
|
|
|
700
|
+
Defined in: [packages/fs/src/error/directory-error.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/directory-error.ts#L4)
|
|
701
|
+
|
|
650
702
|
Error thrown when an operation is not allowed on a directory.
|
|
651
703
|
|
|
652
704
|
#### Extends
|
|
@@ -661,11 +713,15 @@ Error thrown when an operation is not allowed on a directory.
|
|
|
661
713
|
new DirectoryError(message): DirectoryError
|
|
662
714
|
```
|
|
663
715
|
|
|
716
|
+
Defined in: [packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/directory-error.ts#L9)
|
|
717
|
+
|
|
664
718
|
Creates a new instance.
|
|
665
719
|
|
|
666
720
|
###### Parameters
|
|
667
721
|
|
|
668
|
-
|
|
722
|
+
###### message
|
|
723
|
+
|
|
724
|
+
`string`
|
|
669
725
|
|
|
670
726
|
The error message.
|
|
671
727
|
|
|
@@ -675,61 +731,81 @@ The error message.
|
|
|
675
731
|
|
|
676
732
|
###### Overrides
|
|
677
733
|
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
[packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/directory-error.ts#L9)
|
|
734
|
+
```ts
|
|
735
|
+
Error.constructor
|
|
736
|
+
```
|
|
683
737
|
|
|
684
738
|
#### Accessors
|
|
685
739
|
|
|
686
740
|
##### code
|
|
687
741
|
|
|
742
|
+
###### Get Signature
|
|
743
|
+
|
|
688
744
|
```ts
|
|
689
745
|
get code(): string
|
|
690
746
|
```
|
|
691
747
|
|
|
748
|
+
Defined in: [packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/directory-error.ts#L14)
|
|
749
|
+
|
|
750
|
+
###### Returns
|
|
751
|
+
|
|
752
|
+
`string`
|
|
753
|
+
|
|
754
|
+
###### Set Signature
|
|
755
|
+
|
|
692
756
|
```ts
|
|
693
757
|
set code(_name): void
|
|
694
758
|
```
|
|
695
759
|
|
|
696
|
-
|
|
760
|
+
Defined in: [packages/fs/src/error/directory-error.ts:19](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/directory-error.ts#L19)
|
|
697
761
|
|
|
698
|
-
|
|
762
|
+
###### Parameters
|
|
699
763
|
|
|
700
|
-
######
|
|
764
|
+
###### \_name
|
|
701
765
|
|
|
702
766
|
`string`
|
|
703
767
|
|
|
704
|
-
######
|
|
768
|
+
###### Returns
|
|
705
769
|
|
|
706
|
-
|
|
770
|
+
`void`
|
|
707
771
|
|
|
708
772
|
##### name
|
|
709
773
|
|
|
774
|
+
###### Get Signature
|
|
775
|
+
|
|
710
776
|
```ts
|
|
711
777
|
get name(): string
|
|
712
778
|
```
|
|
713
779
|
|
|
780
|
+
Defined in: [packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/directory-error.ts#L24)
|
|
781
|
+
|
|
782
|
+
###### Returns
|
|
783
|
+
|
|
784
|
+
`string`
|
|
785
|
+
|
|
786
|
+
###### Set Signature
|
|
787
|
+
|
|
714
788
|
```ts
|
|
715
789
|
set name(_name): void
|
|
716
790
|
```
|
|
717
791
|
|
|
718
|
-
|
|
792
|
+
Defined in: [packages/fs/src/error/directory-error.ts:29](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/directory-error.ts#L29)
|
|
719
793
|
|
|
720
|
-
|
|
794
|
+
###### Parameters
|
|
721
795
|
|
|
722
|
-
######
|
|
796
|
+
###### \_name
|
|
723
797
|
|
|
724
798
|
`string`
|
|
725
799
|
|
|
726
|
-
######
|
|
800
|
+
###### Returns
|
|
727
801
|
|
|
728
|
-
`
|
|
802
|
+
`void`
|
|
729
803
|
|
|
730
|
-
######
|
|
804
|
+
###### Overrides
|
|
731
805
|
|
|
732
|
-
|
|
806
|
+
```ts
|
|
807
|
+
Error.name
|
|
808
|
+
```
|
|
733
809
|
|
|
734
810
|
#### Methods
|
|
735
811
|
|
|
@@ -739,13 +815,19 @@ set name(_name): void
|
|
|
739
815
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
740
816
|
```
|
|
741
817
|
|
|
818
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
819
|
+
|
|
742
820
|
Create .stack property on a target object
|
|
743
821
|
|
|
744
822
|
###### Parameters
|
|
745
823
|
|
|
746
|
-
|
|
824
|
+
###### targetObject
|
|
825
|
+
|
|
826
|
+
`object`
|
|
747
827
|
|
|
748
|
-
|
|
828
|
+
###### constructorOpt?
|
|
829
|
+
|
|
830
|
+
`Function`
|
|
749
831
|
|
|
750
832
|
###### Returns
|
|
751
833
|
|
|
@@ -753,11 +835,9 @@ Create .stack property on a target object
|
|
|
753
835
|
|
|
754
836
|
###### Inherited from
|
|
755
837
|
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
838
|
+
```ts
|
|
839
|
+
Error.captureStackTrace
|
|
840
|
+
```
|
|
761
841
|
|
|
762
842
|
#### Properties
|
|
763
843
|
|
|
@@ -767,13 +847,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
767
847
|
optional cause: unknown;
|
|
768
848
|
```
|
|
769
849
|
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
`Error.cause`
|
|
850
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
773
851
|
|
|
774
|
-
######
|
|
852
|
+
###### Inherited from
|
|
775
853
|
|
|
776
|
-
|
|
854
|
+
```ts
|
|
855
|
+
Error.cause
|
|
856
|
+
```
|
|
777
857
|
|
|
778
858
|
##### message
|
|
779
859
|
|
|
@@ -781,13 +861,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
781
861
|
message: string;
|
|
782
862
|
```
|
|
783
863
|
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
`Error.message`
|
|
864
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
787
865
|
|
|
788
|
-
######
|
|
866
|
+
###### Inherited from
|
|
789
867
|
|
|
790
|
-
|
|
868
|
+
```ts
|
|
869
|
+
Error.message
|
|
870
|
+
```
|
|
791
871
|
|
|
792
872
|
##### stack?
|
|
793
873
|
|
|
@@ -795,13 +875,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
795
875
|
optional stack: string;
|
|
796
876
|
```
|
|
797
877
|
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
`Error.stack`
|
|
878
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
801
879
|
|
|
802
|
-
######
|
|
880
|
+
###### Inherited from
|
|
803
881
|
|
|
804
|
-
|
|
882
|
+
```ts
|
|
883
|
+
Error.stack
|
|
884
|
+
```
|
|
805
885
|
|
|
806
886
|
##### prepareStackTrace()?
|
|
807
887
|
|
|
@@ -809,13 +889,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
809
889
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
810
890
|
```
|
|
811
891
|
|
|
892
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
893
|
+
|
|
812
894
|
Optional override for formatting stack traces
|
|
813
895
|
|
|
814
896
|
###### Parameters
|
|
815
897
|
|
|
816
|
-
|
|
898
|
+
###### err
|
|
899
|
+
|
|
900
|
+
`Error`
|
|
817
901
|
|
|
818
|
-
|
|
902
|
+
###### stackTraces
|
|
903
|
+
|
|
904
|
+
`CallSite`[]
|
|
819
905
|
|
|
820
906
|
###### Returns
|
|
821
907
|
|
|
@@ -827,11 +913,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
827
913
|
|
|
828
914
|
###### Inherited from
|
|
829
915
|
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
916
|
+
```ts
|
|
917
|
+
Error.prepareStackTrace
|
|
918
|
+
```
|
|
835
919
|
|
|
836
920
|
##### stackTraceLimit
|
|
837
921
|
|
|
@@ -839,18 +923,20 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
839
923
|
static stackTraceLimit: number;
|
|
840
924
|
```
|
|
841
925
|
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
`Error.stackTraceLimit`
|
|
926
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
845
927
|
|
|
846
|
-
######
|
|
928
|
+
###### Inherited from
|
|
847
929
|
|
|
848
|
-
|
|
930
|
+
```ts
|
|
931
|
+
Error.stackTraceLimit
|
|
932
|
+
```
|
|
849
933
|
|
|
850
|
-
|
|
934
|
+
***
|
|
851
935
|
|
|
852
936
|
### NotEmptyError
|
|
853
937
|
|
|
938
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-empty-error.ts#L4)
|
|
939
|
+
|
|
854
940
|
Error thrown when a directory is not empty.
|
|
855
941
|
|
|
856
942
|
#### Extends
|
|
@@ -865,11 +951,15 @@ Error thrown when a directory is not empty.
|
|
|
865
951
|
new NotEmptyError(message): NotEmptyError
|
|
866
952
|
```
|
|
867
953
|
|
|
954
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-empty-error.ts#L9)
|
|
955
|
+
|
|
868
956
|
Creates a new instance.
|
|
869
957
|
|
|
870
958
|
###### Parameters
|
|
871
959
|
|
|
872
|
-
|
|
960
|
+
###### message
|
|
961
|
+
|
|
962
|
+
`string`
|
|
873
963
|
|
|
874
964
|
The error message.
|
|
875
965
|
|
|
@@ -879,61 +969,81 @@ The error message.
|
|
|
879
969
|
|
|
880
970
|
###### Overrides
|
|
881
971
|
|
|
882
|
-
|
|
883
|
-
|
|
884
|
-
|
|
885
|
-
|
|
886
|
-
[packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-empty-error.ts#L9)
|
|
972
|
+
```ts
|
|
973
|
+
Error.constructor
|
|
974
|
+
```
|
|
887
975
|
|
|
888
976
|
#### Accessors
|
|
889
977
|
|
|
890
978
|
##### code
|
|
891
979
|
|
|
980
|
+
###### Get Signature
|
|
981
|
+
|
|
892
982
|
```ts
|
|
893
983
|
get code(): string
|
|
894
984
|
```
|
|
895
985
|
|
|
986
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-empty-error.ts#L14)
|
|
987
|
+
|
|
988
|
+
###### Returns
|
|
989
|
+
|
|
990
|
+
`string`
|
|
991
|
+
|
|
992
|
+
###### Set Signature
|
|
993
|
+
|
|
896
994
|
```ts
|
|
897
995
|
set code(_name): void
|
|
898
996
|
```
|
|
899
997
|
|
|
900
|
-
|
|
998
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:19](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-empty-error.ts#L19)
|
|
901
999
|
|
|
902
|
-
|
|
1000
|
+
###### Parameters
|
|
903
1001
|
|
|
904
|
-
######
|
|
1002
|
+
###### \_name
|
|
905
1003
|
|
|
906
1004
|
`string`
|
|
907
1005
|
|
|
908
|
-
######
|
|
1006
|
+
###### Returns
|
|
909
1007
|
|
|
910
|
-
|
|
1008
|
+
`void`
|
|
911
1009
|
|
|
912
1010
|
##### name
|
|
913
1011
|
|
|
1012
|
+
###### Get Signature
|
|
1013
|
+
|
|
914
1014
|
```ts
|
|
915
1015
|
get name(): string
|
|
916
1016
|
```
|
|
917
1017
|
|
|
1018
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-empty-error.ts#L24)
|
|
1019
|
+
|
|
1020
|
+
###### Returns
|
|
1021
|
+
|
|
1022
|
+
`string`
|
|
1023
|
+
|
|
1024
|
+
###### Set Signature
|
|
1025
|
+
|
|
918
1026
|
```ts
|
|
919
1027
|
set name(_name): void
|
|
920
1028
|
```
|
|
921
1029
|
|
|
922
|
-
|
|
1030
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:29](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-empty-error.ts#L29)
|
|
923
1031
|
|
|
924
|
-
|
|
1032
|
+
###### Parameters
|
|
925
1033
|
|
|
926
|
-
######
|
|
1034
|
+
###### \_name
|
|
927
1035
|
|
|
928
1036
|
`string`
|
|
929
1037
|
|
|
930
|
-
######
|
|
1038
|
+
###### Returns
|
|
931
1039
|
|
|
932
|
-
`
|
|
1040
|
+
`void`
|
|
933
1041
|
|
|
934
|
-
######
|
|
1042
|
+
###### Overrides
|
|
935
1043
|
|
|
936
|
-
|
|
1044
|
+
```ts
|
|
1045
|
+
Error.name
|
|
1046
|
+
```
|
|
937
1047
|
|
|
938
1048
|
#### Methods
|
|
939
1049
|
|
|
@@ -943,13 +1053,19 @@ set name(_name): void
|
|
|
943
1053
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
944
1054
|
```
|
|
945
1055
|
|
|
1056
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
1057
|
+
|
|
946
1058
|
Create .stack property on a target object
|
|
947
1059
|
|
|
948
1060
|
###### Parameters
|
|
949
1061
|
|
|
950
|
-
|
|
1062
|
+
###### targetObject
|
|
1063
|
+
|
|
1064
|
+
`object`
|
|
1065
|
+
|
|
1066
|
+
###### constructorOpt?
|
|
951
1067
|
|
|
952
|
-
|
|
1068
|
+
`Function`
|
|
953
1069
|
|
|
954
1070
|
###### Returns
|
|
955
1071
|
|
|
@@ -957,11 +1073,9 @@ Create .stack property on a target object
|
|
|
957
1073
|
|
|
958
1074
|
###### Inherited from
|
|
959
1075
|
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1076
|
+
```ts
|
|
1077
|
+
Error.captureStackTrace
|
|
1078
|
+
```
|
|
965
1079
|
|
|
966
1080
|
#### Properties
|
|
967
1081
|
|
|
@@ -971,13 +1085,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
971
1085
|
optional cause: unknown;
|
|
972
1086
|
```
|
|
973
1087
|
|
|
974
|
-
|
|
975
|
-
|
|
976
|
-
`Error.cause`
|
|
1088
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
977
1089
|
|
|
978
|
-
######
|
|
1090
|
+
###### Inherited from
|
|
979
1091
|
|
|
980
|
-
|
|
1092
|
+
```ts
|
|
1093
|
+
Error.cause
|
|
1094
|
+
```
|
|
981
1095
|
|
|
982
1096
|
##### message
|
|
983
1097
|
|
|
@@ -985,13 +1099,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
985
1099
|
message: string;
|
|
986
1100
|
```
|
|
987
1101
|
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
`Error.message`
|
|
1102
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
991
1103
|
|
|
992
|
-
######
|
|
1104
|
+
###### Inherited from
|
|
993
1105
|
|
|
994
|
-
|
|
1106
|
+
```ts
|
|
1107
|
+
Error.message
|
|
1108
|
+
```
|
|
995
1109
|
|
|
996
1110
|
##### stack?
|
|
997
1111
|
|
|
@@ -999,13 +1113,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
999
1113
|
optional stack: string;
|
|
1000
1114
|
```
|
|
1001
1115
|
|
|
1002
|
-
|
|
1003
|
-
|
|
1004
|
-
`Error.stack`
|
|
1116
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1005
1117
|
|
|
1006
|
-
######
|
|
1118
|
+
###### Inherited from
|
|
1007
1119
|
|
|
1008
|
-
|
|
1120
|
+
```ts
|
|
1121
|
+
Error.stack
|
|
1122
|
+
```
|
|
1009
1123
|
|
|
1010
1124
|
##### prepareStackTrace()?
|
|
1011
1125
|
|
|
@@ -1013,13 +1127,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1013
1127
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
1014
1128
|
```
|
|
1015
1129
|
|
|
1130
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
1131
|
+
|
|
1016
1132
|
Optional override for formatting stack traces
|
|
1017
1133
|
|
|
1018
1134
|
###### Parameters
|
|
1019
1135
|
|
|
1020
|
-
|
|
1136
|
+
###### err
|
|
1021
1137
|
|
|
1022
|
-
|
|
1138
|
+
`Error`
|
|
1139
|
+
|
|
1140
|
+
###### stackTraces
|
|
1141
|
+
|
|
1142
|
+
`CallSite`[]
|
|
1023
1143
|
|
|
1024
1144
|
###### Returns
|
|
1025
1145
|
|
|
@@ -1031,11 +1151,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1031
1151
|
|
|
1032
1152
|
###### Inherited from
|
|
1033
1153
|
|
|
1034
|
-
|
|
1035
|
-
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1154
|
+
```ts
|
|
1155
|
+
Error.prepareStackTrace
|
|
1156
|
+
```
|
|
1039
1157
|
|
|
1040
1158
|
##### stackTraceLimit
|
|
1041
1159
|
|
|
@@ -1043,18 +1161,20 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
1043
1161
|
static stackTraceLimit: number;
|
|
1044
1162
|
```
|
|
1045
1163
|
|
|
1046
|
-
|
|
1047
|
-
|
|
1048
|
-
`Error.stackTraceLimit`
|
|
1164
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
1049
1165
|
|
|
1050
|
-
######
|
|
1166
|
+
###### Inherited from
|
|
1051
1167
|
|
|
1052
|
-
|
|
1168
|
+
```ts
|
|
1169
|
+
Error.stackTraceLimit
|
|
1170
|
+
```
|
|
1053
1171
|
|
|
1054
|
-
|
|
1172
|
+
***
|
|
1055
1173
|
|
|
1056
1174
|
### NotFoundError
|
|
1057
1175
|
|
|
1176
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-found-error.ts#L4)
|
|
1177
|
+
|
|
1058
1178
|
Error thrown when a file or directory is not found.
|
|
1059
1179
|
|
|
1060
1180
|
#### Extends
|
|
@@ -1069,11 +1189,15 @@ Error thrown when a file or directory is not found.
|
|
|
1069
1189
|
new NotFoundError(message): NotFoundError
|
|
1070
1190
|
```
|
|
1071
1191
|
|
|
1192
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-found-error.ts#L9)
|
|
1193
|
+
|
|
1072
1194
|
Creates a new instance.
|
|
1073
1195
|
|
|
1074
1196
|
###### Parameters
|
|
1075
1197
|
|
|
1076
|
-
|
|
1198
|
+
###### message
|
|
1199
|
+
|
|
1200
|
+
`string`
|
|
1077
1201
|
|
|
1078
1202
|
The error message.
|
|
1079
1203
|
|
|
@@ -1083,61 +1207,81 @@ The error message.
|
|
|
1083
1207
|
|
|
1084
1208
|
###### Overrides
|
|
1085
1209
|
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
[packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-found-error.ts#L9)
|
|
1210
|
+
```ts
|
|
1211
|
+
Error.constructor
|
|
1212
|
+
```
|
|
1091
1213
|
|
|
1092
1214
|
#### Accessors
|
|
1093
1215
|
|
|
1094
1216
|
##### code
|
|
1095
1217
|
|
|
1218
|
+
###### Get Signature
|
|
1219
|
+
|
|
1096
1220
|
```ts
|
|
1097
1221
|
get code(): string
|
|
1098
1222
|
```
|
|
1099
1223
|
|
|
1224
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-found-error.ts#L14)
|
|
1225
|
+
|
|
1226
|
+
###### Returns
|
|
1227
|
+
|
|
1228
|
+
`string`
|
|
1229
|
+
|
|
1230
|
+
###### Set Signature
|
|
1231
|
+
|
|
1100
1232
|
```ts
|
|
1101
1233
|
set code(_name): void
|
|
1102
1234
|
```
|
|
1103
1235
|
|
|
1104
|
-
|
|
1236
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:19](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-found-error.ts#L19)
|
|
1105
1237
|
|
|
1106
|
-
|
|
1238
|
+
###### Parameters
|
|
1107
1239
|
|
|
1108
|
-
######
|
|
1240
|
+
###### \_name
|
|
1109
1241
|
|
|
1110
1242
|
`string`
|
|
1111
1243
|
|
|
1112
|
-
######
|
|
1244
|
+
###### Returns
|
|
1113
1245
|
|
|
1114
|
-
|
|
1246
|
+
`void`
|
|
1115
1247
|
|
|
1116
1248
|
##### name
|
|
1117
1249
|
|
|
1250
|
+
###### Get Signature
|
|
1251
|
+
|
|
1118
1252
|
```ts
|
|
1119
1253
|
get name(): string
|
|
1120
1254
|
```
|
|
1121
1255
|
|
|
1256
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-found-error.ts#L24)
|
|
1257
|
+
|
|
1258
|
+
###### Returns
|
|
1259
|
+
|
|
1260
|
+
`string`
|
|
1261
|
+
|
|
1262
|
+
###### Set Signature
|
|
1263
|
+
|
|
1122
1264
|
```ts
|
|
1123
1265
|
set name(_name): void
|
|
1124
1266
|
```
|
|
1125
1267
|
|
|
1268
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:29](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/not-found-error.ts#L29)
|
|
1269
|
+
|
|
1126
1270
|
###### Parameters
|
|
1127
1271
|
|
|
1128
|
-
|
|
1272
|
+
###### \_name
|
|
1273
|
+
|
|
1274
|
+
`string`
|
|
1129
1275
|
|
|
1130
1276
|
###### Returns
|
|
1131
1277
|
|
|
1132
|
-
`
|
|
1278
|
+
`void`
|
|
1133
1279
|
|
|
1134
1280
|
###### Overrides
|
|
1135
1281
|
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1140
|
-
[packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-found-error.ts#L24)
|
|
1282
|
+
```ts
|
|
1283
|
+
Error.name
|
|
1284
|
+
```
|
|
1141
1285
|
|
|
1142
1286
|
#### Methods
|
|
1143
1287
|
|
|
@@ -1147,13 +1291,19 @@ set name(_name): void
|
|
|
1147
1291
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1148
1292
|
```
|
|
1149
1293
|
|
|
1294
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
1295
|
+
|
|
1150
1296
|
Create .stack property on a target object
|
|
1151
1297
|
|
|
1152
1298
|
###### Parameters
|
|
1153
1299
|
|
|
1154
|
-
|
|
1300
|
+
###### targetObject
|
|
1301
|
+
|
|
1302
|
+
`object`
|
|
1155
1303
|
|
|
1156
|
-
|
|
1304
|
+
###### constructorOpt?
|
|
1305
|
+
|
|
1306
|
+
`Function`
|
|
1157
1307
|
|
|
1158
1308
|
###### Returns
|
|
1159
1309
|
|
|
@@ -1161,11 +1311,9 @@ Create .stack property on a target object
|
|
|
1161
1311
|
|
|
1162
1312
|
###### Inherited from
|
|
1163
1313
|
|
|
1164
|
-
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1314
|
+
```ts
|
|
1315
|
+
Error.captureStackTrace
|
|
1316
|
+
```
|
|
1169
1317
|
|
|
1170
1318
|
#### Properties
|
|
1171
1319
|
|
|
@@ -1175,13 +1323,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
1175
1323
|
optional cause: unknown;
|
|
1176
1324
|
```
|
|
1177
1325
|
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
`Error.cause`
|
|
1326
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1181
1327
|
|
|
1182
|
-
######
|
|
1328
|
+
###### Inherited from
|
|
1183
1329
|
|
|
1184
|
-
|
|
1330
|
+
```ts
|
|
1331
|
+
Error.cause
|
|
1332
|
+
```
|
|
1185
1333
|
|
|
1186
1334
|
##### message
|
|
1187
1335
|
|
|
@@ -1189,13 +1337,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
1189
1337
|
message: string;
|
|
1190
1338
|
```
|
|
1191
1339
|
|
|
1192
|
-
|
|
1193
|
-
|
|
1194
|
-
`Error.message`
|
|
1340
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1195
1341
|
|
|
1196
|
-
######
|
|
1342
|
+
###### Inherited from
|
|
1197
1343
|
|
|
1198
|
-
|
|
1344
|
+
```ts
|
|
1345
|
+
Error.message
|
|
1346
|
+
```
|
|
1199
1347
|
|
|
1200
1348
|
##### stack?
|
|
1201
1349
|
|
|
@@ -1203,13 +1351,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1203
1351
|
optional stack: string;
|
|
1204
1352
|
```
|
|
1205
1353
|
|
|
1206
|
-
|
|
1207
|
-
|
|
1208
|
-
`Error.stack`
|
|
1354
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1209
1355
|
|
|
1210
|
-
######
|
|
1356
|
+
###### Inherited from
|
|
1211
1357
|
|
|
1212
|
-
|
|
1358
|
+
```ts
|
|
1359
|
+
Error.stack
|
|
1360
|
+
```
|
|
1213
1361
|
|
|
1214
1362
|
##### prepareStackTrace()?
|
|
1215
1363
|
|
|
@@ -1217,13 +1365,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1217
1365
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
1218
1366
|
```
|
|
1219
1367
|
|
|
1368
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
1369
|
+
|
|
1220
1370
|
Optional override for formatting stack traces
|
|
1221
1371
|
|
|
1222
1372
|
###### Parameters
|
|
1223
1373
|
|
|
1224
|
-
|
|
1374
|
+
###### err
|
|
1375
|
+
|
|
1376
|
+
`Error`
|
|
1225
1377
|
|
|
1226
|
-
|
|
1378
|
+
###### stackTraces
|
|
1379
|
+
|
|
1380
|
+
`CallSite`[]
|
|
1227
1381
|
|
|
1228
1382
|
###### Returns
|
|
1229
1383
|
|
|
@@ -1235,11 +1389,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1235
1389
|
|
|
1236
1390
|
###### Inherited from
|
|
1237
1391
|
|
|
1238
|
-
|
|
1239
|
-
|
|
1240
|
-
|
|
1241
|
-
|
|
1242
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1392
|
+
```ts
|
|
1393
|
+
Error.prepareStackTrace
|
|
1394
|
+
```
|
|
1243
1395
|
|
|
1244
1396
|
##### stackTraceLimit
|
|
1245
1397
|
|
|
@@ -1247,18 +1399,20 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
1247
1399
|
static stackTraceLimit: number;
|
|
1248
1400
|
```
|
|
1249
1401
|
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
`Error.stackTraceLimit`
|
|
1402
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
1253
1403
|
|
|
1254
|
-
######
|
|
1404
|
+
###### Inherited from
|
|
1255
1405
|
|
|
1256
|
-
|
|
1406
|
+
```ts
|
|
1407
|
+
Error.stackTraceLimit
|
|
1408
|
+
```
|
|
1257
1409
|
|
|
1258
|
-
|
|
1410
|
+
***
|
|
1259
1411
|
|
|
1260
1412
|
### PermissionError
|
|
1261
1413
|
|
|
1414
|
+
Defined in: [packages/fs/src/error/permission-error.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/permission-error.ts#L4)
|
|
1415
|
+
|
|
1262
1416
|
Error thrown when an operation is not permitted.
|
|
1263
1417
|
|
|
1264
1418
|
#### Extends
|
|
@@ -1273,11 +1427,15 @@ Error thrown when an operation is not permitted.
|
|
|
1273
1427
|
new PermissionError(message): PermissionError
|
|
1274
1428
|
```
|
|
1275
1429
|
|
|
1430
|
+
Defined in: [packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/permission-error.ts#L9)
|
|
1431
|
+
|
|
1276
1432
|
Creates a new instance.
|
|
1277
1433
|
|
|
1278
1434
|
###### Parameters
|
|
1279
1435
|
|
|
1280
|
-
|
|
1436
|
+
###### message
|
|
1437
|
+
|
|
1438
|
+
`string`
|
|
1281
1439
|
|
|
1282
1440
|
The error message.
|
|
1283
1441
|
|
|
@@ -1287,61 +1445,81 @@ The error message.
|
|
|
1287
1445
|
|
|
1288
1446
|
###### Overrides
|
|
1289
1447
|
|
|
1290
|
-
|
|
1291
|
-
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
[packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/permission-error.ts#L9)
|
|
1448
|
+
```ts
|
|
1449
|
+
Error.constructor
|
|
1450
|
+
```
|
|
1295
1451
|
|
|
1296
1452
|
#### Accessors
|
|
1297
1453
|
|
|
1298
1454
|
##### code
|
|
1299
1455
|
|
|
1456
|
+
###### Get Signature
|
|
1457
|
+
|
|
1300
1458
|
```ts
|
|
1301
1459
|
get code(): string
|
|
1302
1460
|
```
|
|
1303
1461
|
|
|
1462
|
+
Defined in: [packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/permission-error.ts#L14)
|
|
1463
|
+
|
|
1464
|
+
###### Returns
|
|
1465
|
+
|
|
1466
|
+
`string`
|
|
1467
|
+
|
|
1468
|
+
###### Set Signature
|
|
1469
|
+
|
|
1304
1470
|
```ts
|
|
1305
1471
|
set code(_name): void
|
|
1306
1472
|
```
|
|
1307
1473
|
|
|
1308
|
-
|
|
1474
|
+
Defined in: [packages/fs/src/error/permission-error.ts:19](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/permission-error.ts#L19)
|
|
1309
1475
|
|
|
1310
|
-
|
|
1476
|
+
###### Parameters
|
|
1311
1477
|
|
|
1312
|
-
######
|
|
1478
|
+
###### \_name
|
|
1313
1479
|
|
|
1314
1480
|
`string`
|
|
1315
1481
|
|
|
1316
|
-
######
|
|
1482
|
+
###### Returns
|
|
1317
1483
|
|
|
1318
|
-
|
|
1484
|
+
`void`
|
|
1319
1485
|
|
|
1320
1486
|
##### name
|
|
1321
1487
|
|
|
1488
|
+
###### Get Signature
|
|
1489
|
+
|
|
1322
1490
|
```ts
|
|
1323
1491
|
get name(): string
|
|
1324
1492
|
```
|
|
1325
1493
|
|
|
1494
|
+
Defined in: [packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/permission-error.ts#L24)
|
|
1495
|
+
|
|
1496
|
+
###### Returns
|
|
1497
|
+
|
|
1498
|
+
`string`
|
|
1499
|
+
|
|
1500
|
+
###### Set Signature
|
|
1501
|
+
|
|
1326
1502
|
```ts
|
|
1327
1503
|
set name(_name): void
|
|
1328
1504
|
```
|
|
1329
1505
|
|
|
1330
|
-
|
|
1506
|
+
Defined in: [packages/fs/src/error/permission-error.ts:29](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/permission-error.ts#L29)
|
|
1331
1507
|
|
|
1332
|
-
|
|
1508
|
+
###### Parameters
|
|
1333
1509
|
|
|
1334
|
-
######
|
|
1510
|
+
###### \_name
|
|
1335
1511
|
|
|
1336
1512
|
`string`
|
|
1337
1513
|
|
|
1338
|
-
######
|
|
1514
|
+
###### Returns
|
|
1339
1515
|
|
|
1340
|
-
`
|
|
1516
|
+
`void`
|
|
1341
1517
|
|
|
1342
|
-
######
|
|
1518
|
+
###### Overrides
|
|
1343
1519
|
|
|
1344
|
-
|
|
1520
|
+
```ts
|
|
1521
|
+
Error.name
|
|
1522
|
+
```
|
|
1345
1523
|
|
|
1346
1524
|
#### Methods
|
|
1347
1525
|
|
|
@@ -1351,13 +1529,19 @@ set name(_name): void
|
|
|
1351
1529
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1352
1530
|
```
|
|
1353
1531
|
|
|
1532
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
1533
|
+
|
|
1354
1534
|
Create .stack property on a target object
|
|
1355
1535
|
|
|
1356
1536
|
###### Parameters
|
|
1357
1537
|
|
|
1358
|
-
|
|
1538
|
+
###### targetObject
|
|
1359
1539
|
|
|
1360
|
-
|
|
1540
|
+
`object`
|
|
1541
|
+
|
|
1542
|
+
###### constructorOpt?
|
|
1543
|
+
|
|
1544
|
+
`Function`
|
|
1361
1545
|
|
|
1362
1546
|
###### Returns
|
|
1363
1547
|
|
|
@@ -1365,11 +1549,9 @@ Create .stack property on a target object
|
|
|
1365
1549
|
|
|
1366
1550
|
###### Inherited from
|
|
1367
1551
|
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1371
|
-
|
|
1372
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1552
|
+
```ts
|
|
1553
|
+
Error.captureStackTrace
|
|
1554
|
+
```
|
|
1373
1555
|
|
|
1374
1556
|
#### Properties
|
|
1375
1557
|
|
|
@@ -1379,13 +1561,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
1379
1561
|
optional cause: unknown;
|
|
1380
1562
|
```
|
|
1381
1563
|
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
`Error.cause`
|
|
1564
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1385
1565
|
|
|
1386
|
-
######
|
|
1566
|
+
###### Inherited from
|
|
1387
1567
|
|
|
1388
|
-
|
|
1568
|
+
```ts
|
|
1569
|
+
Error.cause
|
|
1570
|
+
```
|
|
1389
1571
|
|
|
1390
1572
|
##### message
|
|
1391
1573
|
|
|
@@ -1393,13 +1575,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
1393
1575
|
message: string;
|
|
1394
1576
|
```
|
|
1395
1577
|
|
|
1396
|
-
|
|
1397
|
-
|
|
1398
|
-
`Error.message`
|
|
1578
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1399
1579
|
|
|
1400
|
-
######
|
|
1580
|
+
###### Inherited from
|
|
1401
1581
|
|
|
1402
|
-
|
|
1582
|
+
```ts
|
|
1583
|
+
Error.message
|
|
1584
|
+
```
|
|
1403
1585
|
|
|
1404
1586
|
##### stack?
|
|
1405
1587
|
|
|
@@ -1407,13 +1589,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1407
1589
|
optional stack: string;
|
|
1408
1590
|
```
|
|
1409
1591
|
|
|
1410
|
-
|
|
1411
|
-
|
|
1412
|
-
`Error.stack`
|
|
1592
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1413
1593
|
|
|
1414
|
-
######
|
|
1594
|
+
###### Inherited from
|
|
1415
1595
|
|
|
1416
|
-
|
|
1596
|
+
```ts
|
|
1597
|
+
Error.stack
|
|
1598
|
+
```
|
|
1417
1599
|
|
|
1418
1600
|
##### prepareStackTrace()?
|
|
1419
1601
|
|
|
@@ -1421,13 +1603,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1421
1603
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
1422
1604
|
```
|
|
1423
1605
|
|
|
1606
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
1607
|
+
|
|
1424
1608
|
Optional override for formatting stack traces
|
|
1425
1609
|
|
|
1426
1610
|
###### Parameters
|
|
1427
1611
|
|
|
1428
|
-
|
|
1612
|
+
###### err
|
|
1613
|
+
|
|
1614
|
+
`Error`
|
|
1615
|
+
|
|
1616
|
+
###### stackTraces
|
|
1429
1617
|
|
|
1430
|
-
|
|
1618
|
+
`CallSite`[]
|
|
1431
1619
|
|
|
1432
1620
|
###### Returns
|
|
1433
1621
|
|
|
@@ -1439,11 +1627,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1439
1627
|
|
|
1440
1628
|
###### Inherited from
|
|
1441
1629
|
|
|
1442
|
-
|
|
1443
|
-
|
|
1444
|
-
|
|
1445
|
-
|
|
1446
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1630
|
+
```ts
|
|
1631
|
+
Error.prepareStackTrace
|
|
1632
|
+
```
|
|
1447
1633
|
|
|
1448
1634
|
##### stackTraceLimit
|
|
1449
1635
|
|
|
@@ -1451,18 +1637,20 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
1451
1637
|
static stackTraceLimit: number;
|
|
1452
1638
|
```
|
|
1453
1639
|
|
|
1454
|
-
|
|
1455
|
-
|
|
1456
|
-
`Error.stackTraceLimit`
|
|
1640
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
1457
1641
|
|
|
1458
|
-
######
|
|
1642
|
+
###### Inherited from
|
|
1459
1643
|
|
|
1460
|
-
|
|
1644
|
+
```ts
|
|
1645
|
+
Error.stackTraceLimit
|
|
1646
|
+
```
|
|
1461
1647
|
|
|
1462
|
-
|
|
1648
|
+
***
|
|
1463
1649
|
|
|
1464
1650
|
### WalkError
|
|
1465
1651
|
|
|
1652
|
+
Defined in: [packages/fs/src/error/walk-error.ts:7](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/walk-error.ts#L7)
|
|
1653
|
+
|
|
1466
1654
|
Error thrown in walk or walkSync during iteration.
|
|
1467
1655
|
|
|
1468
1656
|
#### Extends
|
|
@@ -1477,13 +1665,19 @@ Error thrown in walk or walkSync during iteration.
|
|
|
1477
1665
|
new WalkError(cause, root): WalkError
|
|
1478
1666
|
```
|
|
1479
1667
|
|
|
1668
|
+
Defined in: [packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/walk-error.ts#L12)
|
|
1669
|
+
|
|
1480
1670
|
Constructs a new instance.
|
|
1481
1671
|
|
|
1482
1672
|
###### Parameters
|
|
1483
1673
|
|
|
1484
|
-
|
|
1674
|
+
###### cause
|
|
1485
1675
|
|
|
1486
|
-
|
|
1676
|
+
`unknown`
|
|
1677
|
+
|
|
1678
|
+
###### root
|
|
1679
|
+
|
|
1680
|
+
`string`
|
|
1487
1681
|
|
|
1488
1682
|
###### Returns
|
|
1489
1683
|
|
|
@@ -1491,39 +1685,49 @@ Constructs a new instance.
|
|
|
1491
1685
|
|
|
1492
1686
|
###### Overrides
|
|
1493
1687
|
|
|
1494
|
-
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
[packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/walk-error.ts#L12)
|
|
1688
|
+
```ts
|
|
1689
|
+
Error.constructor
|
|
1690
|
+
```
|
|
1499
1691
|
|
|
1500
1692
|
#### Accessors
|
|
1501
1693
|
|
|
1502
1694
|
##### name
|
|
1503
1695
|
|
|
1696
|
+
###### Get Signature
|
|
1697
|
+
|
|
1504
1698
|
```ts
|
|
1505
1699
|
get name(): string
|
|
1506
1700
|
```
|
|
1507
1701
|
|
|
1702
|
+
Defined in: [packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/walk-error.ts#L21)
|
|
1703
|
+
|
|
1704
|
+
###### Returns
|
|
1705
|
+
|
|
1706
|
+
`string`
|
|
1707
|
+
|
|
1708
|
+
###### Set Signature
|
|
1709
|
+
|
|
1508
1710
|
```ts
|
|
1509
1711
|
set name(_name): void
|
|
1510
1712
|
```
|
|
1511
1713
|
|
|
1512
|
-
|
|
1714
|
+
Defined in: [packages/fs/src/error/walk-error.ts:26](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/walk-error.ts#L26)
|
|
1513
1715
|
|
|
1514
|
-
|
|
1716
|
+
###### Parameters
|
|
1515
1717
|
|
|
1516
|
-
######
|
|
1718
|
+
###### \_name
|
|
1517
1719
|
|
|
1518
1720
|
`string`
|
|
1519
1721
|
|
|
1520
|
-
######
|
|
1722
|
+
###### Returns
|
|
1521
1723
|
|
|
1522
|
-
`
|
|
1724
|
+
`void`
|
|
1523
1725
|
|
|
1524
|
-
######
|
|
1726
|
+
###### Overrides
|
|
1525
1727
|
|
|
1526
|
-
|
|
1728
|
+
```ts
|
|
1729
|
+
Error.name
|
|
1730
|
+
```
|
|
1527
1731
|
|
|
1528
1732
|
#### Methods
|
|
1529
1733
|
|
|
@@ -1533,13 +1737,19 @@ set name(_name): void
|
|
|
1533
1737
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1534
1738
|
```
|
|
1535
1739
|
|
|
1740
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
1741
|
+
|
|
1536
1742
|
Create .stack property on a target object
|
|
1537
1743
|
|
|
1538
1744
|
###### Parameters
|
|
1539
1745
|
|
|
1540
|
-
|
|
1746
|
+
###### targetObject
|
|
1541
1747
|
|
|
1542
|
-
|
|
1748
|
+
`object`
|
|
1749
|
+
|
|
1750
|
+
###### constructorOpt?
|
|
1751
|
+
|
|
1752
|
+
`Function`
|
|
1543
1753
|
|
|
1544
1754
|
###### Returns
|
|
1545
1755
|
|
|
@@ -1547,11 +1757,9 @@ Create .stack property on a target object
|
|
|
1547
1757
|
|
|
1548
1758
|
###### Inherited from
|
|
1549
1759
|
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
|
|
1553
|
-
|
|
1554
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1760
|
+
```ts
|
|
1761
|
+
Error.captureStackTrace
|
|
1762
|
+
```
|
|
1555
1763
|
|
|
1556
1764
|
#### Properties
|
|
1557
1765
|
|
|
@@ -1561,13 +1769,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
1561
1769
|
optional cause: unknown;
|
|
1562
1770
|
```
|
|
1563
1771
|
|
|
1564
|
-
|
|
1565
|
-
|
|
1566
|
-
`Error.cause`
|
|
1772
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1567
1773
|
|
|
1568
|
-
######
|
|
1774
|
+
###### Inherited from
|
|
1569
1775
|
|
|
1570
|
-
|
|
1776
|
+
```ts
|
|
1777
|
+
Error.cause
|
|
1778
|
+
```
|
|
1571
1779
|
|
|
1572
1780
|
##### message
|
|
1573
1781
|
|
|
@@ -1575,13 +1783,13 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
1575
1783
|
message: string;
|
|
1576
1784
|
```
|
|
1577
1785
|
|
|
1578
|
-
|
|
1579
|
-
|
|
1580
|
-
`Error.message`
|
|
1786
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1581
1787
|
|
|
1582
|
-
######
|
|
1788
|
+
###### Inherited from
|
|
1583
1789
|
|
|
1584
|
-
|
|
1790
|
+
```ts
|
|
1791
|
+
Error.message
|
|
1792
|
+
```
|
|
1585
1793
|
|
|
1586
1794
|
##### root
|
|
1587
1795
|
|
|
@@ -1589,11 +1797,9 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1589
1797
|
root: string;
|
|
1590
1798
|
```
|
|
1591
1799
|
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
###### Defined in
|
|
1800
|
+
Defined in: [packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/walk-error.ts#L9)
|
|
1595
1801
|
|
|
1596
|
-
|
|
1802
|
+
File path of the root that's being walked.
|
|
1597
1803
|
|
|
1598
1804
|
##### stack?
|
|
1599
1805
|
|
|
@@ -1601,13 +1807,13 @@ File path of the root that's being walked.
|
|
|
1601
1807
|
optional stack: string;
|
|
1602
1808
|
```
|
|
1603
1809
|
|
|
1604
|
-
|
|
1605
|
-
|
|
1606
|
-
`Error.stack`
|
|
1810
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1607
1811
|
|
|
1608
|
-
######
|
|
1812
|
+
###### Inherited from
|
|
1609
1813
|
|
|
1610
|
-
|
|
1814
|
+
```ts
|
|
1815
|
+
Error.stack
|
|
1816
|
+
```
|
|
1611
1817
|
|
|
1612
1818
|
##### prepareStackTrace()?
|
|
1613
1819
|
|
|
@@ -1615,13 +1821,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
1615
1821
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
1616
1822
|
```
|
|
1617
1823
|
|
|
1824
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
1825
|
+
|
|
1618
1826
|
Optional override for formatting stack traces
|
|
1619
1827
|
|
|
1620
1828
|
###### Parameters
|
|
1621
1829
|
|
|
1622
|
-
|
|
1830
|
+
###### err
|
|
1831
|
+
|
|
1832
|
+
`Error`
|
|
1623
1833
|
|
|
1624
|
-
|
|
1834
|
+
###### stackTraces
|
|
1835
|
+
|
|
1836
|
+
`CallSite`[]
|
|
1625
1837
|
|
|
1626
1838
|
###### Returns
|
|
1627
1839
|
|
|
@@ -1633,11 +1845,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1633
1845
|
|
|
1634
1846
|
###### Inherited from
|
|
1635
1847
|
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1640
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1848
|
+
```ts
|
|
1849
|
+
Error.prepareStackTrace
|
|
1850
|
+
```
|
|
1641
1851
|
|
|
1642
1852
|
##### stackTraceLimit
|
|
1643
1853
|
|
|
@@ -1645,20 +1855,19 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
1645
1855
|
static stackTraceLimit: number;
|
|
1646
1856
|
```
|
|
1647
1857
|
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
`Error.stackTraceLimit`
|
|
1858
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
1651
1859
|
|
|
1652
|
-
######
|
|
1860
|
+
###### Inherited from
|
|
1653
1861
|
|
|
1654
|
-
|
|
1862
|
+
```ts
|
|
1863
|
+
Error.stackTraceLimit
|
|
1864
|
+
```
|
|
1655
1865
|
|
|
1656
1866
|
## References
|
|
1657
1867
|
|
|
1658
1868
|
### JSONError
|
|
1659
1869
|
|
|
1660
1870
|
Re-exports [JSONError](utils.md#jsonerror)
|
|
1661
|
-
|
|
1662
1871
|
# index
|
|
1663
1872
|
|
|
1664
1873
|
## Functions
|
|
@@ -1666,76 +1875,82 @@ Re-exports [JSONError](utils.md#jsonerror)
|
|
|
1666
1875
|
### collect()
|
|
1667
1876
|
|
|
1668
1877
|
```ts
|
|
1669
|
-
function collect(directory, options): Promise<string[]
|
|
1878
|
+
function collect(directory, options): Promise<string[]>
|
|
1670
1879
|
```
|
|
1671
1880
|
|
|
1881
|
+
Defined in: [packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/find/collect.ts#L4)
|
|
1882
|
+
|
|
1672
1883
|
#### Parameters
|
|
1673
1884
|
|
|
1674
|
-
|
|
1885
|
+
##### directory
|
|
1675
1886
|
|
|
1676
|
-
|
|
1887
|
+
`string`
|
|
1677
1888
|
|
|
1678
|
-
|
|
1889
|
+
##### options
|
|
1679
1890
|
|
|
1680
|
-
`
|
|
1891
|
+
[`WalkOptions`](index.md#walkoptions) = `{}`
|
|
1681
1892
|
|
|
1682
|
-
####
|
|
1893
|
+
#### Returns
|
|
1683
1894
|
|
|
1684
|
-
[
|
|
1895
|
+
`Promise`\<`string`[]\>
|
|
1685
1896
|
|
|
1686
|
-
|
|
1897
|
+
***
|
|
1687
1898
|
|
|
1688
1899
|
### collectSync()
|
|
1689
1900
|
|
|
1690
1901
|
```ts
|
|
1691
|
-
function collectSync(directory, options): string[]
|
|
1902
|
+
function collectSync(directory, options): string[]
|
|
1692
1903
|
```
|
|
1693
1904
|
|
|
1905
|
+
Defined in: [packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/find/collect-sync.ts#L4)
|
|
1906
|
+
|
|
1694
1907
|
#### Parameters
|
|
1695
1908
|
|
|
1696
|
-
|
|
1909
|
+
##### directory
|
|
1697
1910
|
|
|
1698
|
-
|
|
1911
|
+
`string`
|
|
1699
1912
|
|
|
1700
|
-
|
|
1913
|
+
##### options
|
|
1701
1914
|
|
|
1702
|
-
`
|
|
1915
|
+
[`WalkOptions`](index.md#walkoptions) = `{}`
|
|
1703
1916
|
|
|
1704
|
-
####
|
|
1917
|
+
#### Returns
|
|
1705
1918
|
|
|
1706
|
-
[
|
|
1919
|
+
`string`[]
|
|
1707
1920
|
|
|
1708
|
-
|
|
1921
|
+
***
|
|
1709
1922
|
|
|
1710
1923
|
### detect()
|
|
1711
1924
|
|
|
1712
1925
|
```ts
|
|
1713
|
-
function detect(content): "\n" | "\r\n"
|
|
1926
|
+
function detect(content): "\n" | "\r\n"
|
|
1714
1927
|
```
|
|
1715
1928
|
|
|
1929
|
+
Defined in: [packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/eol.ts#L20)
|
|
1930
|
+
|
|
1716
1931
|
Detect the EOL character for string input.
|
|
1717
1932
|
Returns null if no newline.
|
|
1718
1933
|
|
|
1719
1934
|
#### Parameters
|
|
1720
1935
|
|
|
1721
|
-
|
|
1936
|
+
##### content
|
|
1937
|
+
|
|
1938
|
+
`string`
|
|
1722
1939
|
|
|
1723
1940
|
#### Returns
|
|
1724
1941
|
|
|
1725
1942
|
"\n" \| "\r\n"
|
|
1726
1943
|
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
[packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L20)
|
|
1730
|
-
|
|
1731
|
-
---
|
|
1944
|
+
***
|
|
1732
1945
|
|
|
1733
1946
|
### emptyDir()
|
|
1734
1947
|
|
|
1735
1948
|
```ts
|
|
1736
|
-
function emptyDir(dir, options?): Promise<void
|
|
1949
|
+
function emptyDir(dir, options?): Promise<void>
|
|
1737
1950
|
```
|
|
1738
1951
|
|
|
1952
|
+
Defined in: [packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/remove/empty-dir.ts#L19)
|
|
1953
|
+
|
|
1739
1954
|
Ensures that a directory is empty.
|
|
1740
1955
|
Deletes directory contents if the directory is not empty.
|
|
1741
1956
|
If the directory does not exist, it is created.
|
|
@@ -1743,26 +1958,28 @@ The directory itself is not deleted.
|
|
|
1743
1958
|
|
|
1744
1959
|
#### Parameters
|
|
1745
1960
|
|
|
1746
|
-
|
|
1961
|
+
##### dir
|
|
1747
1962
|
|
|
1748
|
-
|
|
1963
|
+
`string` | `URL`
|
|
1749
1964
|
|
|
1750
|
-
|
|
1965
|
+
##### options?
|
|
1751
1966
|
|
|
1752
|
-
`
|
|
1967
|
+
[`EmptyDirOptions`](index.md#emptydiroptions)
|
|
1753
1968
|
|
|
1754
|
-
####
|
|
1969
|
+
#### Returns
|
|
1755
1970
|
|
|
1756
|
-
|
|
1971
|
+
`Promise`\<`void`\>
|
|
1757
1972
|
|
|
1758
|
-
|
|
1973
|
+
***
|
|
1759
1974
|
|
|
1760
1975
|
### emptyDirSync()
|
|
1761
1976
|
|
|
1762
1977
|
```ts
|
|
1763
|
-
function emptyDirSync(dir, options?): void
|
|
1978
|
+
function emptyDirSync(dir, options?): void
|
|
1764
1979
|
```
|
|
1765
1980
|
|
|
1981
|
+
Defined in: [packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/remove/empty-dir-sync.ts#L18)
|
|
1982
|
+
|
|
1766
1983
|
Ensures that a directory is empty.
|
|
1767
1984
|
Deletes directory contents if the directory is not empty.
|
|
1768
1985
|
If the directory does not exist, it is created.
|
|
@@ -1770,185 +1987,200 @@ The directory itself is not deleted.
|
|
|
1770
1987
|
|
|
1771
1988
|
#### Parameters
|
|
1772
1989
|
|
|
1773
|
-
|
|
1990
|
+
##### dir
|
|
1774
1991
|
|
|
1775
|
-
|
|
1992
|
+
`string` | `URL`
|
|
1776
1993
|
|
|
1777
|
-
|
|
1994
|
+
##### options?
|
|
1778
1995
|
|
|
1779
|
-
`
|
|
1996
|
+
[`EmptyDirOptions`](index.md#emptydiroptions)
|
|
1780
1997
|
|
|
1781
|
-
####
|
|
1998
|
+
#### Returns
|
|
1782
1999
|
|
|
1783
|
-
|
|
2000
|
+
`void`
|
|
1784
2001
|
|
|
1785
|
-
|
|
2002
|
+
***
|
|
1786
2003
|
|
|
1787
2004
|
### ensureDir()
|
|
1788
2005
|
|
|
1789
2006
|
```ts
|
|
1790
|
-
function ensureDir(directory): Promise<void
|
|
2007
|
+
function ensureDir(directory): Promise<void>
|
|
1791
2008
|
```
|
|
1792
2009
|
|
|
2010
|
+
Defined in: [packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-dir.ts#L12)
|
|
2011
|
+
|
|
1793
2012
|
Ensures that the directory exists.
|
|
1794
2013
|
If the directory structure does not exist, it is created. Like mkdir -p.
|
|
1795
2014
|
|
|
1796
2015
|
#### Parameters
|
|
1797
2016
|
|
|
1798
|
-
|
|
2017
|
+
##### directory
|
|
2018
|
+
|
|
2019
|
+
`string` | `URL`
|
|
1799
2020
|
|
|
1800
2021
|
#### Returns
|
|
1801
2022
|
|
|
1802
2023
|
`Promise`\<`void`\>
|
|
1803
2024
|
|
|
1804
|
-
|
|
1805
|
-
|
|
1806
|
-
[packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-dir.ts#L12)
|
|
1807
|
-
|
|
1808
|
-
---
|
|
2025
|
+
***
|
|
1809
2026
|
|
|
1810
2027
|
### ensureDirSync()
|
|
1811
2028
|
|
|
1812
2029
|
```ts
|
|
1813
|
-
function ensureDirSync(directory): void
|
|
2030
|
+
function ensureDirSync(directory): void
|
|
1814
2031
|
```
|
|
1815
2032
|
|
|
2033
|
+
Defined in: [packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-dir-sync.ts#L12)
|
|
2034
|
+
|
|
1816
2035
|
Ensures that the directory exists.
|
|
1817
2036
|
If the directory structure does not exist, it is created. Like mkdir -p.
|
|
1818
2037
|
|
|
1819
2038
|
#### Parameters
|
|
1820
2039
|
|
|
1821
|
-
|
|
2040
|
+
##### directory
|
|
2041
|
+
|
|
2042
|
+
`string` | `URL`
|
|
1822
2043
|
|
|
1823
2044
|
#### Returns
|
|
1824
2045
|
|
|
1825
2046
|
`void`
|
|
1826
2047
|
|
|
1827
|
-
|
|
1828
|
-
|
|
1829
|
-
[packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-dir-sync.ts#L12)
|
|
1830
|
-
|
|
1831
|
-
---
|
|
2048
|
+
***
|
|
1832
2049
|
|
|
1833
2050
|
### ensureFile()
|
|
1834
2051
|
|
|
1835
2052
|
```ts
|
|
1836
|
-
function ensureFile(filePath): Promise<void
|
|
2053
|
+
function ensureFile(filePath): Promise<void>
|
|
1837
2054
|
```
|
|
1838
2055
|
|
|
2056
|
+
Defined in: [packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-file.ts#L16)
|
|
2057
|
+
|
|
1839
2058
|
Ensures that the file exists.
|
|
1840
2059
|
If the file that is requested to be created is in directories that do not exist,
|
|
1841
2060
|
these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
1842
2061
|
|
|
1843
2062
|
#### Parameters
|
|
1844
2063
|
|
|
1845
|
-
|
|
2064
|
+
##### filePath
|
|
2065
|
+
|
|
2066
|
+
`string` | `URL`
|
|
1846
2067
|
|
|
1847
2068
|
#### Returns
|
|
1848
2069
|
|
|
1849
2070
|
`Promise`\<`void`\>
|
|
1850
2071
|
|
|
1851
|
-
|
|
1852
|
-
|
|
1853
|
-
[packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-file.ts#L16)
|
|
1854
|
-
|
|
1855
|
-
---
|
|
2072
|
+
***
|
|
1856
2073
|
|
|
1857
2074
|
### ensureFileSync()
|
|
1858
2075
|
|
|
1859
2076
|
```ts
|
|
1860
|
-
function ensureFileSync(filePath): void
|
|
2077
|
+
function ensureFileSync(filePath): void
|
|
1861
2078
|
```
|
|
1862
2079
|
|
|
2080
|
+
Defined in: [packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-file-sync.ts#L16)
|
|
2081
|
+
|
|
1863
2082
|
Ensures that the file exists.
|
|
1864
2083
|
If the file that is requested to be created is in directories that do not exist,
|
|
1865
2084
|
these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
1866
2085
|
|
|
1867
2086
|
#### Parameters
|
|
1868
2087
|
|
|
1869
|
-
|
|
2088
|
+
##### filePath
|
|
2089
|
+
|
|
2090
|
+
`string` | `URL`
|
|
1870
2091
|
|
|
1871
2092
|
#### Returns
|
|
1872
2093
|
|
|
1873
2094
|
`void`
|
|
1874
2095
|
|
|
1875
|
-
|
|
1876
|
-
|
|
1877
|
-
[packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-file-sync.ts#L16)
|
|
1878
|
-
|
|
1879
|
-
---
|
|
2096
|
+
***
|
|
1880
2097
|
|
|
1881
2098
|
### ensureLink()
|
|
1882
2099
|
|
|
1883
2100
|
```ts
|
|
1884
|
-
function ensureLink(source, destination): Promise<void
|
|
2101
|
+
function ensureLink(source, destination): Promise<void>
|
|
1885
2102
|
```
|
|
1886
2103
|
|
|
2104
|
+
Defined in: [packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-link.ts#L15)
|
|
2105
|
+
|
|
1887
2106
|
Ensures that the hard link exists.
|
|
1888
2107
|
If the directory structure does not exist, it is created.
|
|
1889
2108
|
|
|
1890
2109
|
#### Parameters
|
|
1891
2110
|
|
|
1892
|
-
|
|
2111
|
+
##### source
|
|
1893
2112
|
|
|
1894
|
-
|
|
2113
|
+
`string` | `URL`
|
|
1895
2114
|
|
|
1896
|
-
|
|
2115
|
+
##### destination
|
|
1897
2116
|
|
|
1898
|
-
`
|
|
2117
|
+
`string` | `URL`
|
|
1899
2118
|
|
|
1900
|
-
####
|
|
2119
|
+
#### Returns
|
|
1901
2120
|
|
|
1902
|
-
|
|
2121
|
+
`Promise`\<`void`\>
|
|
1903
2122
|
|
|
1904
|
-
|
|
2123
|
+
***
|
|
1905
2124
|
|
|
1906
2125
|
### ensureLinkSync()
|
|
1907
2126
|
|
|
1908
2127
|
```ts
|
|
1909
|
-
function ensureLinkSync(source, destination): void
|
|
2128
|
+
function ensureLinkSync(source, destination): void
|
|
1910
2129
|
```
|
|
1911
2130
|
|
|
2131
|
+
Defined in: [packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-link-sync.ts#L15)
|
|
2132
|
+
|
|
1912
2133
|
Ensures that the hard link exists.
|
|
1913
2134
|
If the directory structure does not exist, it is created.
|
|
1914
2135
|
|
|
1915
2136
|
#### Parameters
|
|
1916
2137
|
|
|
1917
|
-
|
|
2138
|
+
##### source
|
|
1918
2139
|
|
|
1919
|
-
|
|
2140
|
+
`string` | `URL`
|
|
1920
2141
|
|
|
1921
|
-
|
|
2142
|
+
##### destination
|
|
1922
2143
|
|
|
1923
|
-
`
|
|
2144
|
+
`string` | `URL`
|
|
1924
2145
|
|
|
1925
|
-
####
|
|
2146
|
+
#### Returns
|
|
1926
2147
|
|
|
1927
|
-
|
|
2148
|
+
`void`
|
|
1928
2149
|
|
|
1929
|
-
|
|
2150
|
+
***
|
|
1930
2151
|
|
|
1931
2152
|
### ensureSymlink()
|
|
1932
2153
|
|
|
1933
2154
|
```ts
|
|
1934
|
-
function ensureSymlink(
|
|
2155
|
+
function ensureSymlink(
|
|
2156
|
+
target,
|
|
2157
|
+
linkName,
|
|
2158
|
+
type?): Promise<void>
|
|
1935
2159
|
```
|
|
1936
2160
|
|
|
2161
|
+
Defined in: [packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-symlink.ts#L28)
|
|
2162
|
+
|
|
1937
2163
|
Ensures that the link exists, and points to a valid file.
|
|
1938
2164
|
If the directory structure does not exist, it is created.
|
|
1939
2165
|
If the link already exists, it is not modified but error is thrown if it is not point to the given target.
|
|
1940
2166
|
|
|
1941
2167
|
#### Parameters
|
|
1942
2168
|
|
|
1943
|
-
|
|
2169
|
+
##### target
|
|
1944
2170
|
|
|
1945
2171
|
the source file path
|
|
1946
2172
|
|
|
1947
|
-
|
|
2173
|
+
`string` | `URL`
|
|
2174
|
+
|
|
2175
|
+
##### linkName
|
|
1948
2176
|
|
|
1949
2177
|
the destination link path
|
|
1950
2178
|
|
|
1951
|
-
|
|
2179
|
+
`string` | `URL`
|
|
2180
|
+
|
|
2181
|
+
##### type?
|
|
2182
|
+
|
|
2183
|
+
`Type`
|
|
1952
2184
|
|
|
1953
2185
|
the type of the symlink, or null to use automatic detection
|
|
1954
2186
|
|
|
@@ -1958,33 +2190,40 @@ the type of the symlink, or null to use automatic detection
|
|
|
1958
2190
|
|
|
1959
2191
|
A void promise that resolves once the link exists.
|
|
1960
2192
|
|
|
1961
|
-
|
|
1962
|
-
|
|
1963
|
-
[packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-symlink.ts#L28)
|
|
1964
|
-
|
|
1965
|
-
---
|
|
2193
|
+
***
|
|
1966
2194
|
|
|
1967
2195
|
### ensureSymlinkSync()
|
|
1968
2196
|
|
|
1969
2197
|
```ts
|
|
1970
|
-
function ensureSymlinkSync(
|
|
2198
|
+
function ensureSymlinkSync(
|
|
2199
|
+
target,
|
|
2200
|
+
linkName,
|
|
2201
|
+
type?): void
|
|
1971
2202
|
```
|
|
1972
2203
|
|
|
2204
|
+
Defined in: [packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/ensure/ensure-symlink-sync.ts#L28)
|
|
2205
|
+
|
|
1973
2206
|
Ensures that the link exists, and points to a valid file.
|
|
1974
2207
|
If the directory structure does not exist, it is created.
|
|
1975
2208
|
If the link already exists, it is not modified but error is thrown if it is not point to the given target.
|
|
1976
2209
|
|
|
1977
2210
|
#### Parameters
|
|
1978
2211
|
|
|
1979
|
-
|
|
2212
|
+
##### target
|
|
1980
2213
|
|
|
1981
2214
|
the source file path
|
|
1982
2215
|
|
|
1983
|
-
|
|
2216
|
+
`string` | `URL`
|
|
2217
|
+
|
|
2218
|
+
##### linkName
|
|
1984
2219
|
|
|
1985
2220
|
the destination link path
|
|
1986
2221
|
|
|
1987
|
-
|
|
2222
|
+
`string` | `URL`
|
|
2223
|
+
|
|
2224
|
+
##### type?
|
|
2225
|
+
|
|
2226
|
+
`Type`
|
|
1988
2227
|
|
|
1989
2228
|
the type of the symlink, or null to use automatic detection
|
|
1990
2229
|
|
|
@@ -1994,147 +2233,164 @@ the type of the symlink, or null to use automatic detection
|
|
|
1994
2233
|
|
|
1995
2234
|
A void.
|
|
1996
2235
|
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
[packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-symlink-sync.ts#L28)
|
|
2000
|
-
|
|
2001
|
-
---
|
|
2236
|
+
***
|
|
2002
2237
|
|
|
2003
2238
|
### findUp()
|
|
2004
2239
|
|
|
2005
2240
|
```ts
|
|
2006
|
-
function findUp(name, options): Promise<string
|
|
2241
|
+
function findUp(name, options): Promise<string>
|
|
2007
2242
|
```
|
|
2008
2243
|
|
|
2244
|
+
Defined in: [packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/find/find-up.ts#L11)
|
|
2245
|
+
|
|
2009
2246
|
#### Parameters
|
|
2010
2247
|
|
|
2011
|
-
|
|
2248
|
+
##### name
|
|
2012
2249
|
|
|
2013
|
-
|
|
2250
|
+
[`FindUpName`](index.md#findupname)
|
|
2014
2251
|
|
|
2015
|
-
|
|
2252
|
+
##### options
|
|
2016
2253
|
|
|
2017
|
-
`
|
|
2254
|
+
[`FindUpOptions`](index.md#findupoptions) = `{}`
|
|
2018
2255
|
|
|
2019
|
-
####
|
|
2256
|
+
#### Returns
|
|
2020
2257
|
|
|
2021
|
-
|
|
2258
|
+
`Promise`\<`string`\>
|
|
2022
2259
|
|
|
2023
|
-
|
|
2260
|
+
***
|
|
2024
2261
|
|
|
2025
2262
|
### findUpSync()
|
|
2026
2263
|
|
|
2027
2264
|
```ts
|
|
2028
|
-
function findUpSync(name, options): string
|
|
2265
|
+
function findUpSync(name, options): string
|
|
2029
2266
|
```
|
|
2030
2267
|
|
|
2268
|
+
Defined in: [packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/find/find-up-sync.ts#L11)
|
|
2269
|
+
|
|
2031
2270
|
#### Parameters
|
|
2032
2271
|
|
|
2033
|
-
|
|
2272
|
+
##### name
|
|
2034
2273
|
|
|
2035
|
-
|
|
2274
|
+
[`FindUpNameSync`](index.md#findupnamesync)
|
|
2036
2275
|
|
|
2037
|
-
|
|
2276
|
+
##### options
|
|
2038
2277
|
|
|
2039
|
-
`
|
|
2278
|
+
[`FindUpOptions`](index.md#findupoptions) = `{}`
|
|
2040
2279
|
|
|
2041
|
-
####
|
|
2280
|
+
#### Returns
|
|
2042
2281
|
|
|
2043
|
-
|
|
2282
|
+
`string`
|
|
2044
2283
|
|
|
2045
|
-
|
|
2284
|
+
***
|
|
2046
2285
|
|
|
2047
2286
|
### format()
|
|
2048
2287
|
|
|
2049
2288
|
```ts
|
|
2050
|
-
function format(content, eol): string
|
|
2289
|
+
function format(content, eol): string
|
|
2051
2290
|
```
|
|
2052
2291
|
|
|
2292
|
+
Defined in: [packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/eol.ts#L36)
|
|
2293
|
+
|
|
2053
2294
|
Format the file to the targeted EOL.
|
|
2054
2295
|
|
|
2055
2296
|
#### Parameters
|
|
2056
2297
|
|
|
2057
|
-
|
|
2298
|
+
##### content
|
|
2058
2299
|
|
|
2059
|
-
|
|
2300
|
+
`string`
|
|
2060
2301
|
|
|
2061
|
-
|
|
2302
|
+
##### eol
|
|
2062
2303
|
|
|
2063
|
-
|
|
2304
|
+
"\n" | "\r\n"
|
|
2064
2305
|
|
|
2065
|
-
####
|
|
2306
|
+
#### Returns
|
|
2066
2307
|
|
|
2067
|
-
|
|
2308
|
+
`string`
|
|
2068
2309
|
|
|
2069
|
-
|
|
2310
|
+
***
|
|
2070
2311
|
|
|
2071
2312
|
### isAccessible()
|
|
2072
2313
|
|
|
2073
2314
|
```ts
|
|
2074
|
-
function isAccessible(path, mode?): Promise<boolean
|
|
2315
|
+
function isAccessible(path, mode?): Promise<boolean>
|
|
2075
2316
|
```
|
|
2076
2317
|
|
|
2318
|
+
Defined in: [packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/is-accessible.ts#L9)
|
|
2319
|
+
|
|
2077
2320
|
Returns a Promise that resolves to a boolean indicating if the path is accessible or not.
|
|
2078
2321
|
|
|
2079
2322
|
#### Parameters
|
|
2080
2323
|
|
|
2081
|
-
|
|
2324
|
+
##### path
|
|
2082
2325
|
|
|
2083
|
-
|
|
2326
|
+
`string` | `URL`
|
|
2084
2327
|
|
|
2085
|
-
|
|
2328
|
+
##### mode?
|
|
2086
2329
|
|
|
2087
|
-
`
|
|
2330
|
+
`number`
|
|
2088
2331
|
|
|
2089
|
-
####
|
|
2332
|
+
#### Returns
|
|
2090
2333
|
|
|
2091
|
-
|
|
2334
|
+
`Promise`\<`boolean`\>
|
|
2092
2335
|
|
|
2093
|
-
|
|
2336
|
+
***
|
|
2094
2337
|
|
|
2095
2338
|
### isAccessibleSync()
|
|
2096
2339
|
|
|
2097
2340
|
```ts
|
|
2098
|
-
function isAccessibleSync(path, mode?): boolean
|
|
2341
|
+
function isAccessibleSync(path, mode?): boolean
|
|
2099
2342
|
```
|
|
2100
2343
|
|
|
2344
|
+
Defined in: [packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/is-accessible-sync.ts#L9)
|
|
2345
|
+
|
|
2101
2346
|
Returns a boolean indicating if the path is accessible or not.
|
|
2102
2347
|
|
|
2103
2348
|
#### Parameters
|
|
2104
2349
|
|
|
2105
|
-
|
|
2350
|
+
##### path
|
|
2106
2351
|
|
|
2107
|
-
|
|
2352
|
+
`string` | `URL`
|
|
2108
2353
|
|
|
2109
|
-
|
|
2354
|
+
##### mode?
|
|
2110
2355
|
|
|
2111
|
-
`
|
|
2356
|
+
`number`
|
|
2112
2357
|
|
|
2113
|
-
####
|
|
2358
|
+
#### Returns
|
|
2114
2359
|
|
|
2115
|
-
|
|
2360
|
+
`boolean`
|
|
2116
2361
|
|
|
2117
|
-
|
|
2362
|
+
***
|
|
2118
2363
|
|
|
2119
2364
|
### move()
|
|
2120
2365
|
|
|
2121
2366
|
```ts
|
|
2122
|
-
function move(
|
|
2367
|
+
function move(
|
|
2368
|
+
sourcePath,
|
|
2369
|
+
destinationPath,
|
|
2370
|
+
options): Promise<void>
|
|
2123
2371
|
```
|
|
2124
2372
|
|
|
2373
|
+
Defined in: [packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/move/index.ts#L35)
|
|
2374
|
+
|
|
2125
2375
|
Move a file asynchronously.
|
|
2126
2376
|
|
|
2127
2377
|
#### Parameters
|
|
2128
2378
|
|
|
2129
|
-
|
|
2379
|
+
##### sourcePath
|
|
2380
|
+
|
|
2381
|
+
`string`
|
|
2130
2382
|
|
|
2131
2383
|
The file you want to move.
|
|
2132
2384
|
|
|
2133
|
-
|
|
2385
|
+
##### destinationPath
|
|
2386
|
+
|
|
2387
|
+
`string`
|
|
2134
2388
|
|
|
2135
2389
|
Where you want the file moved.
|
|
2136
2390
|
|
|
2137
|
-
|
|
2391
|
+
##### options
|
|
2392
|
+
|
|
2393
|
+
[`MoveOptions`](index.md#moveoptions) = `{}`
|
|
2138
2394
|
|
|
2139
2395
|
Configuration options.
|
|
2140
2396
|
|
|
@@ -2153,31 +2409,38 @@ await moveFile('source/test.png', 'destination/test.png');
|
|
|
2153
2409
|
console.log('The file has been moved');
|
|
2154
2410
|
```
|
|
2155
2411
|
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
[packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L35)
|
|
2159
|
-
|
|
2160
|
-
---
|
|
2412
|
+
***
|
|
2161
2413
|
|
|
2162
2414
|
### moveSync()
|
|
2163
2415
|
|
|
2164
2416
|
```ts
|
|
2165
|
-
function moveSync(
|
|
2417
|
+
function moveSync(
|
|
2418
|
+
sourcePath,
|
|
2419
|
+
destinationPath,
|
|
2420
|
+
options?): void
|
|
2166
2421
|
```
|
|
2167
2422
|
|
|
2423
|
+
Defined in: [packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/move/index.ts#L61)
|
|
2424
|
+
|
|
2168
2425
|
Move a file synchronously.
|
|
2169
2426
|
|
|
2170
2427
|
#### Parameters
|
|
2171
2428
|
|
|
2172
|
-
|
|
2429
|
+
##### sourcePath
|
|
2430
|
+
|
|
2431
|
+
`string`
|
|
2173
2432
|
|
|
2174
2433
|
The file you want to move.
|
|
2175
2434
|
|
|
2176
|
-
|
|
2435
|
+
##### destinationPath
|
|
2436
|
+
|
|
2437
|
+
`string`
|
|
2177
2438
|
|
|
2178
2439
|
Where you want the file moved.
|
|
2179
2440
|
|
|
2180
|
-
|
|
2441
|
+
##### options?
|
|
2442
|
+
|
|
2443
|
+
[`MoveOptions`](index.md#moveoptions)
|
|
2181
2444
|
|
|
2182
2445
|
Configuration options.
|
|
2183
2446
|
|
|
@@ -2196,293 +2459,209 @@ moveFileSync('source/test.png', 'destination/test.png');
|
|
|
2196
2459
|
console.log('The file has been moved');
|
|
2197
2460
|
```
|
|
2198
2461
|
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
-
[packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L61)
|
|
2202
|
-
|
|
2203
|
-
---
|
|
2462
|
+
***
|
|
2204
2463
|
|
|
2205
2464
|
### readFile()
|
|
2206
2465
|
|
|
2207
2466
|
```ts
|
|
2208
|
-
function readFile<O>(path, options?): Promise<ContentType<O
|
|
2467
|
+
function readFile<O>(path, options?): Promise<ContentType<O>>
|
|
2209
2468
|
```
|
|
2210
2469
|
|
|
2470
|
+
Defined in: [packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-file.ts#L20)
|
|
2471
|
+
|
|
2211
2472
|
#### Type Parameters
|
|
2212
2473
|
|
|
2213
|
-
• **O**
|
|
2474
|
+
• **O** *extends* [`ReadFileOptions`](index.md#readfileoptionsc)\<`"brotli"` \| `"gzip"` \| `"none"`\> = `undefined`
|
|
2214
2475
|
|
|
2215
2476
|
#### Parameters
|
|
2216
2477
|
|
|
2217
|
-
|
|
2478
|
+
##### path
|
|
2218
2479
|
|
|
2219
|
-
|
|
2480
|
+
`string` | `URL`
|
|
2220
2481
|
|
|
2221
|
-
|
|
2482
|
+
##### options?
|
|
2222
2483
|
|
|
2223
|
-
`
|
|
2484
|
+
`O`
|
|
2224
2485
|
|
|
2225
|
-
####
|
|
2486
|
+
#### Returns
|
|
2226
2487
|
|
|
2227
|
-
|
|
2488
|
+
`Promise`\<`ContentType`\<`O`\>\>
|
|
2228
2489
|
|
|
2229
|
-
|
|
2490
|
+
***
|
|
2230
2491
|
|
|
2231
2492
|
### readFileSync()
|
|
2232
2493
|
|
|
2233
2494
|
```ts
|
|
2234
|
-
function readFileSync<O>(path, options?): ContentType<O
|
|
2495
|
+
function readFileSync<O>(path, options?): ContentType<O>
|
|
2235
2496
|
```
|
|
2236
2497
|
|
|
2498
|
+
Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-file-sync.ts#L18)
|
|
2499
|
+
|
|
2237
2500
|
#### Type Parameters
|
|
2238
2501
|
|
|
2239
|
-
• **O**
|
|
2502
|
+
• **O** *extends* [`ReadFileOptions`](index.md#readfileoptionsc)\<`"brotli"` \| `"gzip"` \| `"none"`\> = `undefined`
|
|
2240
2503
|
|
|
2241
2504
|
#### Parameters
|
|
2242
2505
|
|
|
2243
|
-
|
|
2506
|
+
##### path
|
|
2244
2507
|
|
|
2245
|
-
|
|
2508
|
+
`string` | `URL`
|
|
2246
2509
|
|
|
2247
|
-
|
|
2510
|
+
##### options?
|
|
2248
2511
|
|
|
2249
|
-
`
|
|
2512
|
+
`O`
|
|
2250
2513
|
|
|
2251
|
-
####
|
|
2514
|
+
#### Returns
|
|
2252
2515
|
|
|
2253
|
-
|
|
2516
|
+
`ContentType`\<`O`\>
|
|
2254
2517
|
|
|
2255
|
-
|
|
2518
|
+
***
|
|
2256
2519
|
|
|
2257
2520
|
### readJson()
|
|
2258
2521
|
|
|
2259
|
-
####
|
|
2522
|
+
#### Call Signature
|
|
2260
2523
|
|
|
2261
2524
|
```ts
|
|
2262
|
-
function readJson<T>(path, options?): Promise<T
|
|
2525
|
+
function readJson<T>(path, options?): Promise<T>
|
|
2263
2526
|
```
|
|
2264
2527
|
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
• **T** _extends_ `JsonValue`
|
|
2268
|
-
|
|
2269
|
-
##### Parameters
|
|
2270
|
-
|
|
2271
|
-
• **path**: `string` \| `URL`
|
|
2272
|
-
|
|
2273
|
-
• **options?**: [`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2274
|
-
|
|
2275
|
-
##### Returns
|
|
2276
|
-
|
|
2277
|
-
`Promise`\<`T`\>
|
|
2278
|
-
|
|
2279
|
-
##### Defined in
|
|
2280
|
-
|
|
2281
|
-
[packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json.ts#L8)
|
|
2282
|
-
|
|
2283
|
-
#### readJson(path, reviver, options)
|
|
2284
|
-
|
|
2285
|
-
```ts
|
|
2286
|
-
function readJson<T>(path, reviver, options?): Promise<T>;
|
|
2287
|
-
```
|
|
2528
|
+
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-json.ts#L8)
|
|
2288
2529
|
|
|
2289
2530
|
##### Type Parameters
|
|
2290
2531
|
|
|
2291
|
-
• **T**
|
|
2532
|
+
• **T** *extends* `JsonValue`
|
|
2292
2533
|
|
|
2293
2534
|
##### Parameters
|
|
2294
2535
|
|
|
2295
|
-
|
|
2536
|
+
###### path
|
|
2296
2537
|
|
|
2297
|
-
|
|
2538
|
+
`string` | `URL`
|
|
2298
2539
|
|
|
2299
|
-
|
|
2540
|
+
###### options?
|
|
2541
|
+
|
|
2542
|
+
[`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2300
2543
|
|
|
2301
2544
|
##### Returns
|
|
2302
2545
|
|
|
2303
2546
|
`Promise`\<`T`\>
|
|
2304
2547
|
|
|
2305
|
-
|
|
2306
|
-
|
|
2307
|
-
[packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json.ts#L10)
|
|
2308
|
-
|
|
2309
|
-
---
|
|
2310
|
-
|
|
2311
|
-
### readJsonSync()
|
|
2312
|
-
|
|
2313
|
-
#### readJsonSync(path, options)
|
|
2548
|
+
#### Call Signature
|
|
2314
2549
|
|
|
2315
2550
|
```ts
|
|
2316
|
-
function
|
|
2551
|
+
function readJson<T>(
|
|
2552
|
+
path,
|
|
2553
|
+
reviver,
|
|
2554
|
+
options?): Promise<T>
|
|
2317
2555
|
```
|
|
2318
2556
|
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
• **T** _extends_ `JsonValue`
|
|
2322
|
-
|
|
2323
|
-
##### Parameters
|
|
2324
|
-
|
|
2325
|
-
• **path**: `string` \| `URL`
|
|
2326
|
-
|
|
2327
|
-
• **options?**: [`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2328
|
-
|
|
2329
|
-
##### Returns
|
|
2330
|
-
|
|
2331
|
-
`T`
|
|
2332
|
-
|
|
2333
|
-
##### Defined in
|
|
2334
|
-
|
|
2335
|
-
[packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json-sync.ts#L8)
|
|
2336
|
-
|
|
2337
|
-
#### readJsonSync(path, reviver, options)
|
|
2338
|
-
|
|
2339
|
-
```ts
|
|
2340
|
-
function readJsonSync<T>(path, reviver, options?): T;
|
|
2341
|
-
```
|
|
2557
|
+
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-json.ts#L10)
|
|
2342
2558
|
|
|
2343
2559
|
##### Type Parameters
|
|
2344
2560
|
|
|
2345
|
-
• **T**
|
|
2561
|
+
• **T** *extends* `JsonValue`
|
|
2346
2562
|
|
|
2347
2563
|
##### Parameters
|
|
2348
2564
|
|
|
2349
|
-
|
|
2350
|
-
|
|
2351
|
-
• **reviver**
|
|
2352
|
-
|
|
2353
|
-
• **options?**: [`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2354
|
-
|
|
2355
|
-
##### Returns
|
|
2356
|
-
|
|
2357
|
-
`T`
|
|
2358
|
-
|
|
2359
|
-
##### Defined in
|
|
2565
|
+
###### path
|
|
2360
2566
|
|
|
2361
|
-
|
|
2567
|
+
`string` | `URL`
|
|
2362
2568
|
|
|
2363
|
-
|
|
2364
|
-
|
|
2365
|
-
### readYaml()
|
|
2366
|
-
|
|
2367
|
-
#### readYaml(path, options)
|
|
2368
|
-
|
|
2369
|
-
```ts
|
|
2370
|
-
function readYaml<R>(path, options?): Promise<R>;
|
|
2371
|
-
```
|
|
2372
|
-
|
|
2373
|
-
##### Type Parameters
|
|
2374
|
-
|
|
2375
|
-
• **R** = `Record`\<`string`, `unknown`\>
|
|
2569
|
+
###### reviver
|
|
2376
2570
|
|
|
2377
|
-
|
|
2571
|
+
(`this`, `key`, `value`) => `any`
|
|
2378
2572
|
|
|
2379
|
-
|
|
2573
|
+
###### options?
|
|
2380
2574
|
|
|
2381
|
-
|
|
2575
|
+
[`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2382
2576
|
|
|
2383
2577
|
##### Returns
|
|
2384
2578
|
|
|
2385
|
-
`Promise`\<`
|
|
2579
|
+
`Promise`\<`T`\>
|
|
2386
2580
|
|
|
2387
|
-
|
|
2581
|
+
***
|
|
2388
2582
|
|
|
2389
|
-
|
|
2583
|
+
### readJsonSync()
|
|
2390
2584
|
|
|
2391
|
-
####
|
|
2585
|
+
#### Call Signature
|
|
2392
2586
|
|
|
2393
2587
|
```ts
|
|
2394
|
-
function
|
|
2588
|
+
function readJsonSync<T>(path, options?): T
|
|
2395
2589
|
```
|
|
2396
2590
|
|
|
2591
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-json-sync.ts#L8)
|
|
2592
|
+
|
|
2397
2593
|
##### Type Parameters
|
|
2398
2594
|
|
|
2399
|
-
• **
|
|
2595
|
+
• **T** *extends* `JsonValue`
|
|
2400
2596
|
|
|
2401
2597
|
##### Parameters
|
|
2402
2598
|
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
• **reviver?**: `YamlReviver`
|
|
2406
|
-
|
|
2407
|
-
• **options?**: `ReadYamlOptions`\<`"brotli"` \| `"gzip"` \| `"none"`\>
|
|
2408
|
-
|
|
2409
|
-
##### Returns
|
|
2599
|
+
###### path
|
|
2410
2600
|
|
|
2411
|
-
`
|
|
2601
|
+
`string` | `URL`
|
|
2412
2602
|
|
|
2413
|
-
|
|
2603
|
+
###### options?
|
|
2414
2604
|
|
|
2415
|
-
[
|
|
2605
|
+
[`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2416
2606
|
|
|
2417
|
-
|
|
2607
|
+
##### Returns
|
|
2418
2608
|
|
|
2419
|
-
|
|
2609
|
+
`T`
|
|
2420
2610
|
|
|
2421
|
-
####
|
|
2611
|
+
#### Call Signature
|
|
2422
2612
|
|
|
2423
2613
|
```ts
|
|
2424
|
-
function
|
|
2614
|
+
function readJsonSync<T>(
|
|
2615
|
+
path,
|
|
2616
|
+
reviver,
|
|
2617
|
+
options?): T
|
|
2425
2618
|
```
|
|
2426
2619
|
|
|
2620
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-json-sync.ts#L10)
|
|
2621
|
+
|
|
2427
2622
|
##### Type Parameters
|
|
2428
2623
|
|
|
2429
|
-
• **
|
|
2624
|
+
• **T** *extends* `JsonValue`
|
|
2430
2625
|
|
|
2431
2626
|
##### Parameters
|
|
2432
2627
|
|
|
2433
|
-
|
|
2434
|
-
|
|
2435
|
-
• **options?**: `ReadYamlOptions`\<`"brotli"` \| `"gzip"` \| `"none"`\>
|
|
2436
|
-
|
|
2437
|
-
##### Returns
|
|
2438
|
-
|
|
2439
|
-
`R`
|
|
2440
|
-
|
|
2441
|
-
##### Defined in
|
|
2442
|
-
|
|
2443
|
-
[packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
2444
|
-
|
|
2445
|
-
#### readYamlSync(path, reviver, options)
|
|
2446
|
-
|
|
2447
|
-
```ts
|
|
2448
|
-
function readYamlSync<R>(path, reviver?, options?): R;
|
|
2449
|
-
```
|
|
2450
|
-
|
|
2451
|
-
##### Type Parameters
|
|
2628
|
+
###### path
|
|
2452
2629
|
|
|
2453
|
-
|
|
2630
|
+
`string` | `URL`
|
|
2454
2631
|
|
|
2455
|
-
|
|
2632
|
+
###### reviver
|
|
2456
2633
|
|
|
2457
|
-
|
|
2634
|
+
(`this`, `key`, `value`) => `any`
|
|
2458
2635
|
|
|
2459
|
-
|
|
2636
|
+
###### options?
|
|
2460
2637
|
|
|
2461
|
-
|
|
2638
|
+
[`ReadJsonOptions`](index.md#readjsonoptions)
|
|
2462
2639
|
|
|
2463
2640
|
##### Returns
|
|
2464
2641
|
|
|
2465
|
-
`
|
|
2466
|
-
|
|
2467
|
-
##### Defined in
|
|
2468
|
-
|
|
2469
|
-
[packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
2642
|
+
`T`
|
|
2470
2643
|
|
|
2471
|
-
|
|
2644
|
+
***
|
|
2472
2645
|
|
|
2473
2646
|
### remove()
|
|
2474
2647
|
|
|
2475
2648
|
```ts
|
|
2476
|
-
function remove(path, options): Promise<void
|
|
2649
|
+
function remove(path, options): Promise<void>
|
|
2477
2650
|
```
|
|
2478
2651
|
|
|
2652
|
+
Defined in: [packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/remove/remove.ts#L5)
|
|
2653
|
+
|
|
2479
2654
|
#### Parameters
|
|
2480
2655
|
|
|
2481
|
-
|
|
2656
|
+
##### path
|
|
2657
|
+
|
|
2658
|
+
`string` | `URL`
|
|
2659
|
+
|
|
2660
|
+
##### options
|
|
2482
2661
|
|
|
2483
|
-
|
|
2662
|
+
###### maxRetries
|
|
2484
2663
|
|
|
2485
|
-
|
|
2664
|
+
`number`
|
|
2486
2665
|
|
|
2487
2666
|
If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
|
|
2488
2667
|
`EPERM` error is encountered, Node.js will retry the operation with a linear
|
|
@@ -2493,10 +2672,12 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
2493
2672
|
**Default**
|
|
2494
2673
|
|
|
2495
2674
|
```ts
|
|
2496
|
-
0
|
|
2675
|
+
0
|
|
2497
2676
|
```
|
|
2498
2677
|
|
|
2499
|
-
|
|
2678
|
+
###### retryDelay
|
|
2679
|
+
|
|
2680
|
+
`number`
|
|
2500
2681
|
|
|
2501
2682
|
The amount of time in milliseconds to wait between retries.
|
|
2502
2683
|
This option is ignored if the `recursive` option is not `true`.
|
|
@@ -2504,32 +2685,34 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2504
2685
|
**Default**
|
|
2505
2686
|
|
|
2506
2687
|
```ts
|
|
2507
|
-
100
|
|
2688
|
+
100
|
|
2508
2689
|
```
|
|
2509
2690
|
|
|
2510
2691
|
#### Returns
|
|
2511
2692
|
|
|
2512
2693
|
`Promise`\<`void`\>
|
|
2513
2694
|
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
[packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/remove/remove.ts#L5)
|
|
2517
|
-
|
|
2518
|
-
---
|
|
2695
|
+
***
|
|
2519
2696
|
|
|
2520
2697
|
### removeSync()
|
|
2521
2698
|
|
|
2522
2699
|
```ts
|
|
2523
|
-
function removeSync(path, options): void
|
|
2700
|
+
function removeSync(path, options): void
|
|
2524
2701
|
```
|
|
2525
2702
|
|
|
2703
|
+
Defined in: [packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/remove/remove-sync.ts#L5)
|
|
2704
|
+
|
|
2526
2705
|
#### Parameters
|
|
2527
2706
|
|
|
2528
|
-
|
|
2707
|
+
##### path
|
|
2708
|
+
|
|
2709
|
+
`string` | `URL`
|
|
2710
|
+
|
|
2711
|
+
##### options
|
|
2529
2712
|
|
|
2530
|
-
|
|
2713
|
+
###### maxRetries
|
|
2531
2714
|
|
|
2532
|
-
|
|
2715
|
+
`number`
|
|
2533
2716
|
|
|
2534
2717
|
If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
|
|
2535
2718
|
`EPERM` error is encountered, Node.js will retry the operation with a linear
|
|
@@ -2540,10 +2723,12 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
2540
2723
|
**Default**
|
|
2541
2724
|
|
|
2542
2725
|
```ts
|
|
2543
|
-
0
|
|
2726
|
+
0
|
|
2544
2727
|
```
|
|
2545
2728
|
|
|
2546
|
-
|
|
2729
|
+
###### retryDelay
|
|
2730
|
+
|
|
2731
|
+
`number`
|
|
2547
2732
|
|
|
2548
2733
|
The amount of time in milliseconds to wait between retries.
|
|
2549
2734
|
This option is ignored if the `recursive` option is not `true`.
|
|
@@ -2551,38 +2736,45 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2551
2736
|
**Default**
|
|
2552
2737
|
|
|
2553
2738
|
```ts
|
|
2554
|
-
100
|
|
2739
|
+
100
|
|
2555
2740
|
```
|
|
2556
2741
|
|
|
2557
2742
|
#### Returns
|
|
2558
2743
|
|
|
2559
2744
|
`void`
|
|
2560
2745
|
|
|
2561
|
-
|
|
2562
|
-
|
|
2563
|
-
[packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/remove/remove-sync.ts#L5)
|
|
2564
|
-
|
|
2565
|
-
---
|
|
2746
|
+
***
|
|
2566
2747
|
|
|
2567
2748
|
### rename()
|
|
2568
2749
|
|
|
2569
2750
|
```ts
|
|
2570
|
-
function rename(
|
|
2751
|
+
function rename(
|
|
2752
|
+
source,
|
|
2753
|
+
destination,
|
|
2754
|
+
options?): Promise<void>
|
|
2571
2755
|
```
|
|
2572
2756
|
|
|
2757
|
+
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/move/index.ts#L85)
|
|
2758
|
+
|
|
2573
2759
|
Rename a file asynchronously.
|
|
2574
2760
|
|
|
2575
2761
|
#### Parameters
|
|
2576
2762
|
|
|
2577
|
-
|
|
2763
|
+
##### source
|
|
2764
|
+
|
|
2765
|
+
`string`
|
|
2578
2766
|
|
|
2579
2767
|
The file you want to rename.
|
|
2580
2768
|
|
|
2581
|
-
|
|
2769
|
+
##### destination
|
|
2770
|
+
|
|
2771
|
+
`string`
|
|
2582
2772
|
|
|
2583
2773
|
The name of the renamed file.
|
|
2584
2774
|
|
|
2585
|
-
|
|
2775
|
+
##### options?
|
|
2776
|
+
|
|
2777
|
+
[`MoveOptions`](index.md#moveoptions)
|
|
2586
2778
|
|
|
2587
2779
|
Configuration options.
|
|
2588
2780
|
|
|
@@ -2601,31 +2793,38 @@ await renameFile('test.png', 'tests.png', {cwd: 'source'});
|
|
|
2601
2793
|
console.log('The file has been renamed');
|
|
2602
2794
|
```
|
|
2603
2795
|
|
|
2604
|
-
|
|
2605
|
-
|
|
2606
|
-
[packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L85)
|
|
2607
|
-
|
|
2608
|
-
---
|
|
2796
|
+
***
|
|
2609
2797
|
|
|
2610
2798
|
### renameSync()
|
|
2611
2799
|
|
|
2612
2800
|
```ts
|
|
2613
|
-
function renameSync(
|
|
2801
|
+
function renameSync(
|
|
2802
|
+
source,
|
|
2803
|
+
destination,
|
|
2804
|
+
options?): void
|
|
2614
2805
|
```
|
|
2615
2806
|
|
|
2807
|
+
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/move/index.ts#L109)
|
|
2808
|
+
|
|
2616
2809
|
Rename a file synchronously.
|
|
2617
2810
|
|
|
2618
2811
|
#### Parameters
|
|
2619
2812
|
|
|
2620
|
-
|
|
2813
|
+
##### source
|
|
2814
|
+
|
|
2815
|
+
`string`
|
|
2621
2816
|
|
|
2622
2817
|
The file you want to rename.
|
|
2623
2818
|
|
|
2624
|
-
|
|
2819
|
+
##### destination
|
|
2820
|
+
|
|
2821
|
+
`string`
|
|
2625
2822
|
|
|
2626
2823
|
The name of the renamed file.
|
|
2627
2824
|
|
|
2628
|
-
|
|
2825
|
+
##### options?
|
|
2826
|
+
|
|
2827
|
+
[`MoveOptions`](index.md#moveoptions)
|
|
2629
2828
|
|
|
2630
2829
|
Configuration options.
|
|
2631
2830
|
|
|
@@ -2644,22 +2843,19 @@ renameFileSync('test.png', 'tests.png', {cwd: 'source'});
|
|
|
2644
2843
|
console.log('The file has been renamed');
|
|
2645
2844
|
```
|
|
2646
2845
|
|
|
2647
|
-
|
|
2648
|
-
|
|
2649
|
-
[packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L109)
|
|
2650
|
-
|
|
2651
|
-
---
|
|
2846
|
+
***
|
|
2652
2847
|
|
|
2653
2848
|
### walk()
|
|
2654
2849
|
|
|
2655
2850
|
```ts
|
|
2656
|
-
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry
|
|
2851
|
+
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry>
|
|
2657
2852
|
```
|
|
2658
2853
|
|
|
2854
|
+
Defined in: [packages/fs/src/find/walk.ts:52](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/find/walk.ts#L52)
|
|
2855
|
+
|
|
2659
2856
|
Walks the file tree rooted at root, yielding each file or directory in the
|
|
2660
2857
|
tree filtered according to the given options.
|
|
2661
2858
|
Options:
|
|
2662
|
-
|
|
2663
2859
|
- maxDepth?: number = Infinity;
|
|
2664
2860
|
- includeFiles?: boolean = true;
|
|
2665
2861
|
- includeDirs?: boolean = true;
|
|
@@ -2671,293 +2867,215 @@ Options:
|
|
|
2671
2867
|
|
|
2672
2868
|
#### Parameters
|
|
2673
2869
|
|
|
2674
|
-
|
|
2870
|
+
##### directory
|
|
2675
2871
|
|
|
2676
|
-
|
|
2872
|
+
`string` | `URL`
|
|
2677
2873
|
|
|
2678
|
-
|
|
2874
|
+
##### \_\_namedParameters
|
|
2679
2875
|
|
|
2680
|
-
|
|
2876
|
+
[`WalkOptions`](index.md#walkoptions) = `{}`
|
|
2681
2877
|
|
|
2682
|
-
####
|
|
2878
|
+
#### Returns
|
|
2683
2879
|
|
|
2684
|
-
[
|
|
2880
|
+
`AsyncIterableIterator`\<[`WalkEntry`](index.md#walkentry)\>
|
|
2685
2881
|
|
|
2686
|
-
|
|
2882
|
+
***
|
|
2687
2883
|
|
|
2688
2884
|
### walkSync()
|
|
2689
2885
|
|
|
2690
2886
|
```ts
|
|
2691
|
-
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry
|
|
2887
|
+
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry>
|
|
2692
2888
|
```
|
|
2693
2889
|
|
|
2890
|
+
Defined in: [packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/find/walk-sync.ts#L40)
|
|
2891
|
+
|
|
2694
2892
|
Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
2695
2893
|
|
|
2696
2894
|
#### Parameters
|
|
2697
2895
|
|
|
2698
|
-
|
|
2896
|
+
##### directory
|
|
2699
2897
|
|
|
2700
|
-
|
|
2898
|
+
`string` | `URL`
|
|
2701
2899
|
|
|
2702
|
-
|
|
2900
|
+
##### \_\_namedParameters
|
|
2703
2901
|
|
|
2704
|
-
|
|
2902
|
+
[`WalkOptions`](index.md#walkoptions) = `{}`
|
|
2705
2903
|
|
|
2706
|
-
####
|
|
2904
|
+
#### Returns
|
|
2707
2905
|
|
|
2708
|
-
[
|
|
2906
|
+
`IterableIterator`\<[`WalkEntry`](index.md#walkentry)\>
|
|
2709
2907
|
|
|
2710
|
-
|
|
2908
|
+
***
|
|
2711
2909
|
|
|
2712
2910
|
### writeFile()
|
|
2713
2911
|
|
|
2714
2912
|
```ts
|
|
2715
|
-
function writeFile(
|
|
2913
|
+
function writeFile(
|
|
2914
|
+
path,
|
|
2915
|
+
content,
|
|
2916
|
+
options?): Promise<void>
|
|
2716
2917
|
```
|
|
2717
2918
|
|
|
2919
|
+
Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-file.ts#L15)
|
|
2920
|
+
|
|
2718
2921
|
#### Parameters
|
|
2719
2922
|
|
|
2720
|
-
|
|
2923
|
+
##### path
|
|
2721
2924
|
|
|
2722
|
-
|
|
2925
|
+
`string` | `URL`
|
|
2723
2926
|
|
|
2724
|
-
|
|
2927
|
+
##### content
|
|
2725
2928
|
|
|
2726
|
-
|
|
2929
|
+
`string` | `ArrayBuffer` | `ArrayBufferView`
|
|
2727
2930
|
|
|
2728
|
-
|
|
2931
|
+
##### options?
|
|
2932
|
+
|
|
2933
|
+
[`WriteFileOptions`](index.md#writefileoptions)
|
|
2729
2934
|
|
|
2730
|
-
####
|
|
2935
|
+
#### Returns
|
|
2731
2936
|
|
|
2732
|
-
|
|
2937
|
+
`Promise`\<`void`\>
|
|
2733
2938
|
|
|
2734
|
-
|
|
2939
|
+
***
|
|
2735
2940
|
|
|
2736
2941
|
### writeFileSync()
|
|
2737
2942
|
|
|
2738
2943
|
```ts
|
|
2739
|
-
function writeFileSync(
|
|
2944
|
+
function writeFileSync(
|
|
2945
|
+
path,
|
|
2946
|
+
content,
|
|
2947
|
+
options?): void
|
|
2740
2948
|
```
|
|
2741
2949
|
|
|
2950
|
+
Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-file-sync.ts#L15)
|
|
2951
|
+
|
|
2742
2952
|
#### Parameters
|
|
2743
2953
|
|
|
2744
|
-
|
|
2954
|
+
##### path
|
|
2745
2955
|
|
|
2746
|
-
|
|
2956
|
+
`string` | `URL`
|
|
2747
2957
|
|
|
2748
|
-
|
|
2958
|
+
##### content
|
|
2749
2959
|
|
|
2750
|
-
|
|
2960
|
+
`string` | `ArrayBuffer` | `ArrayBufferView`
|
|
2751
2961
|
|
|
2752
|
-
|
|
2962
|
+
##### options?
|
|
2963
|
+
|
|
2964
|
+
[`WriteFileOptions`](index.md#writefileoptions)
|
|
2753
2965
|
|
|
2754
|
-
####
|
|
2966
|
+
#### Returns
|
|
2755
2967
|
|
|
2756
|
-
|
|
2968
|
+
`void`
|
|
2757
2969
|
|
|
2758
|
-
|
|
2970
|
+
***
|
|
2759
2971
|
|
|
2760
2972
|
### writeJson()
|
|
2761
2973
|
|
|
2762
2974
|
```ts
|
|
2763
|
-
function writeJson(
|
|
2975
|
+
function writeJson(
|
|
2976
|
+
path,
|
|
2977
|
+
data,
|
|
2978
|
+
options): Promise<void>
|
|
2764
2979
|
```
|
|
2765
2980
|
|
|
2981
|
+
Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-json.ts#L11)
|
|
2982
|
+
|
|
2766
2983
|
#### Parameters
|
|
2767
2984
|
|
|
2768
|
-
|
|
2985
|
+
##### path
|
|
2769
2986
|
|
|
2770
|
-
|
|
2987
|
+
`string` | `URL`
|
|
2771
2988
|
|
|
2772
|
-
|
|
2989
|
+
##### data
|
|
2773
2990
|
|
|
2774
|
-
|
|
2991
|
+
`unknown`
|
|
2775
2992
|
|
|
2776
|
-
|
|
2993
|
+
##### options
|
|
2994
|
+
|
|
2995
|
+
[`WriteJsonOptions`](index.md#writejsonoptions) = `{}`
|
|
2777
2996
|
|
|
2778
|
-
####
|
|
2997
|
+
#### Returns
|
|
2779
2998
|
|
|
2780
|
-
|
|
2999
|
+
`Promise`\<`void`\>
|
|
2781
3000
|
|
|
2782
|
-
|
|
3001
|
+
***
|
|
2783
3002
|
|
|
2784
3003
|
### writeJsonSync()
|
|
2785
3004
|
|
|
2786
3005
|
```ts
|
|
2787
|
-
function writeJsonSync(
|
|
3006
|
+
function writeJsonSync(
|
|
3007
|
+
path,
|
|
3008
|
+
data,
|
|
3009
|
+
options): void
|
|
2788
3010
|
```
|
|
2789
3011
|
|
|
3012
|
+
Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-json-sync.ts#L11)
|
|
3013
|
+
|
|
2790
3014
|
#### Parameters
|
|
2791
3015
|
|
|
2792
|
-
|
|
3016
|
+
##### path
|
|
2793
3017
|
|
|
2794
|
-
|
|
3018
|
+
`string` | `URL`
|
|
2795
3019
|
|
|
2796
|
-
|
|
3020
|
+
##### data
|
|
2797
3021
|
|
|
2798
|
-
|
|
3022
|
+
`unknown`
|
|
2799
3023
|
|
|
2800
|
-
|
|
3024
|
+
##### options
|
|
2801
3025
|
|
|
2802
|
-
|
|
3026
|
+
[`WriteJsonOptions`](index.md#writejsonoptions) = `{}`
|
|
2803
3027
|
|
|
2804
|
-
|
|
3028
|
+
#### Returns
|
|
2805
3029
|
|
|
2806
|
-
|
|
3030
|
+
`void`
|
|
2807
3031
|
|
|
2808
|
-
|
|
3032
|
+
## Variables
|
|
2809
3033
|
|
|
2810
|
-
|
|
3034
|
+
### CRLF
|
|
2811
3035
|
|
|
2812
3036
|
```ts
|
|
2813
|
-
|
|
3037
|
+
const CRLF: "\r\n";
|
|
2814
3038
|
```
|
|
2815
3039
|
|
|
2816
|
-
|
|
3040
|
+
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/eol.ts#L9)
|
|
2817
3041
|
|
|
2818
|
-
|
|
3042
|
+
End-of-line character for Windows platforms.
|
|
2819
3043
|
|
|
2820
|
-
|
|
3044
|
+
***
|
|
2821
3045
|
|
|
2822
|
-
|
|
3046
|
+
### EOL
|
|
2823
3047
|
|
|
2824
|
-
|
|
3048
|
+
```ts
|
|
3049
|
+
const EOL: "\n" | "\r\n";
|
|
3050
|
+
```
|
|
2825
3051
|
|
|
2826
|
-
|
|
3052
|
+
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/eol.ts#L14)
|
|
2827
3053
|
|
|
2828
|
-
|
|
3054
|
+
End-of-line character evaluated for the current platform.
|
|
2829
3055
|
|
|
2830
|
-
|
|
3056
|
+
***
|
|
2831
3057
|
|
|
2832
|
-
|
|
3058
|
+
### F\_OK
|
|
2833
3059
|
|
|
2834
3060
|
```ts
|
|
2835
|
-
|
|
3061
|
+
const F_OK: 0 = 0;
|
|
2836
3062
|
```
|
|
2837
3063
|
|
|
2838
|
-
|
|
2839
|
-
|
|
2840
|
-
• **path**: `string` \| `URL`
|
|
3064
|
+
Defined in: [packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/constants.ts#L2)
|
|
2841
3065
|
|
|
2842
|
-
|
|
3066
|
+
Is the path visible to the calling process?
|
|
2843
3067
|
|
|
2844
|
-
|
|
3068
|
+
***
|
|
2845
3069
|
|
|
2846
|
-
|
|
2847
|
-
|
|
2848
|
-
##### Returns
|
|
2849
|
-
|
|
2850
|
-
`Promise`\<`void`\>
|
|
2851
|
-
|
|
2852
|
-
##### Defined in
|
|
2853
|
-
|
|
2854
|
-
[packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml.ts#L16)
|
|
2855
|
-
|
|
2856
|
-
---
|
|
2857
|
-
|
|
2858
|
-
### writeYamlSync()
|
|
2859
|
-
|
|
2860
|
-
#### writeYamlSync(path, data, options)
|
|
2861
|
-
|
|
2862
|
-
```ts
|
|
2863
|
-
function writeYamlSync(path, data, options?): void;
|
|
2864
|
-
```
|
|
2865
|
-
|
|
2866
|
-
##### Parameters
|
|
2867
|
-
|
|
2868
|
-
• **path**: `string` \| `URL`
|
|
2869
|
-
|
|
2870
|
-
• **data**: `any`
|
|
2871
|
-
|
|
2872
|
-
• **options?**: `Options`
|
|
2873
|
-
|
|
2874
|
-
##### Returns
|
|
2875
|
-
|
|
2876
|
-
`void`
|
|
2877
|
-
|
|
2878
|
-
##### Defined in
|
|
2879
|
-
|
|
2880
|
-
[packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml-sync.ts#L10)
|
|
2881
|
-
|
|
2882
|
-
#### writeYamlSync(path, data, replacer, options)
|
|
2883
|
-
|
|
2884
|
-
```ts
|
|
2885
|
-
function writeYamlSync(path, data, replacer?, options?): void;
|
|
2886
|
-
```
|
|
2887
|
-
|
|
2888
|
-
##### Parameters
|
|
2889
|
-
|
|
2890
|
-
• **path**: `string` \| `URL`
|
|
2891
|
-
|
|
2892
|
-
• **data**: `any`
|
|
2893
|
-
|
|
2894
|
-
• **replacer?**: [`JsonReplacer`](index.md#jsonreplacer)
|
|
2895
|
-
|
|
2896
|
-
• **options?**: `string` \| `number` \| `Options`
|
|
2897
|
-
|
|
2898
|
-
##### Returns
|
|
2899
|
-
|
|
2900
|
-
`void`
|
|
2901
|
-
|
|
2902
|
-
##### Defined in
|
|
2903
|
-
|
|
2904
|
-
[packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml-sync.ts#L16)
|
|
2905
|
-
|
|
2906
|
-
## Variables
|
|
2907
|
-
|
|
2908
|
-
### CRLF
|
|
2909
|
-
|
|
2910
|
-
```ts
|
|
2911
|
-
const CRLF: "\r\n";
|
|
2912
|
-
```
|
|
2913
|
-
|
|
2914
|
-
End-of-line character for Windows platforms.
|
|
2915
|
-
|
|
2916
|
-
#### Defined in
|
|
2917
|
-
|
|
2918
|
-
[packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L9)
|
|
2919
|
-
|
|
2920
|
-
---
|
|
2921
|
-
|
|
2922
|
-
### EOL
|
|
2923
|
-
|
|
2924
|
-
```ts
|
|
2925
|
-
const EOL: "\n" | "\r\n";
|
|
2926
|
-
```
|
|
2927
|
-
|
|
2928
|
-
End-of-line character evaluated for the current platform.
|
|
2929
|
-
|
|
2930
|
-
#### Defined in
|
|
2931
|
-
|
|
2932
|
-
[packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L14)
|
|
2933
|
-
|
|
2934
|
-
---
|
|
2935
|
-
|
|
2936
|
-
### F_OK
|
|
2937
|
-
|
|
2938
|
-
```ts
|
|
2939
|
-
const F_OK: 0 = 0;
|
|
2940
|
-
```
|
|
2941
|
-
|
|
2942
|
-
Is the path visible to the calling process?
|
|
2943
|
-
|
|
2944
|
-
#### Defined in
|
|
2945
|
-
|
|
2946
|
-
[packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/constants.ts#L2)
|
|
2947
|
-
|
|
2948
|
-
---
|
|
2949
|
-
|
|
2950
|
-
### FIND_UP_STOP
|
|
3070
|
+
### FIND\_UP\_STOP
|
|
2951
3071
|
|
|
2952
3072
|
```ts
|
|
2953
3073
|
const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
2954
3074
|
```
|
|
2955
3075
|
|
|
2956
|
-
|
|
3076
|
+
Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/constants.ts#L13)
|
|
2957
3077
|
|
|
2958
|
-
|
|
2959
|
-
|
|
2960
|
-
---
|
|
3078
|
+
***
|
|
2961
3079
|
|
|
2962
3080
|
### LF
|
|
2963
3081
|
|
|
@@ -2965,58 +3083,52 @@ const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
|
2965
3083
|
const LF: "\n";
|
|
2966
3084
|
```
|
|
2967
3085
|
|
|
2968
|
-
|
|
2969
|
-
|
|
2970
|
-
#### Defined in
|
|
3086
|
+
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/eol.ts#L6)
|
|
2971
3087
|
|
|
2972
|
-
|
|
3088
|
+
End-of-line character for POSIX platforms such as macOS and Linux.
|
|
2973
3089
|
|
|
2974
|
-
|
|
3090
|
+
***
|
|
2975
3091
|
|
|
2976
|
-
###
|
|
3092
|
+
### R\_OK
|
|
2977
3093
|
|
|
2978
3094
|
```ts
|
|
2979
3095
|
const R_OK: 4 = 4;
|
|
2980
3096
|
```
|
|
2981
3097
|
|
|
2982
|
-
|
|
2983
|
-
|
|
2984
|
-
#### Defined in
|
|
3098
|
+
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/constants.ts#L5)
|
|
2985
3099
|
|
|
2986
|
-
|
|
3100
|
+
Is the path readable to the calling process?
|
|
2987
3101
|
|
|
2988
|
-
|
|
3102
|
+
***
|
|
2989
3103
|
|
|
2990
|
-
###
|
|
3104
|
+
### W\_OK
|
|
2991
3105
|
|
|
2992
3106
|
```ts
|
|
2993
3107
|
const W_OK: 2 = 2;
|
|
2994
3108
|
```
|
|
2995
3109
|
|
|
2996
|
-
|
|
2997
|
-
|
|
2998
|
-
#### Defined in
|
|
3110
|
+
Defined in: [packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/constants.ts#L8)
|
|
2999
3111
|
|
|
3000
|
-
|
|
3112
|
+
Is the path writable to the calling process?
|
|
3001
3113
|
|
|
3002
|
-
|
|
3114
|
+
***
|
|
3003
3115
|
|
|
3004
|
-
###
|
|
3116
|
+
### X\_OK
|
|
3005
3117
|
|
|
3006
3118
|
```ts
|
|
3007
3119
|
const X_OK: 1 = 1;
|
|
3008
3120
|
```
|
|
3009
3121
|
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
#### Defined in
|
|
3122
|
+
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/constants.ts#L11)
|
|
3013
3123
|
|
|
3014
|
-
|
|
3124
|
+
Is the path executable to the calling process?
|
|
3015
3125
|
|
|
3016
3126
|
## Interfaces
|
|
3017
3127
|
|
|
3018
3128
|
### WalkEntry
|
|
3019
3129
|
|
|
3130
|
+
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L56)
|
|
3131
|
+
|
|
3020
3132
|
#### Extends
|
|
3021
3133
|
|
|
3022
3134
|
- `Pick`\<`Dirent`, `"isDirectory"` \| `"isFile"` \| `"isSymbolicLink"` \| `"name"`\>
|
|
@@ -3029,6 +3141,8 @@ Is the path executable to the calling process?
|
|
|
3029
3141
|
isDirectory(): boolean
|
|
3030
3142
|
```
|
|
3031
3143
|
|
|
3144
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:190
|
|
3145
|
+
|
|
3032
3146
|
Returns `true` if the `fs.Dirent` object describes a file system
|
|
3033
3147
|
directory.
|
|
3034
3148
|
|
|
@@ -3042,11 +3156,9 @@ v10.10.0
|
|
|
3042
3156
|
|
|
3043
3157
|
###### Inherited from
|
|
3044
3158
|
|
|
3045
|
-
|
|
3046
|
-
|
|
3047
|
-
|
|
3048
|
-
|
|
3049
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:190
|
|
3159
|
+
```ts
|
|
3160
|
+
Pick.isDirectory
|
|
3161
|
+
```
|
|
3050
3162
|
|
|
3051
3163
|
##### isFile()
|
|
3052
3164
|
|
|
@@ -3054,6 +3166,8 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:190
|
|
|
3054
3166
|
isFile(): boolean
|
|
3055
3167
|
```
|
|
3056
3168
|
|
|
3169
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:184
|
|
3170
|
+
|
|
3057
3171
|
Returns `true` if the `fs.Dirent` object describes a regular file.
|
|
3058
3172
|
|
|
3059
3173
|
###### Returns
|
|
@@ -3066,11 +3180,9 @@ v10.10.0
|
|
|
3066
3180
|
|
|
3067
3181
|
###### Inherited from
|
|
3068
3182
|
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3072
|
-
|
|
3073
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:184
|
|
3183
|
+
```ts
|
|
3184
|
+
Pick.isFile
|
|
3185
|
+
```
|
|
3074
3186
|
|
|
3075
3187
|
##### isSymbolicLink()
|
|
3076
3188
|
|
|
@@ -3078,6 +3190,8 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:184
|
|
|
3078
3190
|
isSymbolicLink(): boolean
|
|
3079
3191
|
```
|
|
3080
3192
|
|
|
3193
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:205
|
|
3194
|
+
|
|
3081
3195
|
Returns `true` if the `fs.Dirent` object describes a symbolic link.
|
|
3082
3196
|
|
|
3083
3197
|
###### Returns
|
|
@@ -3090,11 +3204,9 @@ v10.10.0
|
|
|
3090
3204
|
|
|
3091
3205
|
###### Inherited from
|
|
3092
3206
|
|
|
3093
|
-
|
|
3094
|
-
|
|
3095
|
-
|
|
3096
|
-
|
|
3097
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:205
|
|
3207
|
+
```ts
|
|
3208
|
+
Pick.isSymbolicLink
|
|
3209
|
+
```
|
|
3098
3210
|
|
|
3099
3211
|
#### Properties
|
|
3100
3212
|
|
|
@@ -3104,6 +3216,8 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:205
|
|
|
3104
3216
|
name: string;
|
|
3105
3217
|
```
|
|
3106
3218
|
|
|
3219
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:222
|
|
3220
|
+
|
|
3107
3221
|
The file name that this `fs.Dirent` object refers to. The type of this
|
|
3108
3222
|
value is determined by the `options.encoding` passed to readdir or readdirSync.
|
|
3109
3223
|
|
|
@@ -3113,11 +3227,9 @@ v10.10.0
|
|
|
3113
3227
|
|
|
3114
3228
|
###### Inherited from
|
|
3115
3229
|
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:222
|
|
3230
|
+
```ts
|
|
3231
|
+
Pick.name
|
|
3232
|
+
```
|
|
3121
3233
|
|
|
3122
3234
|
##### path
|
|
3123
3235
|
|
|
@@ -3125,14 +3237,14 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:222
|
|
|
3125
3237
|
path: string;
|
|
3126
3238
|
```
|
|
3127
3239
|
|
|
3128
|
-
|
|
3240
|
+
Defined in: [packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L57)
|
|
3129
3241
|
|
|
3130
|
-
|
|
3131
|
-
|
|
3132
|
-
---
|
|
3242
|
+
***
|
|
3133
3243
|
|
|
3134
3244
|
### WalkOptions
|
|
3135
3245
|
|
|
3246
|
+
Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L9)
|
|
3247
|
+
|
|
3136
3248
|
#### Properties
|
|
3137
3249
|
|
|
3138
3250
|
##### extensions?
|
|
@@ -3141,172 +3253,142 @@ path: string;
|
|
|
3141
3253
|
optional extensions: string[];
|
|
3142
3254
|
```
|
|
3143
3255
|
|
|
3256
|
+
Defined in: [packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L15)
|
|
3257
|
+
|
|
3144
3258
|
List of file extensions used to filter entries.
|
|
3145
3259
|
If specified, entries without the file extension specified by this option are excluded.
|
|
3146
3260
|
|
|
3147
3261
|
###### Default
|
|
3148
3262
|
|
|
3149
3263
|
```ts
|
|
3150
|
-
{
|
|
3151
|
-
undefined;
|
|
3152
|
-
}
|
|
3264
|
+
{undefined}
|
|
3153
3265
|
```
|
|
3154
3266
|
|
|
3155
|
-
###### Defined in
|
|
3156
|
-
|
|
3157
|
-
[packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L15)
|
|
3158
|
-
|
|
3159
3267
|
##### followSymlinks?
|
|
3160
3268
|
|
|
3161
3269
|
```ts
|
|
3162
3270
|
optional followSymlinks: boolean;
|
|
3163
3271
|
```
|
|
3164
3272
|
|
|
3273
|
+
Defined in: [packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L20)
|
|
3274
|
+
|
|
3165
3275
|
Indicates whether symlinks should be resolved or not.
|
|
3166
3276
|
|
|
3167
3277
|
###### Default
|
|
3168
3278
|
|
|
3169
3279
|
```ts
|
|
3170
|
-
{
|
|
3171
|
-
false;
|
|
3172
|
-
}
|
|
3280
|
+
{false}
|
|
3173
3281
|
```
|
|
3174
3282
|
|
|
3175
|
-
###### Defined in
|
|
3176
|
-
|
|
3177
|
-
[packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L20)
|
|
3178
|
-
|
|
3179
3283
|
##### includeDirs?
|
|
3180
3284
|
|
|
3181
3285
|
```ts
|
|
3182
3286
|
optional includeDirs: boolean;
|
|
3183
3287
|
```
|
|
3184
3288
|
|
|
3289
|
+
Defined in: [packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L25)
|
|
3290
|
+
|
|
3185
3291
|
Indicates whether directory entries should be included or not.
|
|
3186
3292
|
|
|
3187
3293
|
###### Default
|
|
3188
3294
|
|
|
3189
3295
|
```ts
|
|
3190
|
-
{
|
|
3191
|
-
true;
|
|
3192
|
-
}
|
|
3296
|
+
{true}
|
|
3193
3297
|
```
|
|
3194
3298
|
|
|
3195
|
-
###### Defined in
|
|
3196
|
-
|
|
3197
|
-
[packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L25)
|
|
3198
|
-
|
|
3199
3299
|
##### includeFiles?
|
|
3200
3300
|
|
|
3201
3301
|
```ts
|
|
3202
3302
|
optional includeFiles: boolean;
|
|
3203
3303
|
```
|
|
3204
3304
|
|
|
3305
|
+
Defined in: [packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L30)
|
|
3306
|
+
|
|
3205
3307
|
Indicates whether file entries should be included or not.
|
|
3206
3308
|
|
|
3207
3309
|
###### Default
|
|
3208
3310
|
|
|
3209
3311
|
```ts
|
|
3210
|
-
{
|
|
3211
|
-
true;
|
|
3212
|
-
}
|
|
3312
|
+
{true}
|
|
3213
3313
|
```
|
|
3214
3314
|
|
|
3215
|
-
###### Defined in
|
|
3216
|
-
|
|
3217
|
-
[packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L30)
|
|
3218
|
-
|
|
3219
3315
|
##### includeSymlinks?
|
|
3220
3316
|
|
|
3221
3317
|
```ts
|
|
3222
3318
|
optional includeSymlinks: boolean;
|
|
3223
3319
|
```
|
|
3224
3320
|
|
|
3321
|
+
Defined in: [packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L36)
|
|
3322
|
+
|
|
3225
3323
|
Indicates whether symlink entries should be included or not.
|
|
3226
3324
|
This option is meaningful only if `followSymlinks` is set to `false`.
|
|
3227
3325
|
|
|
3228
3326
|
###### Default
|
|
3229
3327
|
|
|
3230
3328
|
```ts
|
|
3231
|
-
{
|
|
3232
|
-
true;
|
|
3233
|
-
}
|
|
3329
|
+
{true}
|
|
3234
3330
|
```
|
|
3235
3331
|
|
|
3236
|
-
###### Defined in
|
|
3237
|
-
|
|
3238
|
-
[packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L36)
|
|
3239
|
-
|
|
3240
3332
|
##### match?
|
|
3241
3333
|
|
|
3242
3334
|
```ts
|
|
3243
3335
|
optional match: (string | RegExp)[];
|
|
3244
3336
|
```
|
|
3245
3337
|
|
|
3338
|
+
Defined in: [packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L42)
|
|
3339
|
+
|
|
3246
3340
|
List of regular expression or glob patterns used to filter entries.
|
|
3247
3341
|
If specified, entries that do not match the patterns specified by this option are excluded.
|
|
3248
3342
|
|
|
3249
3343
|
###### Default
|
|
3250
3344
|
|
|
3251
3345
|
```ts
|
|
3252
|
-
{
|
|
3253
|
-
undefined;
|
|
3254
|
-
}
|
|
3346
|
+
{undefined}
|
|
3255
3347
|
```
|
|
3256
3348
|
|
|
3257
|
-
###### Defined in
|
|
3258
|
-
|
|
3259
|
-
[packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L42)
|
|
3260
|
-
|
|
3261
3349
|
##### maxDepth?
|
|
3262
3350
|
|
|
3263
3351
|
```ts
|
|
3264
3352
|
optional maxDepth: number;
|
|
3265
3353
|
```
|
|
3266
3354
|
|
|
3355
|
+
Defined in: [packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L47)
|
|
3356
|
+
|
|
3267
3357
|
The maximum depth of the file tree to be walked recursively.
|
|
3268
3358
|
|
|
3269
3359
|
###### Default
|
|
3270
3360
|
|
|
3271
3361
|
```ts
|
|
3272
|
-
{
|
|
3273
|
-
Infinity;
|
|
3274
|
-
}
|
|
3362
|
+
{Infinity}
|
|
3275
3363
|
```
|
|
3276
3364
|
|
|
3277
|
-
###### Defined in
|
|
3278
|
-
|
|
3279
|
-
[packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L47)
|
|
3280
|
-
|
|
3281
3365
|
##### skip?
|
|
3282
3366
|
|
|
3283
3367
|
```ts
|
|
3284
3368
|
optional skip: (string | RegExp)[];
|
|
3285
3369
|
```
|
|
3286
3370
|
|
|
3371
|
+
Defined in: [packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L53)
|
|
3372
|
+
|
|
3287
3373
|
List of regular expression or glob patterns used to filter entries.
|
|
3288
3374
|
If specified, entries matching the patterns specified by this option are excluded.
|
|
3289
3375
|
|
|
3290
3376
|
###### Default
|
|
3291
3377
|
|
|
3292
3378
|
```ts
|
|
3293
|
-
{
|
|
3294
|
-
undefined;
|
|
3295
|
-
}
|
|
3379
|
+
{undefined}
|
|
3296
3380
|
```
|
|
3297
3381
|
|
|
3298
|
-
###### Defined in
|
|
3299
|
-
|
|
3300
|
-
[packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L53)
|
|
3301
|
-
|
|
3302
3382
|
## Type Aliases
|
|
3303
3383
|
|
|
3304
3384
|
### CodeFrameLocation
|
|
3305
3385
|
|
|
3306
3386
|
```ts
|
|
3307
|
-
type CodeFrameLocation
|
|
3387
|
+
type CodeFrameLocation = object;
|
|
3308
3388
|
```
|
|
3309
3389
|
|
|
3390
|
+
Defined in: [packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L91)
|
|
3391
|
+
|
|
3310
3392
|
#### Type declaration
|
|
3311
3393
|
|
|
3312
3394
|
##### column?
|
|
@@ -3321,18 +3403,16 @@ optional column: number;
|
|
|
3321
3403
|
line: number;
|
|
3322
3404
|
```
|
|
3323
3405
|
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
[packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L91)
|
|
3327
|
-
|
|
3328
|
-
---
|
|
3406
|
+
***
|
|
3329
3407
|
|
|
3330
3408
|
### EmptyDirOptions
|
|
3331
3409
|
|
|
3332
3410
|
```ts
|
|
3333
|
-
type EmptyDirOptions
|
|
3411
|
+
type EmptyDirOptions = object;
|
|
3334
3412
|
```
|
|
3335
3413
|
|
|
3414
|
+
Defined in: [packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L188)
|
|
3415
|
+
|
|
3336
3416
|
#### Type declaration
|
|
3337
3417
|
|
|
3338
3418
|
##### maxRetries?
|
|
@@ -3350,7 +3430,7 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
3350
3430
|
###### Default
|
|
3351
3431
|
|
|
3352
3432
|
```ts
|
|
3353
|
-
0
|
|
3433
|
+
0
|
|
3354
3434
|
```
|
|
3355
3435
|
|
|
3356
3436
|
##### retryDelay?
|
|
@@ -3365,69 +3445,69 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
3365
3445
|
###### Default
|
|
3366
3446
|
|
|
3367
3447
|
```ts
|
|
3368
|
-
100
|
|
3448
|
+
100
|
|
3369
3449
|
```
|
|
3370
3450
|
|
|
3371
|
-
|
|
3372
|
-
|
|
3373
|
-
[packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L188)
|
|
3374
|
-
|
|
3375
|
-
---
|
|
3451
|
+
***
|
|
3376
3452
|
|
|
3377
3453
|
### FindUpName
|
|
3378
3454
|
|
|
3379
3455
|
```ts
|
|
3380
|
-
type FindUpName
|
|
3456
|
+
type FindUpName =
|
|
3457
|
+
| string[]
|
|
3458
|
+
| string
|
|
3459
|
+
| (directory) => FindUpNameFnResult;
|
|
3381
3460
|
```
|
|
3382
3461
|
|
|
3383
|
-
|
|
3462
|
+
Defined in: [packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L180)
|
|
3384
3463
|
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
---
|
|
3464
|
+
***
|
|
3388
3465
|
|
|
3389
3466
|
### FindUpNameFnResult
|
|
3390
3467
|
|
|
3391
3468
|
```ts
|
|
3392
|
-
type FindUpNameFnResult
|
|
3469
|
+
type FindUpNameFnResult =
|
|
3470
|
+
| PathLike
|
|
3471
|
+
| Promise<PathLike | typeof FIND_UP_STOP>
|
|
3472
|
+
| typeof FIND_UP_STOP
|
|
3473
|
+
| undefined;
|
|
3393
3474
|
```
|
|
3394
3475
|
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
[packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L178)
|
|
3476
|
+
Defined in: [packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L178)
|
|
3398
3477
|
|
|
3399
|
-
|
|
3478
|
+
***
|
|
3400
3479
|
|
|
3401
3480
|
### FindUpNameSync
|
|
3402
3481
|
|
|
3403
3482
|
```ts
|
|
3404
|
-
type FindUpNameSync
|
|
3483
|
+
type FindUpNameSync =
|
|
3484
|
+
| string[]
|
|
3485
|
+
| string
|
|
3486
|
+
| (directory) => FindUpNameSyncFnResult;
|
|
3405
3487
|
```
|
|
3406
3488
|
|
|
3407
|
-
|
|
3489
|
+
Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L185)
|
|
3408
3490
|
|
|
3409
|
-
|
|
3410
|
-
|
|
3411
|
-
---
|
|
3491
|
+
***
|
|
3412
3492
|
|
|
3413
3493
|
### FindUpNameSyncFnResult
|
|
3414
3494
|
|
|
3415
3495
|
```ts
|
|
3416
|
-
type FindUpNameSyncFnResult
|
|
3496
|
+
type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
|
|
3417
3497
|
```
|
|
3418
3498
|
|
|
3419
|
-
|
|
3420
|
-
|
|
3421
|
-
[packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L183)
|
|
3499
|
+
Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L183)
|
|
3422
3500
|
|
|
3423
|
-
|
|
3501
|
+
***
|
|
3424
3502
|
|
|
3425
3503
|
### FindUpOptions
|
|
3426
3504
|
|
|
3427
3505
|
```ts
|
|
3428
|
-
type FindUpOptions
|
|
3506
|
+
type FindUpOptions = object;
|
|
3429
3507
|
```
|
|
3430
3508
|
|
|
3509
|
+
Defined in: [packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L170)
|
|
3510
|
+
|
|
3431
3511
|
#### Type declaration
|
|
3432
3512
|
|
|
3433
3513
|
##### allowSymlinks?
|
|
@@ -3454,42 +3534,36 @@ optional stopAt: URL | string;
|
|
|
3454
3534
|
optional type: "directory" | "file";
|
|
3455
3535
|
```
|
|
3456
3536
|
|
|
3457
|
-
|
|
3458
|
-
|
|
3459
|
-
[packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L170)
|
|
3460
|
-
|
|
3461
|
-
---
|
|
3537
|
+
***
|
|
3462
3538
|
|
|
3463
3539
|
### JsonReplacer
|
|
3464
3540
|
|
|
3465
3541
|
```ts
|
|
3466
|
-
type JsonReplacer
|
|
3542
|
+
type JsonReplacer = (number | string)[] | (this, key, value) => unknown | null;
|
|
3467
3543
|
```
|
|
3468
3544
|
|
|
3469
|
-
|
|
3545
|
+
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L143)
|
|
3470
3546
|
|
|
3471
|
-
|
|
3472
|
-
|
|
3473
|
-
---
|
|
3547
|
+
***
|
|
3474
3548
|
|
|
3475
3549
|
### JsonReviver
|
|
3476
3550
|
|
|
3477
3551
|
```ts
|
|
3478
|
-
type JsonReviver
|
|
3552
|
+
type JsonReviver = Parameters<typeof JSON["parse"]>["1"];
|
|
3479
3553
|
```
|
|
3480
3554
|
|
|
3481
|
-
|
|
3555
|
+
Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L89)
|
|
3482
3556
|
|
|
3483
|
-
|
|
3484
|
-
|
|
3485
|
-
---
|
|
3557
|
+
***
|
|
3486
3558
|
|
|
3487
3559
|
### MoveOptions
|
|
3488
3560
|
|
|
3489
3561
|
```ts
|
|
3490
|
-
type MoveOptions
|
|
3562
|
+
type MoveOptions = object;
|
|
3491
3563
|
```
|
|
3492
3564
|
|
|
3565
|
+
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/move/types.ts#L3)
|
|
3566
|
+
|
|
3493
3567
|
#### Type declaration
|
|
3494
3568
|
|
|
3495
3569
|
##### cwd?
|
|
@@ -3504,7 +3578,7 @@ The source and destination path are relative to this.
|
|
|
3504
3578
|
###### Default
|
|
3505
3579
|
|
|
3506
3580
|
```ts
|
|
3507
|
-
process.cwd()
|
|
3581
|
+
process.cwd()
|
|
3508
3582
|
```
|
|
3509
3583
|
|
|
3510
3584
|
##### directoryMode?
|
|
@@ -3520,7 +3594,7 @@ It has no effect on Windows.
|
|
|
3520
3594
|
###### Default
|
|
3521
3595
|
|
|
3522
3596
|
```ts
|
|
3523
|
-
0o777
|
|
3597
|
+
0o777
|
|
3524
3598
|
```
|
|
3525
3599
|
|
|
3526
3600
|
##### overwrite?
|
|
@@ -3534,19 +3608,15 @@ Overwrite existing destination file.
|
|
|
3534
3608
|
###### Default
|
|
3535
3609
|
|
|
3536
3610
|
```ts
|
|
3537
|
-
true
|
|
3611
|
+
true
|
|
3538
3612
|
```
|
|
3539
3613
|
|
|
3540
|
-
|
|
3541
|
-
|
|
3542
|
-
[packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/types.ts#L3)
|
|
3543
|
-
|
|
3544
|
-
---
|
|
3614
|
+
***
|
|
3545
3615
|
|
|
3546
3616
|
### ReadFileEncoding
|
|
3547
3617
|
|
|
3548
3618
|
```ts
|
|
3549
|
-
type ReadFileEncoding
|
|
3619
|
+
type ReadFileEncoding =
|
|
3550
3620
|
| "ascii"
|
|
3551
3621
|
| "base64"
|
|
3552
3622
|
| "base64url"
|
|
@@ -3560,18 +3630,18 @@ type ReadFileEncoding:
|
|
|
3560
3630
|
| "utf16le";
|
|
3561
3631
|
```
|
|
3562
3632
|
|
|
3563
|
-
|
|
3633
|
+
Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L61)
|
|
3564
3634
|
|
|
3565
|
-
|
|
3566
|
-
|
|
3567
|
-
---
|
|
3635
|
+
***
|
|
3568
3636
|
|
|
3569
3637
|
### ReadFileOptions\<C\>
|
|
3570
3638
|
|
|
3571
3639
|
```ts
|
|
3572
|
-
type ReadFileOptions<C
|
|
3640
|
+
type ReadFileOptions<C> = object;
|
|
3573
3641
|
```
|
|
3574
3642
|
|
|
3643
|
+
Defined in: [packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L63)
|
|
3644
|
+
|
|
3575
3645
|
#### Type Parameters
|
|
3576
3646
|
|
|
3577
3647
|
• **C**
|
|
@@ -3614,18 +3684,16 @@ optional flag: number | string;
|
|
|
3614
3684
|
|
|
3615
3685
|
The flag used to open the file. Default: `r`
|
|
3616
3686
|
|
|
3617
|
-
|
|
3618
|
-
|
|
3619
|
-
[packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L63)
|
|
3620
|
-
|
|
3621
|
-
---
|
|
3687
|
+
***
|
|
3622
3688
|
|
|
3623
3689
|
### ReadJsonOptions
|
|
3624
3690
|
|
|
3625
3691
|
```ts
|
|
3626
|
-
type ReadJsonOptions
|
|
3692
|
+
type ReadJsonOptions = CodeFrameOptions & object;
|
|
3627
3693
|
```
|
|
3628
3694
|
|
|
3695
|
+
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L104)
|
|
3696
|
+
|
|
3629
3697
|
#### Type declaration
|
|
3630
3698
|
|
|
3631
3699
|
##### beforeParse()?
|
|
@@ -3636,24 +3704,24 @@ optional beforeParse: (source) => string;
|
|
|
3636
3704
|
|
|
3637
3705
|
###### Parameters
|
|
3638
3706
|
|
|
3639
|
-
|
|
3707
|
+
###### source
|
|
3708
|
+
|
|
3709
|
+
`string`
|
|
3640
3710
|
|
|
3641
3711
|
###### Returns
|
|
3642
3712
|
|
|
3643
3713
|
`string`
|
|
3644
3714
|
|
|
3645
|
-
|
|
3646
|
-
|
|
3647
|
-
[packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L104)
|
|
3648
|
-
|
|
3649
|
-
---
|
|
3715
|
+
***
|
|
3650
3716
|
|
|
3651
3717
|
### WriteFileOptions
|
|
3652
3718
|
|
|
3653
3719
|
```ts
|
|
3654
|
-
type WriteFileOptions
|
|
3720
|
+
type WriteFileOptions = object;
|
|
3655
3721
|
```
|
|
3656
3722
|
|
|
3723
|
+
Defined in: [packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L108)
|
|
3724
|
+
|
|
3657
3725
|
#### Type declaration
|
|
3658
3726
|
|
|
3659
3727
|
##### chown?
|
|
@@ -3664,13 +3732,13 @@ optional chown: object;
|
|
|
3664
3732
|
|
|
3665
3733
|
The group and user ID used to set the file ownership. Default: `undefined`
|
|
3666
3734
|
|
|
3667
|
-
|
|
3735
|
+
###### chown.gid
|
|
3668
3736
|
|
|
3669
3737
|
```ts
|
|
3670
3738
|
gid: number;
|
|
3671
3739
|
```
|
|
3672
3740
|
|
|
3673
|
-
|
|
3741
|
+
###### chown.uid
|
|
3674
3742
|
|
|
3675
3743
|
```ts
|
|
3676
3744
|
uid: number;
|
|
@@ -3716,18 +3784,16 @@ optional recursive: boolean;
|
|
|
3716
3784
|
|
|
3717
3785
|
Recursively create parent directories if needed. Default: `true`
|
|
3718
3786
|
|
|
3719
|
-
|
|
3720
|
-
|
|
3721
|
-
[packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L108)
|
|
3722
|
-
|
|
3723
|
-
---
|
|
3787
|
+
***
|
|
3724
3788
|
|
|
3725
3789
|
### WriteJsonOptions
|
|
3726
3790
|
|
|
3727
3791
|
```ts
|
|
3728
|
-
type WriteJsonOptions
|
|
3792
|
+
type WriteJsonOptions = WriteFileOptions & object;
|
|
3729
3793
|
```
|
|
3730
3794
|
|
|
3795
|
+
Defined in: [packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L146)
|
|
3796
|
+
|
|
3731
3797
|
#### Type declaration
|
|
3732
3798
|
|
|
3733
3799
|
##### detectIndent?
|
|
@@ -3766,38 +3832,29 @@ Override the default `JSON.stringify` method.
|
|
|
3766
3832
|
|
|
3767
3833
|
###### Parameters
|
|
3768
3834
|
|
|
3769
|
-
|
|
3770
|
-
|
|
3771
|
-
• **replacer**: [`JsonReplacer`](index.md#jsonreplacer)
|
|
3835
|
+
###### data
|
|
3772
3836
|
|
|
3773
|
-
|
|
3837
|
+
`unknown`
|
|
3774
3838
|
|
|
3775
|
-
######
|
|
3776
|
-
|
|
3777
|
-
`string`
|
|
3778
|
-
|
|
3779
|
-
#### Defined in
|
|
3839
|
+
###### replacer
|
|
3780
3840
|
|
|
3781
|
-
[
|
|
3841
|
+
[`JsonReplacer`](index.md#jsonreplacer)
|
|
3782
3842
|
|
|
3783
|
-
|
|
3843
|
+
###### space
|
|
3784
3844
|
|
|
3785
|
-
|
|
3845
|
+
`number` | `string` | `undefined`
|
|
3786
3846
|
|
|
3787
|
-
|
|
3788
|
-
type YamlReplacer: JsonReplacer;
|
|
3789
|
-
```
|
|
3790
|
-
|
|
3791
|
-
#### Defined in
|
|
3792
|
-
|
|
3793
|
-
[packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L144)
|
|
3847
|
+
###### Returns
|
|
3794
3848
|
|
|
3849
|
+
`string`
|
|
3795
3850
|
# utils
|
|
3796
3851
|
|
|
3797
3852
|
## Classes
|
|
3798
3853
|
|
|
3799
3854
|
### JSONError
|
|
3800
3855
|
|
|
3856
|
+
Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L1)
|
|
3857
|
+
|
|
3801
3858
|
#### Extends
|
|
3802
3859
|
|
|
3803
3860
|
- `Error`
|
|
@@ -3810,9 +3867,13 @@ type YamlReplacer: JsonReplacer;
|
|
|
3810
3867
|
new JSONError(message): JSONError
|
|
3811
3868
|
```
|
|
3812
3869
|
|
|
3870
|
+
Defined in: [packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L11)
|
|
3871
|
+
|
|
3813
3872
|
###### Parameters
|
|
3814
3873
|
|
|
3815
|
-
|
|
3874
|
+
###### message
|
|
3875
|
+
|
|
3876
|
+
`string`
|
|
3816
3877
|
|
|
3817
3878
|
###### Returns
|
|
3818
3879
|
|
|
@@ -3820,39 +3881,49 @@ new JSONError(message): JSONError
|
|
|
3820
3881
|
|
|
3821
3882
|
###### Overrides
|
|
3822
3883
|
|
|
3823
|
-
|
|
3824
|
-
|
|
3825
|
-
|
|
3826
|
-
|
|
3827
|
-
[packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L11)
|
|
3884
|
+
```ts
|
|
3885
|
+
Error.constructor
|
|
3886
|
+
```
|
|
3828
3887
|
|
|
3829
3888
|
#### Accessors
|
|
3830
3889
|
|
|
3831
3890
|
##### message
|
|
3832
3891
|
|
|
3892
|
+
###### Get Signature
|
|
3893
|
+
|
|
3833
3894
|
```ts
|
|
3834
3895
|
get message(): string
|
|
3835
3896
|
```
|
|
3836
3897
|
|
|
3898
|
+
Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L21)
|
|
3899
|
+
|
|
3900
|
+
###### Returns
|
|
3901
|
+
|
|
3902
|
+
`string`
|
|
3903
|
+
|
|
3904
|
+
###### Set Signature
|
|
3905
|
+
|
|
3837
3906
|
```ts
|
|
3838
3907
|
set message(message): void
|
|
3839
3908
|
```
|
|
3840
3909
|
|
|
3841
|
-
|
|
3910
|
+
Defined in: [packages/fs/src/error/json-error.ts:25](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L25)
|
|
3842
3911
|
|
|
3843
|
-
|
|
3912
|
+
###### Parameters
|
|
3844
3913
|
|
|
3845
|
-
######
|
|
3914
|
+
###### message
|
|
3846
3915
|
|
|
3847
3916
|
`string`
|
|
3848
3917
|
|
|
3849
|
-
######
|
|
3918
|
+
###### Returns
|
|
3850
3919
|
|
|
3851
|
-
`
|
|
3920
|
+
`void`
|
|
3852
3921
|
|
|
3853
|
-
######
|
|
3922
|
+
###### Overrides
|
|
3854
3923
|
|
|
3855
|
-
|
|
3924
|
+
```ts
|
|
3925
|
+
Error.message
|
|
3926
|
+
```
|
|
3856
3927
|
|
|
3857
3928
|
#### Methods
|
|
3858
3929
|
|
|
@@ -3862,13 +3933,19 @@ set message(message): void
|
|
|
3862
3933
|
static captureStackTrace(targetObject, constructorOpt?): void
|
|
3863
3934
|
```
|
|
3864
3935
|
|
|
3936
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
3937
|
+
|
|
3865
3938
|
Create .stack property on a target object
|
|
3866
3939
|
|
|
3867
3940
|
###### Parameters
|
|
3868
3941
|
|
|
3869
|
-
|
|
3942
|
+
###### targetObject
|
|
3943
|
+
|
|
3944
|
+
`object`
|
|
3870
3945
|
|
|
3871
|
-
|
|
3946
|
+
###### constructorOpt?
|
|
3947
|
+
|
|
3948
|
+
`Function`
|
|
3872
3949
|
|
|
3873
3950
|
###### Returns
|
|
3874
3951
|
|
|
@@ -3876,11 +3953,9 @@ Create .stack property on a target object
|
|
|
3876
3953
|
|
|
3877
3954
|
###### Inherited from
|
|
3878
3955
|
|
|
3879
|
-
|
|
3880
|
-
|
|
3881
|
-
|
|
3882
|
-
|
|
3883
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
3956
|
+
```ts
|
|
3957
|
+
Error.captureStackTrace
|
|
3958
|
+
```
|
|
3884
3959
|
|
|
3885
3960
|
#### Properties
|
|
3886
3961
|
|
|
@@ -3890,13 +3965,13 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
|
3890
3965
|
optional cause: unknown;
|
|
3891
3966
|
```
|
|
3892
3967
|
|
|
3893
|
-
|
|
3894
|
-
|
|
3895
|
-
`Error.cause`
|
|
3968
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
3896
3969
|
|
|
3897
|
-
######
|
|
3970
|
+
###### Inherited from
|
|
3898
3971
|
|
|
3899
|
-
|
|
3972
|
+
```ts
|
|
3973
|
+
Error.cause
|
|
3974
|
+
```
|
|
3900
3975
|
|
|
3901
3976
|
##### codeFrame
|
|
3902
3977
|
|
|
@@ -3904,9 +3979,7 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error
|
|
|
3904
3979
|
codeFrame: string;
|
|
3905
3980
|
```
|
|
3906
3981
|
|
|
3907
|
-
|
|
3908
|
-
|
|
3909
|
-
[packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L4)
|
|
3982
|
+
Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L4)
|
|
3910
3983
|
|
|
3911
3984
|
##### fileName
|
|
3912
3985
|
|
|
@@ -3914,9 +3987,7 @@ codeFrame: string;
|
|
|
3914
3987
|
fileName: string;
|
|
3915
3988
|
```
|
|
3916
3989
|
|
|
3917
|
-
|
|
3918
|
-
|
|
3919
|
-
[packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L2)
|
|
3990
|
+
Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L2)
|
|
3920
3991
|
|
|
3921
3992
|
##### name
|
|
3922
3993
|
|
|
@@ -3924,13 +3995,13 @@ fileName: string;
|
|
|
3924
3995
|
readonly name: "JSONError" = "JSONError";
|
|
3925
3996
|
```
|
|
3926
3997
|
|
|
3927
|
-
|
|
3928
|
-
|
|
3929
|
-
`Error.name`
|
|
3998
|
+
Defined in: [packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/error/json-error.ts#L7)
|
|
3930
3999
|
|
|
3931
|
-
######
|
|
4000
|
+
###### Overrides
|
|
3932
4001
|
|
|
3933
|
-
|
|
4002
|
+
```ts
|
|
4003
|
+
Error.name
|
|
4004
|
+
```
|
|
3934
4005
|
|
|
3935
4006
|
##### stack?
|
|
3936
4007
|
|
|
@@ -3938,13 +4009,13 @@ readonly name: "JSONError" = "JSONError";
|
|
|
3938
4009
|
optional stack: string;
|
|
3939
4010
|
```
|
|
3940
4011
|
|
|
3941
|
-
|
|
3942
|
-
|
|
3943
|
-
`Error.stack`
|
|
4012
|
+
Defined in: node\_modules/.pnpm/typescript@5.7.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
3944
4013
|
|
|
3945
|
-
######
|
|
4014
|
+
###### Inherited from
|
|
3946
4015
|
|
|
3947
|
-
|
|
4016
|
+
```ts
|
|
4017
|
+
Error.stack
|
|
4018
|
+
```
|
|
3948
4019
|
|
|
3949
4020
|
##### prepareStackTrace()?
|
|
3950
4021
|
|
|
@@ -3952,13 +4023,19 @@ node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:107
|
|
|
3952
4023
|
static optional prepareStackTrace: (err, stackTraces) => any;
|
|
3953
4024
|
```
|
|
3954
4025
|
|
|
4026
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:98
|
|
4027
|
+
|
|
3955
4028
|
Optional override for formatting stack traces
|
|
3956
4029
|
|
|
3957
4030
|
###### Parameters
|
|
3958
4031
|
|
|
3959
|
-
|
|
4032
|
+
###### err
|
|
3960
4033
|
|
|
3961
|
-
|
|
4034
|
+
`Error`
|
|
4035
|
+
|
|
4036
|
+
###### stackTraces
|
|
4037
|
+
|
|
4038
|
+
`CallSite`[]
|
|
3962
4039
|
|
|
3963
4040
|
###### Returns
|
|
3964
4041
|
|
|
@@ -3970,11 +4047,9 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
3970
4047
|
|
|
3971
4048
|
###### Inherited from
|
|
3972
4049
|
|
|
3973
|
-
|
|
3974
|
-
|
|
3975
|
-
|
|
3976
|
-
|
|
3977
|
-
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
4050
|
+
```ts
|
|
4051
|
+
Error.prepareStackTrace
|
|
4052
|
+
```
|
|
3978
4053
|
|
|
3979
4054
|
##### stackTraceLimit
|
|
3980
4055
|
|
|
@@ -3982,155 +4057,445 @@ node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
|
3982
4057
|
static stackTraceLimit: number;
|
|
3983
4058
|
```
|
|
3984
4059
|
|
|
3985
|
-
|
|
3986
|
-
|
|
3987
|
-
`Error.stackTraceLimit`
|
|
4060
|
+
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:100
|
|
3988
4061
|
|
|
3989
|
-
######
|
|
4062
|
+
###### Inherited from
|
|
3990
4063
|
|
|
3991
|
-
|
|
4064
|
+
```ts
|
|
4065
|
+
Error.stackTraceLimit
|
|
4066
|
+
```
|
|
3992
4067
|
|
|
3993
4068
|
## Functions
|
|
3994
4069
|
|
|
3995
4070
|
### assertValidFileContents()
|
|
3996
4071
|
|
|
3997
4072
|
```ts
|
|
3998
|
-
function assertValidFileContents(contents): void
|
|
4073
|
+
function assertValidFileContents(contents): void
|
|
3999
4074
|
```
|
|
4000
4075
|
|
|
4076
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/utils/assert-valid-file-contents.ts#L2)
|
|
4077
|
+
|
|
4001
4078
|
#### Parameters
|
|
4002
4079
|
|
|
4003
|
-
|
|
4080
|
+
##### contents
|
|
4081
|
+
|
|
4082
|
+
`any`
|
|
4004
4083
|
|
|
4005
4084
|
#### Returns
|
|
4006
4085
|
|
|
4007
4086
|
`void`
|
|
4008
4087
|
|
|
4009
|
-
|
|
4010
|
-
|
|
4011
|
-
[packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/assert-valid-file-contents.ts#L2)
|
|
4012
|
-
|
|
4013
|
-
---
|
|
4088
|
+
***
|
|
4014
4089
|
|
|
4015
4090
|
### assertValidFileOrDirectoryPath()
|
|
4016
4091
|
|
|
4017
4092
|
```ts
|
|
4018
|
-
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
4093
|
+
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
4019
4094
|
```
|
|
4020
4095
|
|
|
4096
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L2)
|
|
4097
|
+
|
|
4021
4098
|
#### Parameters
|
|
4022
4099
|
|
|
4023
|
-
|
|
4100
|
+
##### fileOrDirectoryPath
|
|
4101
|
+
|
|
4102
|
+
`any`
|
|
4024
4103
|
|
|
4025
4104
|
#### Returns
|
|
4026
4105
|
|
|
4027
4106
|
`void`
|
|
4028
4107
|
|
|
4029
|
-
|
|
4030
|
-
|
|
4031
|
-
[packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L2)
|
|
4032
|
-
|
|
4033
|
-
---
|
|
4108
|
+
***
|
|
4034
4109
|
|
|
4035
4110
|
### parseJson()
|
|
4036
4111
|
|
|
4037
|
-
####
|
|
4112
|
+
#### Call Signature
|
|
4038
4113
|
|
|
4039
4114
|
```ts
|
|
4040
|
-
function parseJson<T>(
|
|
4115
|
+
function parseJson<T>(
|
|
4116
|
+
string,
|
|
4117
|
+
filename?,
|
|
4118
|
+
options?): T
|
|
4041
4119
|
```
|
|
4042
4120
|
|
|
4121
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/utils/parse-json.ts#L60)
|
|
4122
|
+
|
|
4043
4123
|
##### Type Parameters
|
|
4044
4124
|
|
|
4045
4125
|
• **T** = `JsonValue`
|
|
4046
4126
|
|
|
4047
4127
|
##### Parameters
|
|
4048
4128
|
|
|
4049
|
-
|
|
4129
|
+
###### string
|
|
4050
4130
|
|
|
4051
|
-
|
|
4131
|
+
`string`
|
|
4052
4132
|
|
|
4053
|
-
|
|
4133
|
+
###### filename?
|
|
4054
4134
|
|
|
4055
|
-
|
|
4135
|
+
`string`
|
|
4056
4136
|
|
|
4057
|
-
|
|
4137
|
+
###### options?
|
|
4138
|
+
|
|
4139
|
+
`CodeFrameOptions`
|
|
4058
4140
|
|
|
4059
|
-
#####
|
|
4141
|
+
##### Returns
|
|
4060
4142
|
|
|
4061
|
-
|
|
4143
|
+
`T`
|
|
4062
4144
|
|
|
4063
|
-
####
|
|
4145
|
+
#### Call Signature
|
|
4064
4146
|
|
|
4065
4147
|
```ts
|
|
4066
|
-
function parseJson<T>(
|
|
4148
|
+
function parseJson<T>(
|
|
4149
|
+
string,
|
|
4150
|
+
reviver,
|
|
4151
|
+
fileName?,
|
|
4152
|
+
options?): T
|
|
4067
4153
|
```
|
|
4068
4154
|
|
|
4155
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/utils/parse-json.ts#L61)
|
|
4156
|
+
|
|
4069
4157
|
##### Type Parameters
|
|
4070
4158
|
|
|
4071
4159
|
• **T** = `JsonValue`
|
|
4072
4160
|
|
|
4073
4161
|
##### Parameters
|
|
4074
4162
|
|
|
4075
|
-
|
|
4163
|
+
###### string
|
|
4076
4164
|
|
|
4077
|
-
|
|
4165
|
+
`string`
|
|
4078
4166
|
|
|
4079
|
-
|
|
4167
|
+
###### reviver
|
|
4080
4168
|
|
|
4081
|
-
|
|
4169
|
+
(`this`, `key`, `value`) => `any`
|
|
4082
4170
|
|
|
4083
|
-
|
|
4171
|
+
###### fileName?
|
|
4084
4172
|
|
|
4085
|
-
`
|
|
4173
|
+
`string`
|
|
4086
4174
|
|
|
4087
|
-
|
|
4175
|
+
###### options?
|
|
4088
4176
|
|
|
4089
|
-
|
|
4177
|
+
`CodeFrameOptions`
|
|
4090
4178
|
|
|
4091
|
-
|
|
4179
|
+
##### Returns
|
|
4180
|
+
|
|
4181
|
+
`T`
|
|
4182
|
+
|
|
4183
|
+
***
|
|
4092
4184
|
|
|
4093
4185
|
### stripJsonComments()
|
|
4094
4186
|
|
|
4095
4187
|
```ts
|
|
4096
|
-
function stripJsonComments(jsonString, __namedParameters): string
|
|
4188
|
+
function stripJsonComments(jsonString, __namedParameters): string
|
|
4097
4189
|
```
|
|
4098
4190
|
|
|
4191
|
+
Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/utils/strip-json-comments.ts#L5)
|
|
4192
|
+
|
|
4099
4193
|
#### Parameters
|
|
4100
4194
|
|
|
4101
|
-
|
|
4195
|
+
##### jsonString
|
|
4102
4196
|
|
|
4103
|
-
|
|
4197
|
+
`string`
|
|
4104
4198
|
|
|
4105
|
-
|
|
4199
|
+
##### \_\_namedParameters
|
|
4106
4200
|
|
|
4107
|
-
|
|
4201
|
+
###### whitespace
|
|
4108
4202
|
|
|
4109
|
-
`
|
|
4203
|
+
`boolean` = `true`
|
|
4110
4204
|
|
|
4111
|
-
####
|
|
4205
|
+
#### Returns
|
|
4112
4206
|
|
|
4113
|
-
|
|
4207
|
+
`string`
|
|
4114
4208
|
|
|
4115
|
-
|
|
4209
|
+
***
|
|
4116
4210
|
|
|
4117
4211
|
### toPath()
|
|
4118
4212
|
|
|
4119
4213
|
```ts
|
|
4120
|
-
function toPath(urlOrPath): string
|
|
4214
|
+
function toPath(urlOrPath): string
|
|
4121
4215
|
```
|
|
4122
4216
|
|
|
4217
|
+
Defined in: node\_modules/.pnpm/@visulima+path@1.3.3/node\_modules/@visulima/path/dist/utils.d.mts:7
|
|
4218
|
+
|
|
4123
4219
|
#### Parameters
|
|
4124
4220
|
|
|
4125
|
-
|
|
4221
|
+
##### urlOrPath
|
|
4222
|
+
|
|
4223
|
+
`string` | `URL`
|
|
4126
4224
|
|
|
4127
4225
|
#### Returns
|
|
4128
4226
|
|
|
4129
4227
|
`string`
|
|
4228
|
+
# yaml
|
|
4229
|
+
|
|
4230
|
+
## Functions
|
|
4231
|
+
|
|
4232
|
+
### readYaml()
|
|
4233
|
+
|
|
4234
|
+
#### Call Signature
|
|
4235
|
+
|
|
4236
|
+
```ts
|
|
4237
|
+
function readYaml<R>(path, options?): Promise<R>
|
|
4238
|
+
```
|
|
4239
|
+
|
|
4240
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-yaml.ts#L6)
|
|
4241
|
+
|
|
4242
|
+
##### Type Parameters
|
|
4243
|
+
|
|
4244
|
+
• **R** = `Record`\<`string`, `unknown`\>
|
|
4245
|
+
|
|
4246
|
+
##### Parameters
|
|
4247
|
+
|
|
4248
|
+
###### path
|
|
4249
|
+
|
|
4250
|
+
`string` | `URL`
|
|
4251
|
+
|
|
4252
|
+
###### options?
|
|
4253
|
+
|
|
4254
|
+
`ReadYamlOptions`\<`"brotli"` \| `"gzip"` \| `"none"`\>
|
|
4255
|
+
|
|
4256
|
+
##### Returns
|
|
4257
|
+
|
|
4258
|
+
`Promise`\<`R`\>
|
|
4259
|
+
|
|
4260
|
+
#### Call Signature
|
|
4261
|
+
|
|
4262
|
+
```ts
|
|
4263
|
+
function readYaml<R>(
|
|
4264
|
+
path,
|
|
4265
|
+
reviver?,
|
|
4266
|
+
options?): Promise<R>
|
|
4267
|
+
```
|
|
4268
|
+
|
|
4269
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-yaml.ts#L7)
|
|
4270
|
+
|
|
4271
|
+
##### Type Parameters
|
|
4272
|
+
|
|
4273
|
+
• **R** = `Record`\<`string`, `unknown`\>
|
|
4274
|
+
|
|
4275
|
+
##### Parameters
|
|
4276
|
+
|
|
4277
|
+
###### path
|
|
4278
|
+
|
|
4279
|
+
`string` | `URL`
|
|
4280
|
+
|
|
4281
|
+
###### reviver?
|
|
4282
|
+
|
|
4283
|
+
`YamlReviver`
|
|
4284
|
+
|
|
4285
|
+
###### options?
|
|
4286
|
+
|
|
4287
|
+
`ReadYamlOptions`\<`"brotli"` \| `"gzip"` \| `"none"`\>
|
|
4130
4288
|
|
|
4131
|
-
|
|
4289
|
+
##### Returns
|
|
4290
|
+
|
|
4291
|
+
`Promise`\<`R`\>
|
|
4292
|
+
|
|
4293
|
+
***
|
|
4294
|
+
|
|
4295
|
+
### readYamlSync()
|
|
4296
|
+
|
|
4297
|
+
#### Call Signature
|
|
4298
|
+
|
|
4299
|
+
```ts
|
|
4300
|
+
function readYamlSync<R>(path, options?): R
|
|
4301
|
+
```
|
|
4302
|
+
|
|
4303
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
4304
|
+
|
|
4305
|
+
##### Type Parameters
|
|
4306
|
+
|
|
4307
|
+
• **R** = `Record`\<`string`, `unknown`\>
|
|
4308
|
+
|
|
4309
|
+
##### Parameters
|
|
4310
|
+
|
|
4311
|
+
###### path
|
|
4312
|
+
|
|
4313
|
+
`string` | `URL`
|
|
4314
|
+
|
|
4315
|
+
###### options?
|
|
4316
|
+
|
|
4317
|
+
`ReadYamlOptions`\<`"brotli"` \| `"gzip"` \| `"none"`\>
|
|
4318
|
+
|
|
4319
|
+
##### Returns
|
|
4320
|
+
|
|
4321
|
+
`R`
|
|
4322
|
+
|
|
4323
|
+
#### Call Signature
|
|
4324
|
+
|
|
4325
|
+
```ts
|
|
4326
|
+
function readYamlSync<R>(
|
|
4327
|
+
path,
|
|
4328
|
+
reviver?,
|
|
4329
|
+
options?): R
|
|
4330
|
+
```
|
|
4331
|
+
|
|
4332
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
4333
|
+
|
|
4334
|
+
##### Type Parameters
|
|
4335
|
+
|
|
4336
|
+
• **R** = `Record`\<`string`, `unknown`\>
|
|
4337
|
+
|
|
4338
|
+
##### Parameters
|
|
4339
|
+
|
|
4340
|
+
###### path
|
|
4341
|
+
|
|
4342
|
+
`string` | `URL`
|
|
4343
|
+
|
|
4344
|
+
###### reviver?
|
|
4345
|
+
|
|
4346
|
+
`YamlReviver`
|
|
4347
|
+
|
|
4348
|
+
###### options?
|
|
4349
|
+
|
|
4350
|
+
`ReadYamlOptions`\<`"brotli"` \| `"gzip"` \| `"none"`\>
|
|
4351
|
+
|
|
4352
|
+
##### Returns
|
|
4353
|
+
|
|
4354
|
+
`R`
|
|
4355
|
+
|
|
4356
|
+
***
|
|
4357
|
+
|
|
4358
|
+
### writeYaml()
|
|
4359
|
+
|
|
4360
|
+
#### Call Signature
|
|
4361
|
+
|
|
4362
|
+
```ts
|
|
4363
|
+
function writeYaml(
|
|
4364
|
+
path,
|
|
4365
|
+
data,
|
|
4366
|
+
options?): Promise<void>
|
|
4367
|
+
```
|
|
4368
|
+
|
|
4369
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-yaml.ts#L10)
|
|
4370
|
+
|
|
4371
|
+
##### Parameters
|
|
4372
|
+
|
|
4373
|
+
###### path
|
|
4374
|
+
|
|
4375
|
+
`string` | `URL`
|
|
4376
|
+
|
|
4377
|
+
###### data
|
|
4378
|
+
|
|
4379
|
+
`any`
|
|
4380
|
+
|
|
4381
|
+
###### options?
|
|
4382
|
+
|
|
4383
|
+
`Options`
|
|
4384
|
+
|
|
4385
|
+
##### Returns
|
|
4386
|
+
|
|
4387
|
+
`Promise`\<`void`\>
|
|
4388
|
+
|
|
4389
|
+
#### Call Signature
|
|
4390
|
+
|
|
4391
|
+
```ts
|
|
4392
|
+
function writeYaml(
|
|
4393
|
+
path,
|
|
4394
|
+
data,
|
|
4395
|
+
replacer?,
|
|
4396
|
+
options?): Promise<void>
|
|
4397
|
+
```
|
|
4398
|
+
|
|
4399
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-yaml.ts#L16)
|
|
4400
|
+
|
|
4401
|
+
##### Parameters
|
|
4402
|
+
|
|
4403
|
+
###### path
|
|
4404
|
+
|
|
4405
|
+
`string` | `URL`
|
|
4406
|
+
|
|
4407
|
+
###### data
|
|
4408
|
+
|
|
4409
|
+
`any`
|
|
4410
|
+
|
|
4411
|
+
###### replacer?
|
|
4412
|
+
|
|
4413
|
+
[`JsonReplacer`](index.md#jsonreplacer)
|
|
4414
|
+
|
|
4415
|
+
###### options?
|
|
4416
|
+
|
|
4417
|
+
`string` | `number` | `Options`
|
|
4418
|
+
|
|
4419
|
+
##### Returns
|
|
4420
|
+
|
|
4421
|
+
`Promise`\<`void`\>
|
|
4422
|
+
|
|
4423
|
+
***
|
|
4424
|
+
|
|
4425
|
+
### writeYamlSync()
|
|
4426
|
+
|
|
4427
|
+
#### Call Signature
|
|
4428
|
+
|
|
4429
|
+
```ts
|
|
4430
|
+
function writeYamlSync(
|
|
4431
|
+
path,
|
|
4432
|
+
data,
|
|
4433
|
+
options?): void
|
|
4434
|
+
```
|
|
4435
|
+
|
|
4436
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-yaml-sync.ts#L10)
|
|
4437
|
+
|
|
4438
|
+
##### Parameters
|
|
4439
|
+
|
|
4440
|
+
###### path
|
|
4441
|
+
|
|
4442
|
+
`string` | `URL`
|
|
4443
|
+
|
|
4444
|
+
###### data
|
|
4445
|
+
|
|
4446
|
+
`any`
|
|
4447
|
+
|
|
4448
|
+
###### options?
|
|
4449
|
+
|
|
4450
|
+
`Options`
|
|
4451
|
+
|
|
4452
|
+
##### Returns
|
|
4453
|
+
|
|
4454
|
+
`void`
|
|
4455
|
+
|
|
4456
|
+
#### Call Signature
|
|
4457
|
+
|
|
4458
|
+
```ts
|
|
4459
|
+
function writeYamlSync(
|
|
4460
|
+
path,
|
|
4461
|
+
data,
|
|
4462
|
+
replacer?,
|
|
4463
|
+
options?): void
|
|
4464
|
+
```
|
|
4465
|
+
|
|
4466
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/write/write-yaml-sync.ts#L16)
|
|
4467
|
+
|
|
4468
|
+
##### Parameters
|
|
4469
|
+
|
|
4470
|
+
###### path
|
|
4471
|
+
|
|
4472
|
+
`string` | `URL`
|
|
4473
|
+
|
|
4474
|
+
###### data
|
|
4475
|
+
|
|
4476
|
+
`any`
|
|
4477
|
+
|
|
4478
|
+
###### replacer?
|
|
4479
|
+
|
|
4480
|
+
[`JsonReplacer`](index.md#jsonreplacer)
|
|
4481
|
+
|
|
4482
|
+
###### options?
|
|
4483
|
+
|
|
4484
|
+
`string` | `number` | `Options`
|
|
4485
|
+
|
|
4486
|
+
##### Returns
|
|
4487
|
+
|
|
4488
|
+
`void`
|
|
4489
|
+
|
|
4490
|
+
## Type Aliases
|
|
4491
|
+
|
|
4492
|
+
### YamlReplacer
|
|
4493
|
+
|
|
4494
|
+
```ts
|
|
4495
|
+
type YamlReplacer = JsonReplacer;
|
|
4496
|
+
```
|
|
4132
4497
|
|
|
4133
|
-
|
|
4498
|
+
Defined in: [packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/4df22689997867be986ba7b5b5d744984e513ddf/packages/fs/src/types.ts#L144)
|
|
4134
4499
|
|
|
4135
4500
|
<!-- /TYPEDOC -->
|
|
4136
4501
|
|