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