@visulima/fs 3.1.1 → 3.1.3
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 +34 -0
- package/README.md +381 -313
- package/dist/index.cjs +20 -20
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.mjs +22 -22
- package/dist/packem_shared/{collect-DIZ3yuRZ.mjs → collect-B615pR8z.mjs} +1 -1
- package/dist/packem_shared/{collect-DZVa0P7v.cjs → collect-DHldhy_s.cjs} +1 -1
- package/dist/packem_shared/{collectSync-CGjdb50I.mjs → collectSync-CYuBdXWI.mjs} +1 -1
- package/dist/packem_shared/{collectSync-BaA0s001.cjs → collectSync-zahGoTi-.cjs} +1 -1
- package/dist/packem_shared/{ensureDir-iUK2ga5M.cjs → ensureDir-BOfUZlxG.cjs} +1 -1
- package/dist/packem_shared/{ensureDir-XiBlkOLR.mjs → ensureDir-BnA_fY1A.mjs} +1 -1
- package/dist/packem_shared/{ensureDirSync-CXdMkg0Y.cjs → ensureDirSync-DHmWi3CF.cjs} +1 -1
- package/dist/packem_shared/{ensureDirSync-2IFUHFK2.mjs → ensureDirSync-Dm4az3YF.mjs} +1 -1
- package/dist/packem_shared/{ensureFile-C2bWlBEa.mjs → ensureFile-BKrJMHfr.mjs} +2 -2
- package/dist/packem_shared/{ensureFile-Br8tFUJ7.cjs → ensureFile-CeGryLJI.cjs} +2 -2
- package/dist/packem_shared/{ensureFileSync-CZzSkNGC.cjs → ensureFileSync-B7THM1sN.cjs} +2 -2
- package/dist/packem_shared/{ensureFileSync-DkFfhOEs.mjs → ensureFileSync-BnhFBXaR.mjs} +2 -2
- package/dist/packem_shared/{ensureLink-CFiabAD3.mjs → ensureLink-ChsWDTK5.mjs} +1 -1
- package/dist/packem_shared/{ensureLink-Dqw5GBDq.cjs → ensureLink-CrxLNmHE.cjs} +1 -1
- package/dist/packem_shared/{ensureLinkSync-Dk-YeRg6.mjs → ensureLinkSync-CG-DTUoV.mjs} +1 -1
- package/dist/packem_shared/{ensureLinkSync-BVw3h6sK.cjs → ensureLinkSync-D8uMqLh4.cjs} +1 -1
- package/dist/packem_shared/{ensureSymlink-CSqngPoI.mjs → ensureSymlink-BwJ_QhzJ.mjs} +2 -2
- package/dist/packem_shared/{ensureSymlink-CFSfreco.cjs → ensureSymlink-D_ieOVYa.cjs} +2 -2
- package/dist/packem_shared/{ensureSymlinkSync-QRaNZX2E.mjs → ensureSymlinkSync-BamG29QK.mjs} +2 -2
- package/dist/packem_shared/{ensureSymlinkSync-BCd9bzsx.cjs → ensureSymlinkSync-DTMvUYZD.cjs} +2 -2
- package/dist/packem_shared/{findUp-C8_QpAtD.mjs → findUp-D5W-MTpT.mjs} +4 -4
- package/dist/packem_shared/{findUp-DA511Swp.cjs → findUp-DVIYN2wV.cjs} +4 -4
- package/dist/packem_shared/{findUpSync-u1rGibzw.cjs → findUpSync-BOiVyUOx.cjs} +4 -4
- package/dist/packem_shared/{findUpSync-DVOd3V-q.mjs → findUpSync-DL3NPCYg.mjs} +4 -4
- package/dist/packem_shared/{get-file-info-type-BpRzQHvd.cjs → get-file-info-type-BlryFnpp.cjs} +1 -1
- package/dist/packem_shared/{get-file-info-type-CeiZ6n6g.mjs → get-file-info-type-ButUVD6d.mjs} +1 -1
- package/dist/packem_shared/{index-ngvEMjBI.cjs → index-BVZL6YMm.cjs} +2 -2
- package/dist/packem_shared/{index-ajT9ecry.mjs → index-r9Pk9gBe.mjs} +2 -2
- package/dist/packem_shared/{parseJson-DcUo4Rpt.cjs → parseJson-5geAXtlm.cjs} +3 -4
- package/dist/packem_shared/{parseJson-n9THWOFI.mjs → parseJson-D7XcVuDD.mjs} +3 -4
- package/dist/packem_shared/{readFile-DUM-xNoB.mjs → readFile-b7UBVv17.mjs} +1 -1
- package/dist/packem_shared/{readFileSync-Cck96_o0.mjs → readFileSync-CkEJBqZB.mjs} +1 -1
- package/dist/packem_shared/{readJson-JrCHMN3m.cjs → readJson-CG6Pm3bL.cjs} +3 -3
- package/dist/packem_shared/{readJson-DIHRleEE.mjs → readJson-Ddq4aS0W.mjs} +4 -4
- package/dist/packem_shared/{readJsonSync-BPfxTuQL.mjs → readJsonSync-C1IyJccj.mjs} +4 -4
- package/dist/packem_shared/{readJsonSync-o_MAOlUv.cjs → readJsonSync-DXVlgWNf.cjs} +3 -3
- package/dist/packem_shared/{readYaml-vVKK8ZzY.mjs → readYaml-C5MSs2GE.mjs} +1 -1
- package/dist/packem_shared/{readYamlSync-MOLH4gXB.mjs → readYamlSync-CPjA-DLv.mjs} +1 -1
- package/dist/packem_shared/{types-CiwAWOQj.d.ts → types-Crz-rGlC.d.cts} +1 -1
- package/dist/packem_shared/{types-CiwAWOQj.d.cts → types-Crz-rGlC.d.mts} +1 -1
- package/dist/packem_shared/{types-CiwAWOQj.d.mts → types-Crz-rGlC.d.ts} +1 -1
- package/dist/packem_shared/{walk-CSp2zlI2.mjs → walk-BIh3_ljI.mjs} +3 -3
- package/dist/packem_shared/{walk-1LfF6MKY.cjs → walk-PpNwjtjX.cjs} +3 -3
- package/dist/packem_shared/{walkSync-DgPj93NL.cjs → walkSync-BidUqvMI.cjs} +3 -3
- package/dist/packem_shared/{walkSync-BzxdFWLU.mjs → walkSync-CFwkbDz9.mjs} +3 -3
- package/dist/packem_shared/{writeFile-CzpkxDqy.mjs → writeFile-BZ4JBQxc.mjs} +1 -1
- package/dist/packem_shared/{writeFile-CnWc2ZOW.cjs → writeFile-DgCFRCe5.cjs} +1 -1
- package/dist/packem_shared/{writeFileSync-DYRpumrj.mjs → writeFileSync-Ctw5pNQH.mjs} +1 -1
- package/dist/packem_shared/{writeFileSync-da4qD9Nz.cjs → writeFileSync-DzXhx1pF.cjs} +1 -1
- package/dist/packem_shared/{writeJson-9_C3v2B3.cjs → writeJson-Bh4sU1Ly.cjs} +2 -2
- package/dist/packem_shared/{writeJson-V9KBXfw2.mjs → writeJson-axO_14yL.mjs} +2 -2
- package/dist/packem_shared/{writeJsonSync-CyaXNy3X.mjs → writeJsonSync-CzngmuKb.mjs} +2 -2
- package/dist/packem_shared/{writeJsonSync-C5kkxqE7.cjs → writeJsonSync-HFdHjunl.cjs} +2 -2
- package/dist/packem_shared/{writeYaml-DDLK7NDr.cjs → writeYaml-C0YnZ1bp.cjs} +1 -1
- package/dist/packem_shared/{writeYaml-DJ17fqNj.mjs → writeYaml-Cuj4H9ut.mjs} +1 -1
- package/dist/packem_shared/{writeYamlSync-DST-W6N7.cjs → writeYamlSync-BBNLBbQK.cjs} +1 -1
- package/dist/packem_shared/{writeYamlSync-C6nrcP2e.mjs → writeYamlSync-cL8f07FV.mjs} +1 -1
- package/dist/size.mjs +1 -1
- package/dist/utils.cjs +1 -1
- package/dist/utils.d.cts +1 -1
- package/dist/utils.d.mts +1 -1
- package/dist/utils.d.ts +1 -1
- package/dist/utils.mjs +1 -1
- package/dist/yaml.cjs +2 -2
- package/dist/yaml.d.cts +1 -1
- package/dist/yaml.d.mts +1 -1
- package/dist/yaml.d.ts +1 -1
- package/dist/yaml.mjs +4 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -459,7 +459,7 @@ The printable section of the JSON which produces the error.
|
|
|
459
459
|
|
|
460
460
|
### AlreadyExistsError
|
|
461
461
|
|
|
462
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
462
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/already-exists-error.ts#L4)
|
|
463
463
|
|
|
464
464
|
Error thrown when file already exists.
|
|
465
465
|
|
|
@@ -469,13 +469,13 @@ Error thrown when file already exists.
|
|
|
469
469
|
|
|
470
470
|
#### Constructors
|
|
471
471
|
|
|
472
|
-
#####
|
|
472
|
+
##### Constructor
|
|
473
473
|
|
|
474
474
|
```ts
|
|
475
|
-
new AlreadyExistsError(message): AlreadyExistsError
|
|
475
|
+
new AlreadyExistsError(message): AlreadyExistsError;
|
|
476
476
|
```
|
|
477
477
|
|
|
478
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
478
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/already-exists-error.ts#L9)
|
|
479
479
|
|
|
480
480
|
Creates a new instance.
|
|
481
481
|
|
|
@@ -489,7 +489,7 @@ The error message.
|
|
|
489
489
|
|
|
490
490
|
###### Returns
|
|
491
491
|
|
|
492
|
-
[`AlreadyExistsError`](
|
|
492
|
+
[`AlreadyExistsError`](#alreadyexistserror)
|
|
493
493
|
|
|
494
494
|
###### Overrides
|
|
495
495
|
|
|
@@ -504,10 +504,10 @@ Error.constructor
|
|
|
504
504
|
###### Get Signature
|
|
505
505
|
|
|
506
506
|
```ts
|
|
507
|
-
get code(): string
|
|
507
|
+
get code(): string;
|
|
508
508
|
```
|
|
509
509
|
|
|
510
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
510
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/already-exists-error.ts#L14)
|
|
511
511
|
|
|
512
512
|
###### Returns
|
|
513
513
|
|
|
@@ -516,10 +516,10 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:14](https://github.co
|
|
|
516
516
|
###### Set Signature
|
|
517
517
|
|
|
518
518
|
```ts
|
|
519
|
-
set code(_name): void
|
|
519
|
+
set code(_name): void;
|
|
520
520
|
```
|
|
521
521
|
|
|
522
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:19](https://github.com/visulima/visulima/blob/
|
|
522
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/already-exists-error.ts#L19)
|
|
523
523
|
|
|
524
524
|
###### Parameters
|
|
525
525
|
|
|
@@ -536,10 +536,10 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:19](https://github.co
|
|
|
536
536
|
###### Get Signature
|
|
537
537
|
|
|
538
538
|
```ts
|
|
539
|
-
get name(): string
|
|
539
|
+
get name(): string;
|
|
540
540
|
```
|
|
541
541
|
|
|
542
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
542
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/already-exists-error.ts#L24)
|
|
543
543
|
|
|
544
544
|
###### Returns
|
|
545
545
|
|
|
@@ -548,10 +548,10 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:24](https://github.co
|
|
|
548
548
|
###### Set Signature
|
|
549
549
|
|
|
550
550
|
```ts
|
|
551
|
-
set name(_name): void
|
|
551
|
+
set name(_name): void;
|
|
552
552
|
```
|
|
553
553
|
|
|
554
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:29](https://github.com/visulima/visulima/blob/
|
|
554
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:29](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/already-exists-error.ts#L29)
|
|
555
555
|
|
|
556
556
|
###### Parameters
|
|
557
557
|
|
|
@@ -574,7 +574,7 @@ Error.name
|
|
|
574
574
|
##### captureStackTrace()
|
|
575
575
|
|
|
576
576
|
```ts
|
|
577
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
577
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
578
578
|
```
|
|
579
579
|
|
|
580
580
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -609,7 +609,7 @@ Error.captureStackTrace
|
|
|
609
609
|
optional cause: unknown;
|
|
610
610
|
```
|
|
611
611
|
|
|
612
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
612
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
613
613
|
|
|
614
614
|
###### Inherited from
|
|
615
615
|
|
|
@@ -623,7 +623,7 @@ Error.cause
|
|
|
623
623
|
message: string;
|
|
624
624
|
```
|
|
625
625
|
|
|
626
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
626
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
627
627
|
|
|
628
628
|
###### Inherited from
|
|
629
629
|
|
|
@@ -637,7 +637,7 @@ Error.message
|
|
|
637
637
|
optional stack: string;
|
|
638
638
|
```
|
|
639
639
|
|
|
640
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
640
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
641
641
|
|
|
642
642
|
###### Inherited from
|
|
643
643
|
|
|
@@ -697,7 +697,7 @@ Error.stackTraceLimit
|
|
|
697
697
|
|
|
698
698
|
### DirectoryError
|
|
699
699
|
|
|
700
|
-
Defined in: [packages/fs/src/error/directory-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
700
|
+
Defined in: [packages/fs/src/error/directory-error.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/directory-error.ts#L4)
|
|
701
701
|
|
|
702
702
|
Error thrown when an operation is not allowed on a directory.
|
|
703
703
|
|
|
@@ -707,13 +707,13 @@ Error thrown when an operation is not allowed on a directory.
|
|
|
707
707
|
|
|
708
708
|
#### Constructors
|
|
709
709
|
|
|
710
|
-
#####
|
|
710
|
+
##### Constructor
|
|
711
711
|
|
|
712
712
|
```ts
|
|
713
|
-
new DirectoryError(message): DirectoryError
|
|
713
|
+
new DirectoryError(message): DirectoryError;
|
|
714
714
|
```
|
|
715
715
|
|
|
716
|
-
Defined in: [packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
716
|
+
Defined in: [packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/directory-error.ts#L9)
|
|
717
717
|
|
|
718
718
|
Creates a new instance.
|
|
719
719
|
|
|
@@ -727,7 +727,7 @@ The error message.
|
|
|
727
727
|
|
|
728
728
|
###### Returns
|
|
729
729
|
|
|
730
|
-
[`DirectoryError`](
|
|
730
|
+
[`DirectoryError`](#directoryerror)
|
|
731
731
|
|
|
732
732
|
###### Overrides
|
|
733
733
|
|
|
@@ -742,10 +742,10 @@ Error.constructor
|
|
|
742
742
|
###### Get Signature
|
|
743
743
|
|
|
744
744
|
```ts
|
|
745
|
-
get code(): string
|
|
745
|
+
get code(): string;
|
|
746
746
|
```
|
|
747
747
|
|
|
748
|
-
Defined in: [packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
748
|
+
Defined in: [packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/directory-error.ts#L14)
|
|
749
749
|
|
|
750
750
|
###### Returns
|
|
751
751
|
|
|
@@ -754,10 +754,10 @@ Defined in: [packages/fs/src/error/directory-error.ts:14](https://github.com/vis
|
|
|
754
754
|
###### Set Signature
|
|
755
755
|
|
|
756
756
|
```ts
|
|
757
|
-
set code(_name): void
|
|
757
|
+
set code(_name): void;
|
|
758
758
|
```
|
|
759
759
|
|
|
760
|
-
Defined in: [packages/fs/src/error/directory-error.ts:19](https://github.com/visulima/visulima/blob/
|
|
760
|
+
Defined in: [packages/fs/src/error/directory-error.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/directory-error.ts#L19)
|
|
761
761
|
|
|
762
762
|
###### Parameters
|
|
763
763
|
|
|
@@ -774,10 +774,10 @@ Defined in: [packages/fs/src/error/directory-error.ts:19](https://github.com/vis
|
|
|
774
774
|
###### Get Signature
|
|
775
775
|
|
|
776
776
|
```ts
|
|
777
|
-
get name(): string
|
|
777
|
+
get name(): string;
|
|
778
778
|
```
|
|
779
779
|
|
|
780
|
-
Defined in: [packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
780
|
+
Defined in: [packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/directory-error.ts#L24)
|
|
781
781
|
|
|
782
782
|
###### Returns
|
|
783
783
|
|
|
@@ -786,10 +786,10 @@ Defined in: [packages/fs/src/error/directory-error.ts:24](https://github.com/vis
|
|
|
786
786
|
###### Set Signature
|
|
787
787
|
|
|
788
788
|
```ts
|
|
789
|
-
set name(_name): void
|
|
789
|
+
set name(_name): void;
|
|
790
790
|
```
|
|
791
791
|
|
|
792
|
-
Defined in: [packages/fs/src/error/directory-error.ts:29](https://github.com/visulima/visulima/blob/
|
|
792
|
+
Defined in: [packages/fs/src/error/directory-error.ts:29](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/directory-error.ts#L29)
|
|
793
793
|
|
|
794
794
|
###### Parameters
|
|
795
795
|
|
|
@@ -812,7 +812,7 @@ Error.name
|
|
|
812
812
|
##### captureStackTrace()
|
|
813
813
|
|
|
814
814
|
```ts
|
|
815
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
815
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
816
816
|
```
|
|
817
817
|
|
|
818
818
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -847,7 +847,7 @@ Error.captureStackTrace
|
|
|
847
847
|
optional cause: unknown;
|
|
848
848
|
```
|
|
849
849
|
|
|
850
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
850
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
851
851
|
|
|
852
852
|
###### Inherited from
|
|
853
853
|
|
|
@@ -861,7 +861,7 @@ Error.cause
|
|
|
861
861
|
message: string;
|
|
862
862
|
```
|
|
863
863
|
|
|
864
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
864
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
865
865
|
|
|
866
866
|
###### Inherited from
|
|
867
867
|
|
|
@@ -875,7 +875,7 @@ Error.message
|
|
|
875
875
|
optional stack: string;
|
|
876
876
|
```
|
|
877
877
|
|
|
878
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
878
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
879
879
|
|
|
880
880
|
###### Inherited from
|
|
881
881
|
|
|
@@ -935,7 +935,7 @@ Error.stackTraceLimit
|
|
|
935
935
|
|
|
936
936
|
### NotEmptyError
|
|
937
937
|
|
|
938
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
938
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-empty-error.ts#L4)
|
|
939
939
|
|
|
940
940
|
Error thrown when a directory is not empty.
|
|
941
941
|
|
|
@@ -945,13 +945,13 @@ Error thrown when a directory is not empty.
|
|
|
945
945
|
|
|
946
946
|
#### Constructors
|
|
947
947
|
|
|
948
|
-
#####
|
|
948
|
+
##### Constructor
|
|
949
949
|
|
|
950
950
|
```ts
|
|
951
|
-
new NotEmptyError(message): NotEmptyError
|
|
951
|
+
new NotEmptyError(message): NotEmptyError;
|
|
952
952
|
```
|
|
953
953
|
|
|
954
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
954
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-empty-error.ts#L9)
|
|
955
955
|
|
|
956
956
|
Creates a new instance.
|
|
957
957
|
|
|
@@ -965,7 +965,7 @@ The error message.
|
|
|
965
965
|
|
|
966
966
|
###### Returns
|
|
967
967
|
|
|
968
|
-
[`NotEmptyError`](
|
|
968
|
+
[`NotEmptyError`](#notemptyerror)
|
|
969
969
|
|
|
970
970
|
###### Overrides
|
|
971
971
|
|
|
@@ -980,10 +980,10 @@ Error.constructor
|
|
|
980
980
|
###### Get Signature
|
|
981
981
|
|
|
982
982
|
```ts
|
|
983
|
-
get code(): string
|
|
983
|
+
get code(): string;
|
|
984
984
|
```
|
|
985
985
|
|
|
986
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
986
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-empty-error.ts#L14)
|
|
987
987
|
|
|
988
988
|
###### Returns
|
|
989
989
|
|
|
@@ -992,10 +992,10 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:14](https://github.com/vis
|
|
|
992
992
|
###### Set Signature
|
|
993
993
|
|
|
994
994
|
```ts
|
|
995
|
-
set code(_name): void
|
|
995
|
+
set code(_name): void;
|
|
996
996
|
```
|
|
997
997
|
|
|
998
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:19](https://github.com/visulima/visulima/blob/
|
|
998
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-empty-error.ts#L19)
|
|
999
999
|
|
|
1000
1000
|
###### Parameters
|
|
1001
1001
|
|
|
@@ -1012,10 +1012,10 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:19](https://github.com/vis
|
|
|
1012
1012
|
###### Get Signature
|
|
1013
1013
|
|
|
1014
1014
|
```ts
|
|
1015
|
-
get name(): string
|
|
1015
|
+
get name(): string;
|
|
1016
1016
|
```
|
|
1017
1017
|
|
|
1018
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1018
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-empty-error.ts#L24)
|
|
1019
1019
|
|
|
1020
1020
|
###### Returns
|
|
1021
1021
|
|
|
@@ -1024,10 +1024,10 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:24](https://github.com/vis
|
|
|
1024
1024
|
###### Set Signature
|
|
1025
1025
|
|
|
1026
1026
|
```ts
|
|
1027
|
-
set name(_name): void
|
|
1027
|
+
set name(_name): void;
|
|
1028
1028
|
```
|
|
1029
1029
|
|
|
1030
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:29](https://github.com/visulima/visulima/blob/
|
|
1030
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:29](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-empty-error.ts#L29)
|
|
1031
1031
|
|
|
1032
1032
|
###### Parameters
|
|
1033
1033
|
|
|
@@ -1050,7 +1050,7 @@ Error.name
|
|
|
1050
1050
|
##### captureStackTrace()
|
|
1051
1051
|
|
|
1052
1052
|
```ts
|
|
1053
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1053
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
1054
1054
|
```
|
|
1055
1055
|
|
|
1056
1056
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -1085,7 +1085,7 @@ Error.captureStackTrace
|
|
|
1085
1085
|
optional cause: unknown;
|
|
1086
1086
|
```
|
|
1087
1087
|
|
|
1088
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1088
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1089
1089
|
|
|
1090
1090
|
###### Inherited from
|
|
1091
1091
|
|
|
@@ -1099,7 +1099,7 @@ Error.cause
|
|
|
1099
1099
|
message: string;
|
|
1100
1100
|
```
|
|
1101
1101
|
|
|
1102
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1102
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1103
1103
|
|
|
1104
1104
|
###### Inherited from
|
|
1105
1105
|
|
|
@@ -1113,7 +1113,7 @@ Error.message
|
|
|
1113
1113
|
optional stack: string;
|
|
1114
1114
|
```
|
|
1115
1115
|
|
|
1116
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1116
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1117
1117
|
|
|
1118
1118
|
###### Inherited from
|
|
1119
1119
|
|
|
@@ -1173,7 +1173,7 @@ Error.stackTraceLimit
|
|
|
1173
1173
|
|
|
1174
1174
|
### NotFoundError
|
|
1175
1175
|
|
|
1176
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
1176
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-found-error.ts#L4)
|
|
1177
1177
|
|
|
1178
1178
|
Error thrown when a file or directory is not found.
|
|
1179
1179
|
|
|
@@ -1183,13 +1183,13 @@ Error thrown when a file or directory is not found.
|
|
|
1183
1183
|
|
|
1184
1184
|
#### Constructors
|
|
1185
1185
|
|
|
1186
|
-
#####
|
|
1186
|
+
##### Constructor
|
|
1187
1187
|
|
|
1188
1188
|
```ts
|
|
1189
|
-
new NotFoundError(message): NotFoundError
|
|
1189
|
+
new NotFoundError(message): NotFoundError;
|
|
1190
1190
|
```
|
|
1191
1191
|
|
|
1192
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1192
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-found-error.ts#L9)
|
|
1193
1193
|
|
|
1194
1194
|
Creates a new instance.
|
|
1195
1195
|
|
|
@@ -1203,7 +1203,7 @@ The error message.
|
|
|
1203
1203
|
|
|
1204
1204
|
###### Returns
|
|
1205
1205
|
|
|
1206
|
-
[`NotFoundError`](
|
|
1206
|
+
[`NotFoundError`](#notfounderror)
|
|
1207
1207
|
|
|
1208
1208
|
###### Overrides
|
|
1209
1209
|
|
|
@@ -1218,10 +1218,10 @@ Error.constructor
|
|
|
1218
1218
|
###### Get Signature
|
|
1219
1219
|
|
|
1220
1220
|
```ts
|
|
1221
|
-
get code(): string
|
|
1221
|
+
get code(): string;
|
|
1222
1222
|
```
|
|
1223
1223
|
|
|
1224
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
1224
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-found-error.ts#L14)
|
|
1225
1225
|
|
|
1226
1226
|
###### Returns
|
|
1227
1227
|
|
|
@@ -1230,10 +1230,10 @@ Defined in: [packages/fs/src/error/not-found-error.ts:14](https://github.com/vis
|
|
|
1230
1230
|
###### Set Signature
|
|
1231
1231
|
|
|
1232
1232
|
```ts
|
|
1233
|
-
set code(_name): void
|
|
1233
|
+
set code(_name): void;
|
|
1234
1234
|
```
|
|
1235
1235
|
|
|
1236
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:19](https://github.com/visulima/visulima/blob/
|
|
1236
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-found-error.ts#L19)
|
|
1237
1237
|
|
|
1238
1238
|
###### Parameters
|
|
1239
1239
|
|
|
@@ -1250,10 +1250,10 @@ Defined in: [packages/fs/src/error/not-found-error.ts:19](https://github.com/vis
|
|
|
1250
1250
|
###### Get Signature
|
|
1251
1251
|
|
|
1252
1252
|
```ts
|
|
1253
|
-
get name(): string
|
|
1253
|
+
get name(): string;
|
|
1254
1254
|
```
|
|
1255
1255
|
|
|
1256
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1256
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-found-error.ts#L24)
|
|
1257
1257
|
|
|
1258
1258
|
###### Returns
|
|
1259
1259
|
|
|
@@ -1262,10 +1262,10 @@ Defined in: [packages/fs/src/error/not-found-error.ts:24](https://github.com/vis
|
|
|
1262
1262
|
###### Set Signature
|
|
1263
1263
|
|
|
1264
1264
|
```ts
|
|
1265
|
-
set name(_name): void
|
|
1265
|
+
set name(_name): void;
|
|
1266
1266
|
```
|
|
1267
1267
|
|
|
1268
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:29](https://github.com/visulima/visulima/blob/
|
|
1268
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:29](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/not-found-error.ts#L29)
|
|
1269
1269
|
|
|
1270
1270
|
###### Parameters
|
|
1271
1271
|
|
|
@@ -1288,7 +1288,7 @@ Error.name
|
|
|
1288
1288
|
##### captureStackTrace()
|
|
1289
1289
|
|
|
1290
1290
|
```ts
|
|
1291
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1291
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
1292
1292
|
```
|
|
1293
1293
|
|
|
1294
1294
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -1323,7 +1323,7 @@ Error.captureStackTrace
|
|
|
1323
1323
|
optional cause: unknown;
|
|
1324
1324
|
```
|
|
1325
1325
|
|
|
1326
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1326
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1327
1327
|
|
|
1328
1328
|
###### Inherited from
|
|
1329
1329
|
|
|
@@ -1337,7 +1337,7 @@ Error.cause
|
|
|
1337
1337
|
message: string;
|
|
1338
1338
|
```
|
|
1339
1339
|
|
|
1340
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1340
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1341
1341
|
|
|
1342
1342
|
###### Inherited from
|
|
1343
1343
|
|
|
@@ -1351,7 +1351,7 @@ Error.message
|
|
|
1351
1351
|
optional stack: string;
|
|
1352
1352
|
```
|
|
1353
1353
|
|
|
1354
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1354
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1355
1355
|
|
|
1356
1356
|
###### Inherited from
|
|
1357
1357
|
|
|
@@ -1411,7 +1411,7 @@ Error.stackTraceLimit
|
|
|
1411
1411
|
|
|
1412
1412
|
### PermissionError
|
|
1413
1413
|
|
|
1414
|
-
Defined in: [packages/fs/src/error/permission-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
1414
|
+
Defined in: [packages/fs/src/error/permission-error.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/permission-error.ts#L4)
|
|
1415
1415
|
|
|
1416
1416
|
Error thrown when an operation is not permitted.
|
|
1417
1417
|
|
|
@@ -1421,13 +1421,13 @@ Error thrown when an operation is not permitted.
|
|
|
1421
1421
|
|
|
1422
1422
|
#### Constructors
|
|
1423
1423
|
|
|
1424
|
-
#####
|
|
1424
|
+
##### Constructor
|
|
1425
1425
|
|
|
1426
1426
|
```ts
|
|
1427
|
-
new PermissionError(message): PermissionError
|
|
1427
|
+
new PermissionError(message): PermissionError;
|
|
1428
1428
|
```
|
|
1429
1429
|
|
|
1430
|
-
Defined in: [packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1430
|
+
Defined in: [packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/permission-error.ts#L9)
|
|
1431
1431
|
|
|
1432
1432
|
Creates a new instance.
|
|
1433
1433
|
|
|
@@ -1441,7 +1441,7 @@ The error message.
|
|
|
1441
1441
|
|
|
1442
1442
|
###### Returns
|
|
1443
1443
|
|
|
1444
|
-
[`PermissionError`](
|
|
1444
|
+
[`PermissionError`](#permissionerror)
|
|
1445
1445
|
|
|
1446
1446
|
###### Overrides
|
|
1447
1447
|
|
|
@@ -1456,10 +1456,10 @@ Error.constructor
|
|
|
1456
1456
|
###### Get Signature
|
|
1457
1457
|
|
|
1458
1458
|
```ts
|
|
1459
|
-
get code(): string
|
|
1459
|
+
get code(): string;
|
|
1460
1460
|
```
|
|
1461
1461
|
|
|
1462
|
-
Defined in: [packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
1462
|
+
Defined in: [packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/permission-error.ts#L14)
|
|
1463
1463
|
|
|
1464
1464
|
###### Returns
|
|
1465
1465
|
|
|
@@ -1468,10 +1468,10 @@ Defined in: [packages/fs/src/error/permission-error.ts:14](https://github.com/vi
|
|
|
1468
1468
|
###### Set Signature
|
|
1469
1469
|
|
|
1470
1470
|
```ts
|
|
1471
|
-
set code(_name): void
|
|
1471
|
+
set code(_name): void;
|
|
1472
1472
|
```
|
|
1473
1473
|
|
|
1474
|
-
Defined in: [packages/fs/src/error/permission-error.ts:19](https://github.com/visulima/visulima/blob/
|
|
1474
|
+
Defined in: [packages/fs/src/error/permission-error.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/permission-error.ts#L19)
|
|
1475
1475
|
|
|
1476
1476
|
###### Parameters
|
|
1477
1477
|
|
|
@@ -1488,10 +1488,10 @@ Defined in: [packages/fs/src/error/permission-error.ts:19](https://github.com/vi
|
|
|
1488
1488
|
###### Get Signature
|
|
1489
1489
|
|
|
1490
1490
|
```ts
|
|
1491
|
-
get name(): string
|
|
1491
|
+
get name(): string;
|
|
1492
1492
|
```
|
|
1493
1493
|
|
|
1494
|
-
Defined in: [packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1494
|
+
Defined in: [packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/permission-error.ts#L24)
|
|
1495
1495
|
|
|
1496
1496
|
###### Returns
|
|
1497
1497
|
|
|
@@ -1500,10 +1500,10 @@ Defined in: [packages/fs/src/error/permission-error.ts:24](https://github.com/vi
|
|
|
1500
1500
|
###### Set Signature
|
|
1501
1501
|
|
|
1502
1502
|
```ts
|
|
1503
|
-
set name(_name): void
|
|
1503
|
+
set name(_name): void;
|
|
1504
1504
|
```
|
|
1505
1505
|
|
|
1506
|
-
Defined in: [packages/fs/src/error/permission-error.ts:29](https://github.com/visulima/visulima/blob/
|
|
1506
|
+
Defined in: [packages/fs/src/error/permission-error.ts:29](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/permission-error.ts#L29)
|
|
1507
1507
|
|
|
1508
1508
|
###### Parameters
|
|
1509
1509
|
|
|
@@ -1526,7 +1526,7 @@ Error.name
|
|
|
1526
1526
|
##### captureStackTrace()
|
|
1527
1527
|
|
|
1528
1528
|
```ts
|
|
1529
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1529
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
1530
1530
|
```
|
|
1531
1531
|
|
|
1532
1532
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -1561,7 +1561,7 @@ Error.captureStackTrace
|
|
|
1561
1561
|
optional cause: unknown;
|
|
1562
1562
|
```
|
|
1563
1563
|
|
|
1564
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1564
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1565
1565
|
|
|
1566
1566
|
###### Inherited from
|
|
1567
1567
|
|
|
@@ -1575,7 +1575,7 @@ Error.cause
|
|
|
1575
1575
|
message: string;
|
|
1576
1576
|
```
|
|
1577
1577
|
|
|
1578
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1578
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1579
1579
|
|
|
1580
1580
|
###### Inherited from
|
|
1581
1581
|
|
|
@@ -1589,7 +1589,7 @@ Error.message
|
|
|
1589
1589
|
optional stack: string;
|
|
1590
1590
|
```
|
|
1591
1591
|
|
|
1592
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1592
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1593
1593
|
|
|
1594
1594
|
###### Inherited from
|
|
1595
1595
|
|
|
@@ -1649,7 +1649,7 @@ Error.stackTraceLimit
|
|
|
1649
1649
|
|
|
1650
1650
|
### WalkError
|
|
1651
1651
|
|
|
1652
|
-
Defined in: [packages/fs/src/error/walk-error.ts:7](https://github.com/visulima/visulima/blob/
|
|
1652
|
+
Defined in: [packages/fs/src/error/walk-error.ts:7](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/walk-error.ts#L7)
|
|
1653
1653
|
|
|
1654
1654
|
Error thrown in walk or walkSync during iteration.
|
|
1655
1655
|
|
|
@@ -1659,13 +1659,13 @@ Error thrown in walk or walkSync during iteration.
|
|
|
1659
1659
|
|
|
1660
1660
|
#### Constructors
|
|
1661
1661
|
|
|
1662
|
-
#####
|
|
1662
|
+
##### Constructor
|
|
1663
1663
|
|
|
1664
1664
|
```ts
|
|
1665
|
-
new WalkError(cause, root): WalkError
|
|
1665
|
+
new WalkError(cause, root): WalkError;
|
|
1666
1666
|
```
|
|
1667
1667
|
|
|
1668
|
-
Defined in: [packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/
|
|
1668
|
+
Defined in: [packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/walk-error.ts#L12)
|
|
1669
1669
|
|
|
1670
1670
|
Constructs a new instance.
|
|
1671
1671
|
|
|
@@ -1681,7 +1681,7 @@ Constructs a new instance.
|
|
|
1681
1681
|
|
|
1682
1682
|
###### Returns
|
|
1683
1683
|
|
|
1684
|
-
[`WalkError`](
|
|
1684
|
+
[`WalkError`](#walkerror)
|
|
1685
1685
|
|
|
1686
1686
|
###### Overrides
|
|
1687
1687
|
|
|
@@ -1696,10 +1696,10 @@ Error.constructor
|
|
|
1696
1696
|
###### Get Signature
|
|
1697
1697
|
|
|
1698
1698
|
```ts
|
|
1699
|
-
get name(): string
|
|
1699
|
+
get name(): string;
|
|
1700
1700
|
```
|
|
1701
1701
|
|
|
1702
|
-
Defined in: [packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
1702
|
+
Defined in: [packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/walk-error.ts#L21)
|
|
1703
1703
|
|
|
1704
1704
|
###### Returns
|
|
1705
1705
|
|
|
@@ -1708,10 +1708,10 @@ Defined in: [packages/fs/src/error/walk-error.ts:21](https://github.com/visulima
|
|
|
1708
1708
|
###### Set Signature
|
|
1709
1709
|
|
|
1710
1710
|
```ts
|
|
1711
|
-
set name(_name): void
|
|
1711
|
+
set name(_name): void;
|
|
1712
1712
|
```
|
|
1713
1713
|
|
|
1714
|
-
Defined in: [packages/fs/src/error/walk-error.ts:26](https://github.com/visulima/visulima/blob/
|
|
1714
|
+
Defined in: [packages/fs/src/error/walk-error.ts:26](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/walk-error.ts#L26)
|
|
1715
1715
|
|
|
1716
1716
|
###### Parameters
|
|
1717
1717
|
|
|
@@ -1734,7 +1734,7 @@ Error.name
|
|
|
1734
1734
|
##### captureStackTrace()
|
|
1735
1735
|
|
|
1736
1736
|
```ts
|
|
1737
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
1737
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
1738
1738
|
```
|
|
1739
1739
|
|
|
1740
1740
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -1769,7 +1769,7 @@ Error.captureStackTrace
|
|
|
1769
1769
|
optional cause: unknown;
|
|
1770
1770
|
```
|
|
1771
1771
|
|
|
1772
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1772
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
1773
1773
|
|
|
1774
1774
|
###### Inherited from
|
|
1775
1775
|
|
|
@@ -1783,7 +1783,7 @@ Error.cause
|
|
|
1783
1783
|
message: string;
|
|
1784
1784
|
```
|
|
1785
1785
|
|
|
1786
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1786
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1787
1787
|
|
|
1788
1788
|
###### Inherited from
|
|
1789
1789
|
|
|
@@ -1797,7 +1797,7 @@ Error.message
|
|
|
1797
1797
|
root: string;
|
|
1798
1798
|
```
|
|
1799
1799
|
|
|
1800
|
-
Defined in: [packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1800
|
+
Defined in: [packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/walk-error.ts#L9)
|
|
1801
1801
|
|
|
1802
1802
|
File path of the root that's being walked.
|
|
1803
1803
|
|
|
@@ -1807,7 +1807,7 @@ File path of the root that's being walked.
|
|
|
1807
1807
|
optional stack: string;
|
|
1808
1808
|
```
|
|
1809
1809
|
|
|
1810
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
1810
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1811
1811
|
|
|
1812
1812
|
###### Inherited from
|
|
1813
1813
|
|
|
@@ -1875,10 +1875,10 @@ Re-exports [JSONError](utils.md#jsonerror)
|
|
|
1875
1875
|
### collect()
|
|
1876
1876
|
|
|
1877
1877
|
```ts
|
|
1878
|
-
function collect(directory, options): Promise<string[]
|
|
1878
|
+
function collect(directory, options): Promise<string[]>;
|
|
1879
1879
|
```
|
|
1880
1880
|
|
|
1881
|
-
Defined in: [packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/
|
|
1881
|
+
Defined in: [packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/find/collect.ts#L4)
|
|
1882
1882
|
|
|
1883
1883
|
#### Parameters
|
|
1884
1884
|
|
|
@@ -1888,7 +1888,7 @@ Defined in: [packages/fs/src/find/collect.ts:4](https://github.com/visulima/visu
|
|
|
1888
1888
|
|
|
1889
1889
|
##### options
|
|
1890
1890
|
|
|
1891
|
-
[`WalkOptions`](
|
|
1891
|
+
[`WalkOptions`](#walkoptions) = `{}`
|
|
1892
1892
|
|
|
1893
1893
|
#### Returns
|
|
1894
1894
|
|
|
@@ -1899,10 +1899,10 @@ Defined in: [packages/fs/src/find/collect.ts:4](https://github.com/visulima/visu
|
|
|
1899
1899
|
### collectSync()
|
|
1900
1900
|
|
|
1901
1901
|
```ts
|
|
1902
|
-
function collectSync(directory, options): string[]
|
|
1902
|
+
function collectSync(directory, options): string[];
|
|
1903
1903
|
```
|
|
1904
1904
|
|
|
1905
|
-
Defined in: [packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/
|
|
1905
|
+
Defined in: [packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/find/collect-sync.ts#L4)
|
|
1906
1906
|
|
|
1907
1907
|
#### Parameters
|
|
1908
1908
|
|
|
@@ -1912,7 +1912,7 @@ Defined in: [packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima
|
|
|
1912
1912
|
|
|
1913
1913
|
##### options
|
|
1914
1914
|
|
|
1915
|
-
[`WalkOptions`](
|
|
1915
|
+
[`WalkOptions`](#walkoptions) = `{}`
|
|
1916
1916
|
|
|
1917
1917
|
#### Returns
|
|
1918
1918
|
|
|
@@ -1923,10 +1923,10 @@ Defined in: [packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima
|
|
|
1923
1923
|
### detect()
|
|
1924
1924
|
|
|
1925
1925
|
```ts
|
|
1926
|
-
function detect(content): "\n" | "\r\n"
|
|
1926
|
+
function detect(content): "\n" | "\r\n";
|
|
1927
1927
|
```
|
|
1928
1928
|
|
|
1929
|
-
Defined in: [packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/
|
|
1929
|
+
Defined in: [packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/eol.ts#L20)
|
|
1930
1930
|
|
|
1931
1931
|
Detect the EOL character for string input.
|
|
1932
1932
|
Returns null if no newline.
|
|
@@ -1946,10 +1946,10 @@ Returns null if no newline.
|
|
|
1946
1946
|
### emptyDir()
|
|
1947
1947
|
|
|
1948
1948
|
```ts
|
|
1949
|
-
function emptyDir(dir, options?): Promise<void
|
|
1949
|
+
function emptyDir(dir, options?): Promise<void>;
|
|
1950
1950
|
```
|
|
1951
1951
|
|
|
1952
|
-
Defined in: [packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/
|
|
1952
|
+
Defined in: [packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/remove/empty-dir.ts#L19)
|
|
1953
1953
|
|
|
1954
1954
|
Ensures that a directory is empty.
|
|
1955
1955
|
Deletes directory contents if the directory is not empty.
|
|
@@ -1964,7 +1964,7 @@ The directory itself is not deleted.
|
|
|
1964
1964
|
|
|
1965
1965
|
##### options?
|
|
1966
1966
|
|
|
1967
|
-
[`EmptyDirOptions`](
|
|
1967
|
+
[`EmptyDirOptions`](#emptydiroptions)
|
|
1968
1968
|
|
|
1969
1969
|
#### Returns
|
|
1970
1970
|
|
|
@@ -1975,10 +1975,10 @@ The directory itself is not deleted.
|
|
|
1975
1975
|
### emptyDirSync()
|
|
1976
1976
|
|
|
1977
1977
|
```ts
|
|
1978
|
-
function emptyDirSync(dir, options?): void
|
|
1978
|
+
function emptyDirSync(dir, options?): void;
|
|
1979
1979
|
```
|
|
1980
1980
|
|
|
1981
|
-
Defined in: [packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
1981
|
+
Defined in: [packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/remove/empty-dir-sync.ts#L18)
|
|
1982
1982
|
|
|
1983
1983
|
Ensures that a directory is empty.
|
|
1984
1984
|
Deletes directory contents if the directory is not empty.
|
|
@@ -1993,7 +1993,7 @@ The directory itself is not deleted.
|
|
|
1993
1993
|
|
|
1994
1994
|
##### options?
|
|
1995
1995
|
|
|
1996
|
-
[`EmptyDirOptions`](
|
|
1996
|
+
[`EmptyDirOptions`](#emptydiroptions)
|
|
1997
1997
|
|
|
1998
1998
|
#### Returns
|
|
1999
1999
|
|
|
@@ -2004,10 +2004,10 @@ The directory itself is not deleted.
|
|
|
2004
2004
|
### ensureDir()
|
|
2005
2005
|
|
|
2006
2006
|
```ts
|
|
2007
|
-
function ensureDir(directory): Promise<void
|
|
2007
|
+
function ensureDir(directory): Promise<void>;
|
|
2008
2008
|
```
|
|
2009
2009
|
|
|
2010
|
-
Defined in: [packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/
|
|
2010
|
+
Defined in: [packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-dir.ts#L12)
|
|
2011
2011
|
|
|
2012
2012
|
Ensures that the directory exists.
|
|
2013
2013
|
If the directory structure does not exist, it is created. Like mkdir -p.
|
|
@@ -2027,10 +2027,10 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
2027
2027
|
### ensureDirSync()
|
|
2028
2028
|
|
|
2029
2029
|
```ts
|
|
2030
|
-
function ensureDirSync(directory): void
|
|
2030
|
+
function ensureDirSync(directory): void;
|
|
2031
2031
|
```
|
|
2032
2032
|
|
|
2033
|
-
Defined in: [packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/
|
|
2033
|
+
Defined in: [packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-dir-sync.ts#L12)
|
|
2034
2034
|
|
|
2035
2035
|
Ensures that the directory exists.
|
|
2036
2036
|
If the directory structure does not exist, it is created. Like mkdir -p.
|
|
@@ -2050,10 +2050,10 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
2050
2050
|
### ensureFile()
|
|
2051
2051
|
|
|
2052
2052
|
```ts
|
|
2053
|
-
function ensureFile(filePath): Promise<void
|
|
2053
|
+
function ensureFile(filePath): Promise<void>;
|
|
2054
2054
|
```
|
|
2055
2055
|
|
|
2056
|
-
Defined in: [packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/
|
|
2056
|
+
Defined in: [packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-file.ts#L16)
|
|
2057
2057
|
|
|
2058
2058
|
Ensures that the file exists.
|
|
2059
2059
|
If the file that is requested to be created is in directories that do not exist,
|
|
@@ -2074,10 +2074,10 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
2074
2074
|
### ensureFileSync()
|
|
2075
2075
|
|
|
2076
2076
|
```ts
|
|
2077
|
-
function ensureFileSync(filePath): void
|
|
2077
|
+
function ensureFileSync(filePath): void;
|
|
2078
2078
|
```
|
|
2079
2079
|
|
|
2080
|
-
Defined in: [packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
2080
|
+
Defined in: [packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-file-sync.ts#L16)
|
|
2081
2081
|
|
|
2082
2082
|
Ensures that the file exists.
|
|
2083
2083
|
If the file that is requested to be created is in directories that do not exist,
|
|
@@ -2098,10 +2098,10 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
2098
2098
|
### ensureLink()
|
|
2099
2099
|
|
|
2100
2100
|
```ts
|
|
2101
|
-
function ensureLink(source, destination): Promise<void
|
|
2101
|
+
function ensureLink(source, destination): Promise<void>;
|
|
2102
2102
|
```
|
|
2103
2103
|
|
|
2104
|
-
Defined in: [packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/
|
|
2104
|
+
Defined in: [packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-link.ts#L15)
|
|
2105
2105
|
|
|
2106
2106
|
Ensures that the hard link exists.
|
|
2107
2107
|
If the directory structure does not exist, it is created.
|
|
@@ -2125,10 +2125,10 @@ If the directory structure does not exist, it is created.
|
|
|
2125
2125
|
### ensureLinkSync()
|
|
2126
2126
|
|
|
2127
2127
|
```ts
|
|
2128
|
-
function ensureLinkSync(source, destination): void
|
|
2128
|
+
function ensureLinkSync(source, destination): void;
|
|
2129
2129
|
```
|
|
2130
2130
|
|
|
2131
|
-
Defined in: [packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
2131
|
+
Defined in: [packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-link-sync.ts#L15)
|
|
2132
2132
|
|
|
2133
2133
|
Ensures that the hard link exists.
|
|
2134
2134
|
If the directory structure does not exist, it is created.
|
|
@@ -2155,10 +2155,10 @@ If the directory structure does not exist, it is created.
|
|
|
2155
2155
|
function ensureSymlink(
|
|
2156
2156
|
target,
|
|
2157
2157
|
linkName,
|
|
2158
|
-
type?): Promise<void
|
|
2158
|
+
type?): Promise<void>;
|
|
2159
2159
|
```
|
|
2160
2160
|
|
|
2161
|
-
Defined in: [packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/
|
|
2161
|
+
Defined in: [packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-symlink.ts#L28)
|
|
2162
2162
|
|
|
2163
2163
|
Ensures that the link exists, and points to a valid file.
|
|
2164
2164
|
If the directory structure does not exist, it is created.
|
|
@@ -2198,10 +2198,10 @@ A void promise that resolves once the link exists.
|
|
|
2198
2198
|
function ensureSymlinkSync(
|
|
2199
2199
|
target,
|
|
2200
2200
|
linkName,
|
|
2201
|
-
type?): void
|
|
2201
|
+
type?): void;
|
|
2202
2202
|
```
|
|
2203
2203
|
|
|
2204
|
-
Defined in: [packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/
|
|
2204
|
+
Defined in: [packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/ensure/ensure-symlink-sync.ts#L28)
|
|
2205
2205
|
|
|
2206
2206
|
Ensures that the link exists, and points to a valid file.
|
|
2207
2207
|
If the directory structure does not exist, it is created.
|
|
@@ -2238,20 +2238,20 @@ A void.
|
|
|
2238
2238
|
### findUp()
|
|
2239
2239
|
|
|
2240
2240
|
```ts
|
|
2241
|
-
function findUp(name, options): Promise<string
|
|
2241
|
+
function findUp(name, options): Promise<string>;
|
|
2242
2242
|
```
|
|
2243
2243
|
|
|
2244
|
-
Defined in: [packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/
|
|
2244
|
+
Defined in: [packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/find/find-up.ts#L11)
|
|
2245
2245
|
|
|
2246
2246
|
#### Parameters
|
|
2247
2247
|
|
|
2248
2248
|
##### name
|
|
2249
2249
|
|
|
2250
|
-
[`FindUpName`](
|
|
2250
|
+
[`FindUpName`](#findupname)
|
|
2251
2251
|
|
|
2252
2252
|
##### options
|
|
2253
2253
|
|
|
2254
|
-
[`FindUpOptions`](
|
|
2254
|
+
[`FindUpOptions`](#findupoptions) = `{}`
|
|
2255
2255
|
|
|
2256
2256
|
#### Returns
|
|
2257
2257
|
|
|
@@ -2262,20 +2262,20 @@ Defined in: [packages/fs/src/find/find-up.ts:11](https://github.com/visulima/vis
|
|
|
2262
2262
|
### findUpSync()
|
|
2263
2263
|
|
|
2264
2264
|
```ts
|
|
2265
|
-
function findUpSync(name, options): string
|
|
2265
|
+
function findUpSync(name, options): string;
|
|
2266
2266
|
```
|
|
2267
2267
|
|
|
2268
|
-
Defined in: [packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
2268
|
+
Defined in: [packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/find/find-up-sync.ts#L11)
|
|
2269
2269
|
|
|
2270
2270
|
#### Parameters
|
|
2271
2271
|
|
|
2272
2272
|
##### name
|
|
2273
2273
|
|
|
2274
|
-
[`FindUpNameSync`](
|
|
2274
|
+
[`FindUpNameSync`](#findupnamesync)
|
|
2275
2275
|
|
|
2276
2276
|
##### options
|
|
2277
2277
|
|
|
2278
|
-
[`FindUpOptions`](
|
|
2278
|
+
[`FindUpOptions`](#findupoptions) = `{}`
|
|
2279
2279
|
|
|
2280
2280
|
#### Returns
|
|
2281
2281
|
|
|
@@ -2286,10 +2286,10 @@ Defined in: [packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulim
|
|
|
2286
2286
|
### format()
|
|
2287
2287
|
|
|
2288
2288
|
```ts
|
|
2289
|
-
function format(content, eol): string
|
|
2289
|
+
function format(content, eol): string;
|
|
2290
2290
|
```
|
|
2291
2291
|
|
|
2292
|
-
Defined in: [packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/
|
|
2292
|
+
Defined in: [packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/eol.ts#L36)
|
|
2293
2293
|
|
|
2294
2294
|
Format the file to the targeted EOL.
|
|
2295
2295
|
|
|
@@ -2312,10 +2312,10 @@ Format the file to the targeted EOL.
|
|
|
2312
2312
|
### isAccessible()
|
|
2313
2313
|
|
|
2314
2314
|
```ts
|
|
2315
|
-
function isAccessible(path, mode?): Promise<boolean
|
|
2315
|
+
function isAccessible(path, mode?): Promise<boolean>;
|
|
2316
2316
|
```
|
|
2317
2317
|
|
|
2318
|
-
Defined in: [packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/
|
|
2318
|
+
Defined in: [packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/is-accessible.ts#L9)
|
|
2319
2319
|
|
|
2320
2320
|
Returns a Promise that resolves to a boolean indicating if the path is accessible or not.
|
|
2321
2321
|
|
|
@@ -2338,10 +2338,10 @@ Returns a Promise that resolves to a boolean indicating if the path is accessibl
|
|
|
2338
2338
|
### isAccessibleSync()
|
|
2339
2339
|
|
|
2340
2340
|
```ts
|
|
2341
|
-
function isAccessibleSync(path, mode?): boolean
|
|
2341
|
+
function isAccessibleSync(path, mode?): boolean;
|
|
2342
2342
|
```
|
|
2343
2343
|
|
|
2344
|
-
Defined in: [packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/
|
|
2344
|
+
Defined in: [packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/is-accessible-sync.ts#L9)
|
|
2345
2345
|
|
|
2346
2346
|
Returns a boolean indicating if the path is accessible or not.
|
|
2347
2347
|
|
|
@@ -2367,10 +2367,10 @@ Returns a boolean indicating if the path is accessible or not.
|
|
|
2367
2367
|
function move(
|
|
2368
2368
|
sourcePath,
|
|
2369
2369
|
destinationPath,
|
|
2370
|
-
options): Promise<void
|
|
2370
|
+
options): Promise<void>;
|
|
2371
2371
|
```
|
|
2372
2372
|
|
|
2373
|
-
Defined in: [packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/
|
|
2373
|
+
Defined in: [packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/index.ts#L35)
|
|
2374
2374
|
|
|
2375
2375
|
Move a file asynchronously.
|
|
2376
2376
|
|
|
@@ -2390,7 +2390,7 @@ Where you want the file moved.
|
|
|
2390
2390
|
|
|
2391
2391
|
##### options
|
|
2392
2392
|
|
|
2393
|
-
[`MoveOptions`](
|
|
2393
|
+
[`MoveOptions`](#moveoptions) = `{}`
|
|
2394
2394
|
|
|
2395
2395
|
Configuration options.
|
|
2396
2396
|
|
|
@@ -2417,10 +2417,10 @@ console.log('The file has been moved');
|
|
|
2417
2417
|
function moveSync(
|
|
2418
2418
|
sourcePath,
|
|
2419
2419
|
destinationPath,
|
|
2420
|
-
options?): void
|
|
2420
|
+
options?): void;
|
|
2421
2421
|
```
|
|
2422
2422
|
|
|
2423
|
-
Defined in: [packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/
|
|
2423
|
+
Defined in: [packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/index.ts#L61)
|
|
2424
2424
|
|
|
2425
2425
|
Move a file synchronously.
|
|
2426
2426
|
|
|
@@ -2440,7 +2440,7 @@ Where you want the file moved.
|
|
|
2440
2440
|
|
|
2441
2441
|
##### options?
|
|
2442
2442
|
|
|
2443
|
-
[`MoveOptions`](
|
|
2443
|
+
[`MoveOptions`](#moveoptions)
|
|
2444
2444
|
|
|
2445
2445
|
Configuration options.
|
|
2446
2446
|
|
|
@@ -2464,14 +2464,16 @@ console.log('The file has been moved');
|
|
|
2464
2464
|
### readFile()
|
|
2465
2465
|
|
|
2466
2466
|
```ts
|
|
2467
|
-
function readFile<O>(path, options?): Promise<ContentType<O
|
|
2467
|
+
function readFile<O>(path, options?): Promise<ContentType<O>>;
|
|
2468
2468
|
```
|
|
2469
2469
|
|
|
2470
|
-
Defined in: [packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/
|
|
2470
|
+
Defined in: [packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-file.ts#L20)
|
|
2471
2471
|
|
|
2472
2472
|
#### Type Parameters
|
|
2473
2473
|
|
|
2474
|
-
|
|
2474
|
+
##### O
|
|
2475
|
+
|
|
2476
|
+
`O` *extends* [`ReadFileOptions`](#readfileoptions)\<`"brotli"` \| `"gzip"` \| `"none"`\> = `undefined`
|
|
2475
2477
|
|
|
2476
2478
|
#### Parameters
|
|
2477
2479
|
|
|
@@ -2492,14 +2494,16 @@ Defined in: [packages/fs/src/read/read-file.ts:20](https://github.com/visulima/v
|
|
|
2492
2494
|
### readFileSync()
|
|
2493
2495
|
|
|
2494
2496
|
```ts
|
|
2495
|
-
function readFileSync<O>(path, options?): ContentType<O
|
|
2497
|
+
function readFileSync<O>(path, options?): ContentType<O>;
|
|
2496
2498
|
```
|
|
2497
2499
|
|
|
2498
|
-
Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
2500
|
+
Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-file-sync.ts#L18)
|
|
2499
2501
|
|
|
2500
2502
|
#### Type Parameters
|
|
2501
2503
|
|
|
2502
|
-
|
|
2504
|
+
##### O
|
|
2505
|
+
|
|
2506
|
+
`O` *extends* [`ReadFileOptions`](#readfileoptions)\<`"brotli"` \| `"gzip"` \| `"none"`\> = `undefined`
|
|
2503
2507
|
|
|
2504
2508
|
#### Parameters
|
|
2505
2509
|
|
|
@@ -2522,14 +2526,16 @@ Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visul
|
|
|
2522
2526
|
#### Call Signature
|
|
2523
2527
|
|
|
2524
2528
|
```ts
|
|
2525
|
-
function readJson<T>(path, options?): Promise<T
|
|
2529
|
+
function readJson<T>(path, options?): Promise<T>;
|
|
2526
2530
|
```
|
|
2527
2531
|
|
|
2528
|
-
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/
|
|
2532
|
+
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-json.ts#L8)
|
|
2529
2533
|
|
|
2530
2534
|
##### Type Parameters
|
|
2531
2535
|
|
|
2532
|
-
|
|
2536
|
+
###### T
|
|
2537
|
+
|
|
2538
|
+
`T` *extends* `JsonValue`
|
|
2533
2539
|
|
|
2534
2540
|
##### Parameters
|
|
2535
2541
|
|
|
@@ -2539,7 +2545,7 @@ Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/vi
|
|
|
2539
2545
|
|
|
2540
2546
|
###### options?
|
|
2541
2547
|
|
|
2542
|
-
[`ReadJsonOptions`](
|
|
2548
|
+
[`ReadJsonOptions`](#readjsonoptions)
|
|
2543
2549
|
|
|
2544
2550
|
##### Returns
|
|
2545
2551
|
|
|
@@ -2551,14 +2557,16 @@ Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/vi
|
|
|
2551
2557
|
function readJson<T>(
|
|
2552
2558
|
path,
|
|
2553
2559
|
reviver,
|
|
2554
|
-
options?): Promise<T
|
|
2560
|
+
options?): Promise<T>;
|
|
2555
2561
|
```
|
|
2556
2562
|
|
|
2557
|
-
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/
|
|
2563
|
+
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-json.ts#L10)
|
|
2558
2564
|
|
|
2559
2565
|
##### Type Parameters
|
|
2560
2566
|
|
|
2561
|
-
|
|
2567
|
+
###### T
|
|
2568
|
+
|
|
2569
|
+
`T` *extends* `JsonValue`
|
|
2562
2570
|
|
|
2563
2571
|
##### Parameters
|
|
2564
2572
|
|
|
@@ -2572,7 +2580,7 @@ Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/v
|
|
|
2572
2580
|
|
|
2573
2581
|
###### options?
|
|
2574
2582
|
|
|
2575
|
-
[`ReadJsonOptions`](
|
|
2583
|
+
[`ReadJsonOptions`](#readjsonoptions)
|
|
2576
2584
|
|
|
2577
2585
|
##### Returns
|
|
2578
2586
|
|
|
@@ -2585,14 +2593,16 @@ Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/v
|
|
|
2585
2593
|
#### Call Signature
|
|
2586
2594
|
|
|
2587
2595
|
```ts
|
|
2588
|
-
function readJsonSync<T>(path, options?): T
|
|
2596
|
+
function readJsonSync<T>(path, options?): T;
|
|
2589
2597
|
```
|
|
2590
2598
|
|
|
2591
|
-
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/
|
|
2599
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-json-sync.ts#L8)
|
|
2592
2600
|
|
|
2593
2601
|
##### Type Parameters
|
|
2594
2602
|
|
|
2595
|
-
|
|
2603
|
+
###### T
|
|
2604
|
+
|
|
2605
|
+
`T` *extends* `JsonValue`
|
|
2596
2606
|
|
|
2597
2607
|
##### Parameters
|
|
2598
2608
|
|
|
@@ -2602,7 +2612,7 @@ Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visuli
|
|
|
2602
2612
|
|
|
2603
2613
|
###### options?
|
|
2604
2614
|
|
|
2605
|
-
[`ReadJsonOptions`](
|
|
2615
|
+
[`ReadJsonOptions`](#readjsonoptions)
|
|
2606
2616
|
|
|
2607
2617
|
##### Returns
|
|
2608
2618
|
|
|
@@ -2614,14 +2624,16 @@ Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visuli
|
|
|
2614
2624
|
function readJsonSync<T>(
|
|
2615
2625
|
path,
|
|
2616
2626
|
reviver,
|
|
2617
|
-
options?): T
|
|
2627
|
+
options?): T;
|
|
2618
2628
|
```
|
|
2619
2629
|
|
|
2620
|
-
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
2630
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-json-sync.ts#L10)
|
|
2621
2631
|
|
|
2622
2632
|
##### Type Parameters
|
|
2623
2633
|
|
|
2624
|
-
|
|
2634
|
+
###### T
|
|
2635
|
+
|
|
2636
|
+
`T` *extends* `JsonValue`
|
|
2625
2637
|
|
|
2626
2638
|
##### Parameters
|
|
2627
2639
|
|
|
@@ -2635,7 +2647,7 @@ Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visul
|
|
|
2635
2647
|
|
|
2636
2648
|
###### options?
|
|
2637
2649
|
|
|
2638
|
-
[`ReadJsonOptions`](
|
|
2650
|
+
[`ReadJsonOptions`](#readjsonoptions)
|
|
2639
2651
|
|
|
2640
2652
|
##### Returns
|
|
2641
2653
|
|
|
@@ -2646,10 +2658,10 @@ Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visul
|
|
|
2646
2658
|
### remove()
|
|
2647
2659
|
|
|
2648
2660
|
```ts
|
|
2649
|
-
function remove(path, options): Promise<void
|
|
2661
|
+
function remove(path, options): Promise<void>;
|
|
2650
2662
|
```
|
|
2651
2663
|
|
|
2652
|
-
Defined in: [packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/
|
|
2664
|
+
Defined in: [packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/remove/remove.ts#L5)
|
|
2653
2665
|
|
|
2654
2666
|
#### Parameters
|
|
2655
2667
|
|
|
@@ -2697,10 +2709,10 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2697
2709
|
### removeSync()
|
|
2698
2710
|
|
|
2699
2711
|
```ts
|
|
2700
|
-
function removeSync(path, options): void
|
|
2712
|
+
function removeSync(path, options): void;
|
|
2701
2713
|
```
|
|
2702
2714
|
|
|
2703
|
-
Defined in: [packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/
|
|
2715
|
+
Defined in: [packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/remove/remove-sync.ts#L5)
|
|
2704
2716
|
|
|
2705
2717
|
#### Parameters
|
|
2706
2718
|
|
|
@@ -2751,10 +2763,10 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2751
2763
|
function rename(
|
|
2752
2764
|
source,
|
|
2753
2765
|
destination,
|
|
2754
|
-
options?): Promise<void
|
|
2766
|
+
options?): Promise<void>;
|
|
2755
2767
|
```
|
|
2756
2768
|
|
|
2757
|
-
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/
|
|
2769
|
+
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/index.ts#L85)
|
|
2758
2770
|
|
|
2759
2771
|
Rename a file asynchronously.
|
|
2760
2772
|
|
|
@@ -2774,7 +2786,7 @@ The name of the renamed file.
|
|
|
2774
2786
|
|
|
2775
2787
|
##### options?
|
|
2776
2788
|
|
|
2777
|
-
[`MoveOptions`](
|
|
2789
|
+
[`MoveOptions`](#moveoptions)
|
|
2778
2790
|
|
|
2779
2791
|
Configuration options.
|
|
2780
2792
|
|
|
@@ -2801,10 +2813,10 @@ console.log('The file has been renamed');
|
|
|
2801
2813
|
function renameSync(
|
|
2802
2814
|
source,
|
|
2803
2815
|
destination,
|
|
2804
|
-
options?): void
|
|
2816
|
+
options?): void;
|
|
2805
2817
|
```
|
|
2806
2818
|
|
|
2807
|
-
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/
|
|
2819
|
+
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/index.ts#L109)
|
|
2808
2820
|
|
|
2809
2821
|
Rename a file synchronously.
|
|
2810
2822
|
|
|
@@ -2824,7 +2836,7 @@ The name of the renamed file.
|
|
|
2824
2836
|
|
|
2825
2837
|
##### options?
|
|
2826
2838
|
|
|
2827
|
-
[`MoveOptions`](
|
|
2839
|
+
[`MoveOptions`](#moveoptions)
|
|
2828
2840
|
|
|
2829
2841
|
Configuration options.
|
|
2830
2842
|
|
|
@@ -2848,10 +2860,10 @@ console.log('The file has been renamed');
|
|
|
2848
2860
|
### walk()
|
|
2849
2861
|
|
|
2850
2862
|
```ts
|
|
2851
|
-
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry
|
|
2863
|
+
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry>;
|
|
2852
2864
|
```
|
|
2853
2865
|
|
|
2854
|
-
Defined in: [packages/fs/src/find/walk.ts:49](https://github.com/visulima/visulima/blob/
|
|
2866
|
+
Defined in: [packages/fs/src/find/walk.ts:49](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/find/walk.ts#L49)
|
|
2855
2867
|
|
|
2856
2868
|
Walks the file tree rooted at root, yielding each file or directory in the
|
|
2857
2869
|
tree filtered according to the given options.
|
|
@@ -2873,23 +2885,23 @@ Options:
|
|
|
2873
2885
|
|
|
2874
2886
|
##### \_\_namedParameters
|
|
2875
2887
|
|
|
2876
|
-
[`WalkOptions`](
|
|
2888
|
+
[`WalkOptions`](#walkoptions) = `{}`
|
|
2877
2889
|
|
|
2878
2890
|
#### Returns
|
|
2879
2891
|
|
|
2880
|
-
`AsyncIterableIterator`\<[`WalkEntry`](
|
|
2892
|
+
`AsyncIterableIterator`\<[`WalkEntry`](#walkentry)\>
|
|
2881
2893
|
|
|
2882
2894
|
***
|
|
2883
2895
|
|
|
2884
2896
|
### walkSync()
|
|
2885
2897
|
|
|
2886
2898
|
```ts
|
|
2887
|
-
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry
|
|
2899
|
+
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry>;
|
|
2888
2900
|
```
|
|
2889
2901
|
|
|
2890
|
-
Defined in: [packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/
|
|
2902
|
+
Defined in: [packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/find/walk-sync.ts#L40)
|
|
2891
2903
|
|
|
2892
|
-
Same as [`walk`](
|
|
2904
|
+
Same as [`walk`](#walk) but uses synchronous ops
|
|
2893
2905
|
|
|
2894
2906
|
#### Parameters
|
|
2895
2907
|
|
|
@@ -2899,11 +2911,11 @@ Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
|
2899
2911
|
|
|
2900
2912
|
##### \_\_namedParameters
|
|
2901
2913
|
|
|
2902
|
-
[`WalkOptions`](
|
|
2914
|
+
[`WalkOptions`](#walkoptions) = `{}`
|
|
2903
2915
|
|
|
2904
2916
|
#### Returns
|
|
2905
2917
|
|
|
2906
|
-
`IterableIterator`\<[`WalkEntry`](
|
|
2918
|
+
`IterableIterator`\<[`WalkEntry`](#walkentry)\>
|
|
2907
2919
|
|
|
2908
2920
|
***
|
|
2909
2921
|
|
|
@@ -2913,10 +2925,10 @@ Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
|
2913
2925
|
function writeFile(
|
|
2914
2926
|
path,
|
|
2915
2927
|
content,
|
|
2916
|
-
options?): Promise<void
|
|
2928
|
+
options?): Promise<void>;
|
|
2917
2929
|
```
|
|
2918
2930
|
|
|
2919
|
-
Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/
|
|
2931
|
+
Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-file.ts#L15)
|
|
2920
2932
|
|
|
2921
2933
|
#### Parameters
|
|
2922
2934
|
|
|
@@ -2930,7 +2942,7 @@ Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima
|
|
|
2930
2942
|
|
|
2931
2943
|
##### options?
|
|
2932
2944
|
|
|
2933
|
-
[`WriteFileOptions`](
|
|
2945
|
+
[`WriteFileOptions`](#writefileoptions)
|
|
2934
2946
|
|
|
2935
2947
|
#### Returns
|
|
2936
2948
|
|
|
@@ -2944,10 +2956,10 @@ Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima
|
|
|
2944
2956
|
function writeFileSync(
|
|
2945
2957
|
path,
|
|
2946
2958
|
content,
|
|
2947
|
-
options?): void
|
|
2959
|
+
options?): void;
|
|
2948
2960
|
```
|
|
2949
2961
|
|
|
2950
|
-
Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
2962
|
+
Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-file-sync.ts#L15)
|
|
2951
2963
|
|
|
2952
2964
|
#### Parameters
|
|
2953
2965
|
|
|
@@ -2961,7 +2973,7 @@ Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/vis
|
|
|
2961
2973
|
|
|
2962
2974
|
##### options?
|
|
2963
2975
|
|
|
2964
|
-
[`WriteFileOptions`](
|
|
2976
|
+
[`WriteFileOptions`](#writefileoptions)
|
|
2965
2977
|
|
|
2966
2978
|
#### Returns
|
|
2967
2979
|
|
|
@@ -2975,10 +2987,10 @@ Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/vis
|
|
|
2975
2987
|
function writeJson(
|
|
2976
2988
|
path,
|
|
2977
2989
|
data,
|
|
2978
|
-
options): Promise<void
|
|
2990
|
+
options): Promise<void>;
|
|
2979
2991
|
```
|
|
2980
2992
|
|
|
2981
|
-
Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/
|
|
2993
|
+
Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-json.ts#L11)
|
|
2982
2994
|
|
|
2983
2995
|
#### Parameters
|
|
2984
2996
|
|
|
@@ -2992,7 +3004,7 @@ Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima
|
|
|
2992
3004
|
|
|
2993
3005
|
##### options
|
|
2994
3006
|
|
|
2995
|
-
[`WriteJsonOptions`](
|
|
3007
|
+
[`WriteJsonOptions`](#writejsonoptions) = `{}`
|
|
2996
3008
|
|
|
2997
3009
|
#### Returns
|
|
2998
3010
|
|
|
@@ -3006,10 +3018,10 @@ Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima
|
|
|
3006
3018
|
function writeJsonSync(
|
|
3007
3019
|
path,
|
|
3008
3020
|
data,
|
|
3009
|
-
options): void
|
|
3021
|
+
options): void;
|
|
3010
3022
|
```
|
|
3011
3023
|
|
|
3012
|
-
Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
3024
|
+
Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-json-sync.ts#L11)
|
|
3013
3025
|
|
|
3014
3026
|
#### Parameters
|
|
3015
3027
|
|
|
@@ -3023,7 +3035,7 @@ Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/vis
|
|
|
3023
3035
|
|
|
3024
3036
|
##### options
|
|
3025
3037
|
|
|
3026
|
-
[`WriteJsonOptions`](
|
|
3038
|
+
[`WriteJsonOptions`](#writejsonoptions) = `{}`
|
|
3027
3039
|
|
|
3028
3040
|
#### Returns
|
|
3029
3041
|
|
|
@@ -3037,7 +3049,7 @@ Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/vis
|
|
|
3037
3049
|
const CRLF: "\r\n";
|
|
3038
3050
|
```
|
|
3039
3051
|
|
|
3040
|
-
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/
|
|
3052
|
+
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/eol.ts#L9)
|
|
3041
3053
|
|
|
3042
3054
|
End-of-line character for Windows platforms.
|
|
3043
3055
|
|
|
@@ -3049,7 +3061,7 @@ End-of-line character for Windows platforms.
|
|
|
3049
3061
|
const EOL: "\n" | "\r\n";
|
|
3050
3062
|
```
|
|
3051
3063
|
|
|
3052
|
-
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/
|
|
3064
|
+
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/eol.ts#L14)
|
|
3053
3065
|
|
|
3054
3066
|
End-of-line character evaluated for the current platform.
|
|
3055
3067
|
|
|
@@ -3061,7 +3073,7 @@ End-of-line character evaluated for the current platform.
|
|
|
3061
3073
|
const F_OK: 0 = 0;
|
|
3062
3074
|
```
|
|
3063
3075
|
|
|
3064
|
-
Defined in: [packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/
|
|
3076
|
+
Defined in: [packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/constants.ts#L2)
|
|
3065
3077
|
|
|
3066
3078
|
Is the path visible to the calling process?
|
|
3067
3079
|
|
|
@@ -3073,7 +3085,7 @@ Is the path visible to the calling process?
|
|
|
3073
3085
|
const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
3074
3086
|
```
|
|
3075
3087
|
|
|
3076
|
-
Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/
|
|
3088
|
+
Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/constants.ts#L13)
|
|
3077
3089
|
|
|
3078
3090
|
***
|
|
3079
3091
|
|
|
@@ -3083,7 +3095,7 @@ Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visuli
|
|
|
3083
3095
|
const LF: "\n";
|
|
3084
3096
|
```
|
|
3085
3097
|
|
|
3086
|
-
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/
|
|
3098
|
+
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/eol.ts#L6)
|
|
3087
3099
|
|
|
3088
3100
|
End-of-line character for POSIX platforms such as macOS and Linux.
|
|
3089
3101
|
|
|
@@ -3095,7 +3107,7 @@ End-of-line character for POSIX platforms such as macOS and Linux.
|
|
|
3095
3107
|
const R_OK: 4 = 4;
|
|
3096
3108
|
```
|
|
3097
3109
|
|
|
3098
|
-
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/
|
|
3110
|
+
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/constants.ts#L5)
|
|
3099
3111
|
|
|
3100
3112
|
Is the path readable to the calling process?
|
|
3101
3113
|
|
|
@@ -3107,7 +3119,7 @@ Is the path readable to the calling process?
|
|
|
3107
3119
|
const W_OK: 2 = 2;
|
|
3108
3120
|
```
|
|
3109
3121
|
|
|
3110
|
-
Defined in: [packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/
|
|
3122
|
+
Defined in: [packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/constants.ts#L8)
|
|
3111
3123
|
|
|
3112
3124
|
Is the path writable to the calling process?
|
|
3113
3125
|
|
|
@@ -3119,7 +3131,7 @@ Is the path writable to the calling process?
|
|
|
3119
3131
|
const X_OK: 1 = 1;
|
|
3120
3132
|
```
|
|
3121
3133
|
|
|
3122
|
-
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/
|
|
3134
|
+
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/constants.ts#L11)
|
|
3123
3135
|
|
|
3124
3136
|
Is the path executable to the calling process?
|
|
3125
3137
|
|
|
@@ -3127,7 +3139,7 @@ Is the path executable to the calling process?
|
|
|
3127
3139
|
|
|
3128
3140
|
### WalkEntry
|
|
3129
3141
|
|
|
3130
|
-
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/
|
|
3142
|
+
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L56)
|
|
3131
3143
|
|
|
3132
3144
|
#### Extends
|
|
3133
3145
|
|
|
@@ -3138,7 +3150,7 @@ Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/b
|
|
|
3138
3150
|
##### isDirectory()
|
|
3139
3151
|
|
|
3140
3152
|
```ts
|
|
3141
|
-
isDirectory(): boolean
|
|
3153
|
+
isDirectory(): boolean;
|
|
3142
3154
|
```
|
|
3143
3155
|
|
|
3144
3156
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:190
|
|
@@ -3163,7 +3175,7 @@ Pick.isDirectory
|
|
|
3163
3175
|
##### isFile()
|
|
3164
3176
|
|
|
3165
3177
|
```ts
|
|
3166
|
-
isFile(): boolean
|
|
3178
|
+
isFile(): boolean;
|
|
3167
3179
|
```
|
|
3168
3180
|
|
|
3169
3181
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:184
|
|
@@ -3187,7 +3199,7 @@ Pick.isFile
|
|
|
3187
3199
|
##### isSymbolicLink()
|
|
3188
3200
|
|
|
3189
3201
|
```ts
|
|
3190
|
-
isSymbolicLink(): boolean
|
|
3202
|
+
isSymbolicLink(): boolean;
|
|
3191
3203
|
```
|
|
3192
3204
|
|
|
3193
3205
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/fs.d.ts:205
|
|
@@ -3237,13 +3249,13 @@ Pick.name
|
|
|
3237
3249
|
path: string;
|
|
3238
3250
|
```
|
|
3239
3251
|
|
|
3240
|
-
Defined in: [packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/
|
|
3252
|
+
Defined in: [packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L57)
|
|
3241
3253
|
|
|
3242
3254
|
***
|
|
3243
3255
|
|
|
3244
3256
|
### WalkOptions
|
|
3245
3257
|
|
|
3246
|
-
Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/blob/
|
|
3258
|
+
Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L9)
|
|
3247
3259
|
|
|
3248
3260
|
#### Properties
|
|
3249
3261
|
|
|
@@ -3253,7 +3265,7 @@ Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/bl
|
|
|
3253
3265
|
optional extensions: string[];
|
|
3254
3266
|
```
|
|
3255
3267
|
|
|
3256
|
-
Defined in: [packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/
|
|
3268
|
+
Defined in: [packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L15)
|
|
3257
3269
|
|
|
3258
3270
|
List of file extensions used to filter entries.
|
|
3259
3271
|
If specified, entries without the file extension specified by this option are excluded.
|
|
@@ -3270,7 +3282,7 @@ If specified, entries without the file extension specified by this option are ex
|
|
|
3270
3282
|
optional followSymlinks: boolean;
|
|
3271
3283
|
```
|
|
3272
3284
|
|
|
3273
|
-
Defined in: [packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/
|
|
3285
|
+
Defined in: [packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L20)
|
|
3274
3286
|
|
|
3275
3287
|
Indicates whether symlinks should be resolved or not.
|
|
3276
3288
|
|
|
@@ -3286,7 +3298,7 @@ Indicates whether symlinks should be resolved or not.
|
|
|
3286
3298
|
optional includeDirs: boolean;
|
|
3287
3299
|
```
|
|
3288
3300
|
|
|
3289
|
-
Defined in: [packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/
|
|
3301
|
+
Defined in: [packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L25)
|
|
3290
3302
|
|
|
3291
3303
|
Indicates whether directory entries should be included or not.
|
|
3292
3304
|
|
|
@@ -3302,7 +3314,7 @@ Indicates whether directory entries should be included or not.
|
|
|
3302
3314
|
optional includeFiles: boolean;
|
|
3303
3315
|
```
|
|
3304
3316
|
|
|
3305
|
-
Defined in: [packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/
|
|
3317
|
+
Defined in: [packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L30)
|
|
3306
3318
|
|
|
3307
3319
|
Indicates whether file entries should be included or not.
|
|
3308
3320
|
|
|
@@ -3318,7 +3330,7 @@ Indicates whether file entries should be included or not.
|
|
|
3318
3330
|
optional includeSymlinks: boolean;
|
|
3319
3331
|
```
|
|
3320
3332
|
|
|
3321
|
-
Defined in: [packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/
|
|
3333
|
+
Defined in: [packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L36)
|
|
3322
3334
|
|
|
3323
3335
|
Indicates whether symlink entries should be included or not.
|
|
3324
3336
|
This option is meaningful only if `followSymlinks` is set to `false`.
|
|
@@ -3335,7 +3347,7 @@ This option is meaningful only if `followSymlinks` is set to `false`.
|
|
|
3335
3347
|
optional match: (string | RegExp)[];
|
|
3336
3348
|
```
|
|
3337
3349
|
|
|
3338
|
-
Defined in: [packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/
|
|
3350
|
+
Defined in: [packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L42)
|
|
3339
3351
|
|
|
3340
3352
|
List of regular expression or glob patterns used to filter entries.
|
|
3341
3353
|
If specified, entries that do not match the patterns specified by this option are excluded.
|
|
@@ -3352,7 +3364,7 @@ If specified, entries that do not match the patterns specified by this option ar
|
|
|
3352
3364
|
optional maxDepth: number;
|
|
3353
3365
|
```
|
|
3354
3366
|
|
|
3355
|
-
Defined in: [packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/
|
|
3367
|
+
Defined in: [packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L47)
|
|
3356
3368
|
|
|
3357
3369
|
The maximum depth of the file tree to be walked recursively.
|
|
3358
3370
|
|
|
@@ -3368,7 +3380,7 @@ The maximum depth of the file tree to be walked recursively.
|
|
|
3368
3380
|
optional skip: (string | RegExp)[];
|
|
3369
3381
|
```
|
|
3370
3382
|
|
|
3371
|
-
Defined in: [packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/
|
|
3383
|
+
Defined in: [packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L53)
|
|
3372
3384
|
|
|
3373
3385
|
List of regular expression or glob patterns used to filter entries.
|
|
3374
3386
|
If specified, entries matching the patterns specified by this option are excluded.
|
|
@@ -3387,9 +3399,9 @@ If specified, entries matching the patterns specified by this option are exclude
|
|
|
3387
3399
|
type CodeFrameLocation = object;
|
|
3388
3400
|
```
|
|
3389
3401
|
|
|
3390
|
-
Defined in: [packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/
|
|
3402
|
+
Defined in: [packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L91)
|
|
3391
3403
|
|
|
3392
|
-
####
|
|
3404
|
+
#### Properties
|
|
3393
3405
|
|
|
3394
3406
|
##### column?
|
|
3395
3407
|
|
|
@@ -3397,12 +3409,16 @@ Defined in: [packages/fs/src/types.ts:91](https://github.com/visulima/visulima/b
|
|
|
3397
3409
|
optional column: number;
|
|
3398
3410
|
```
|
|
3399
3411
|
|
|
3412
|
+
Defined in: [packages/fs/src/types.ts:92](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L92)
|
|
3413
|
+
|
|
3400
3414
|
##### line
|
|
3401
3415
|
|
|
3402
3416
|
```ts
|
|
3403
3417
|
line: number;
|
|
3404
3418
|
```
|
|
3405
3419
|
|
|
3420
|
+
Defined in: [packages/fs/src/types.ts:93](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L93)
|
|
3421
|
+
|
|
3406
3422
|
***
|
|
3407
3423
|
|
|
3408
3424
|
### EmptyDirOptions
|
|
@@ -3411,9 +3427,9 @@ line: number;
|
|
|
3411
3427
|
type EmptyDirOptions = object;
|
|
3412
3428
|
```
|
|
3413
3429
|
|
|
3414
|
-
Defined in: [packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/
|
|
3430
|
+
Defined in: [packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L188)
|
|
3415
3431
|
|
|
3416
|
-
####
|
|
3432
|
+
#### Properties
|
|
3417
3433
|
|
|
3418
3434
|
##### maxRetries?
|
|
3419
3435
|
|
|
@@ -3421,6 +3437,8 @@ Defined in: [packages/fs/src/types.ts:188](https://github.com/visulima/visulima/
|
|
|
3421
3437
|
optional maxRetries: number;
|
|
3422
3438
|
```
|
|
3423
3439
|
|
|
3440
|
+
Defined in: [packages/fs/src/types.ts:197](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L197)
|
|
3441
|
+
|
|
3424
3442
|
If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or
|
|
3425
3443
|
`EPERM` error is encountered, Node.js will retry the operation with a linear
|
|
3426
3444
|
backoff wait of `retryDelay` ms longer on each try. This option represents the
|
|
@@ -3439,6 +3457,8 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
3439
3457
|
optional retryDelay: number;
|
|
3440
3458
|
```
|
|
3441
3459
|
|
|
3460
|
+
Defined in: [packages/fs/src/types.ts:203](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L203)
|
|
3461
|
+
|
|
3442
3462
|
The amount of time in milliseconds to wait between retries.
|
|
3443
3463
|
This option is ignored if the `recursive` option is not `true`.
|
|
3444
3464
|
|
|
@@ -3459,7 +3479,7 @@ type FindUpName =
|
|
|
3459
3479
|
| (directory) => FindUpNameFnResult;
|
|
3460
3480
|
```
|
|
3461
3481
|
|
|
3462
|
-
Defined in: [packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/
|
|
3482
|
+
Defined in: [packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L180)
|
|
3463
3483
|
|
|
3464
3484
|
***
|
|
3465
3485
|
|
|
@@ -3473,7 +3493,7 @@ type FindUpNameFnResult =
|
|
|
3473
3493
|
| undefined;
|
|
3474
3494
|
```
|
|
3475
3495
|
|
|
3476
|
-
Defined in: [packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/
|
|
3496
|
+
Defined in: [packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L178)
|
|
3477
3497
|
|
|
3478
3498
|
***
|
|
3479
3499
|
|
|
@@ -3486,7 +3506,7 @@ type FindUpNameSync =
|
|
|
3486
3506
|
| (directory) => FindUpNameSyncFnResult;
|
|
3487
3507
|
```
|
|
3488
3508
|
|
|
3489
|
-
Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/
|
|
3509
|
+
Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L185)
|
|
3490
3510
|
|
|
3491
3511
|
***
|
|
3492
3512
|
|
|
@@ -3496,7 +3516,7 @@ Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/
|
|
|
3496
3516
|
type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
|
|
3497
3517
|
```
|
|
3498
3518
|
|
|
3499
|
-
Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/
|
|
3519
|
+
Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L183)
|
|
3500
3520
|
|
|
3501
3521
|
***
|
|
3502
3522
|
|
|
@@ -3506,9 +3526,9 @@ Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/
|
|
|
3506
3526
|
type FindUpOptions = object;
|
|
3507
3527
|
```
|
|
3508
3528
|
|
|
3509
|
-
Defined in: [packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/
|
|
3529
|
+
Defined in: [packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L170)
|
|
3510
3530
|
|
|
3511
|
-
####
|
|
3531
|
+
#### Properties
|
|
3512
3532
|
|
|
3513
3533
|
##### allowSymlinks?
|
|
3514
3534
|
|
|
@@ -3516,24 +3536,32 @@ Defined in: [packages/fs/src/types.ts:170](https://github.com/visulima/visulima/
|
|
|
3516
3536
|
optional allowSymlinks: boolean;
|
|
3517
3537
|
```
|
|
3518
3538
|
|
|
3539
|
+
Defined in: [packages/fs/src/types.ts:171](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L171)
|
|
3540
|
+
|
|
3519
3541
|
##### cwd?
|
|
3520
3542
|
|
|
3521
3543
|
```ts
|
|
3522
3544
|
optional cwd: URL | string;
|
|
3523
3545
|
```
|
|
3524
3546
|
|
|
3547
|
+
Defined in: [packages/fs/src/types.ts:172](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L172)
|
|
3548
|
+
|
|
3525
3549
|
##### stopAt?
|
|
3526
3550
|
|
|
3527
3551
|
```ts
|
|
3528
3552
|
optional stopAt: URL | string;
|
|
3529
3553
|
```
|
|
3530
3554
|
|
|
3555
|
+
Defined in: [packages/fs/src/types.ts:173](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L173)
|
|
3556
|
+
|
|
3531
3557
|
##### type?
|
|
3532
3558
|
|
|
3533
3559
|
```ts
|
|
3534
3560
|
optional type: "directory" | "file";
|
|
3535
3561
|
```
|
|
3536
3562
|
|
|
3563
|
+
Defined in: [packages/fs/src/types.ts:174](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L174)
|
|
3564
|
+
|
|
3537
3565
|
***
|
|
3538
3566
|
|
|
3539
3567
|
### JsonReplacer
|
|
@@ -3542,7 +3570,7 @@ optional type: "directory" | "file";
|
|
|
3542
3570
|
type JsonReplacer = (number | string)[] | (this, key, value) => unknown | null;
|
|
3543
3571
|
```
|
|
3544
3572
|
|
|
3545
|
-
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/
|
|
3573
|
+
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L143)
|
|
3546
3574
|
|
|
3547
3575
|
***
|
|
3548
3576
|
|
|
@@ -3552,7 +3580,7 @@ Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/
|
|
|
3552
3580
|
type JsonReviver = Parameters<typeof JSON["parse"]>["1"];
|
|
3553
3581
|
```
|
|
3554
3582
|
|
|
3555
|
-
Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/
|
|
3583
|
+
Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L89)
|
|
3556
3584
|
|
|
3557
3585
|
***
|
|
3558
3586
|
|
|
@@ -3562,9 +3590,9 @@ Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/b
|
|
|
3562
3590
|
type MoveOptions = object;
|
|
3563
3591
|
```
|
|
3564
3592
|
|
|
3565
|
-
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/
|
|
3593
|
+
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/types.ts#L3)
|
|
3566
3594
|
|
|
3567
|
-
####
|
|
3595
|
+
#### Properties
|
|
3568
3596
|
|
|
3569
3597
|
##### cwd?
|
|
3570
3598
|
|
|
@@ -3572,6 +3600,8 @@ Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visuli
|
|
|
3572
3600
|
optional cwd: URL | string;
|
|
3573
3601
|
```
|
|
3574
3602
|
|
|
3603
|
+
Defined in: [packages/fs/src/move/types.ts:10](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/types.ts#L10)
|
|
3604
|
+
|
|
3575
3605
|
The working directory to find source files.
|
|
3576
3606
|
The source and destination path are relative to this.
|
|
3577
3607
|
|
|
@@ -3587,6 +3617,8 @@ process.cwd()
|
|
|
3587
3617
|
readonly optional directoryMode: FilePermissions;
|
|
3588
3618
|
```
|
|
3589
3619
|
|
|
3620
|
+
Defined in: [packages/fs/src/move/types.ts:19](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/types.ts#L19)
|
|
3621
|
+
|
|
3590
3622
|
[Permissions](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) for created directories.
|
|
3591
3623
|
|
|
3592
3624
|
It has no effect on Windows.
|
|
@@ -3603,6 +3635,8 @@ It has no effect on Windows.
|
|
|
3603
3635
|
readonly optional overwrite: boolean;
|
|
3604
3636
|
```
|
|
3605
3637
|
|
|
3638
|
+
Defined in: [packages/fs/src/move/types.ts:26](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/move/types.ts#L26)
|
|
3639
|
+
|
|
3606
3640
|
Overwrite existing destination file.
|
|
3607
3641
|
|
|
3608
3642
|
###### Default
|
|
@@ -3630,7 +3664,7 @@ type ReadFileEncoding =
|
|
|
3630
3664
|
| "utf16le";
|
|
3631
3665
|
```
|
|
3632
3666
|
|
|
3633
|
-
Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/
|
|
3667
|
+
Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L61)
|
|
3634
3668
|
|
|
3635
3669
|
***
|
|
3636
3670
|
|
|
@@ -3640,13 +3674,15 @@ Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/b
|
|
|
3640
3674
|
type ReadFileOptions<C> = object;
|
|
3641
3675
|
```
|
|
3642
3676
|
|
|
3643
|
-
Defined in: [packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/
|
|
3677
|
+
Defined in: [packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L63)
|
|
3644
3678
|
|
|
3645
3679
|
#### Type Parameters
|
|
3646
3680
|
|
|
3647
|
-
|
|
3681
|
+
##### C
|
|
3648
3682
|
|
|
3649
|
-
|
|
3683
|
+
`C`
|
|
3684
|
+
|
|
3685
|
+
#### Properties
|
|
3650
3686
|
|
|
3651
3687
|
##### buffer?
|
|
3652
3688
|
|
|
@@ -3654,6 +3690,8 @@ Defined in: [packages/fs/src/types.ts:63](https://github.com/visulima/visulima/b
|
|
|
3654
3690
|
optional buffer: boolean;
|
|
3655
3691
|
```
|
|
3656
3692
|
|
|
3693
|
+
Defined in: [packages/fs/src/types.ts:67](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L67)
|
|
3694
|
+
|
|
3657
3695
|
Return content as a Buffer. Default: `false`
|
|
3658
3696
|
|
|
3659
3697
|
##### compression?
|
|
@@ -3662,6 +3700,8 @@ Return content as a Buffer. Default: `false`
|
|
|
3662
3700
|
optional compression: C;
|
|
3663
3701
|
```
|
|
3664
3702
|
|
|
3703
|
+
Defined in: [packages/fs/src/types.ts:72](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L72)
|
|
3704
|
+
|
|
3665
3705
|
Compression method to decompress the file against. Default: `none`
|
|
3666
3706
|
|
|
3667
3707
|
##### encoding?
|
|
@@ -3670,6 +3710,8 @@ Compression method to decompress the file against. Default: `none`
|
|
|
3670
3710
|
optional encoding: ReadFileEncoding;
|
|
3671
3711
|
```
|
|
3672
3712
|
|
|
3713
|
+
Defined in: [packages/fs/src/types.ts:78](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L78)
|
|
3714
|
+
|
|
3673
3715
|
The encoding to use. Default: `utf8`
|
|
3674
3716
|
|
|
3675
3717
|
###### See
|
|
@@ -3682,6 +3724,8 @@ https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
|
|
|
3682
3724
|
optional flag: number | string;
|
|
3683
3725
|
```
|
|
3684
3726
|
|
|
3727
|
+
Defined in: [packages/fs/src/types.ts:83](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L83)
|
|
3728
|
+
|
|
3685
3729
|
The flag used to open the file. Default: `r`
|
|
3686
3730
|
|
|
3687
3731
|
***
|
|
@@ -3692,7 +3736,7 @@ The flag used to open the file. Default: `r`
|
|
|
3692
3736
|
type ReadJsonOptions = CodeFrameOptions & object;
|
|
3693
3737
|
```
|
|
3694
3738
|
|
|
3695
|
-
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/
|
|
3739
|
+
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L104)
|
|
3696
3740
|
|
|
3697
3741
|
#### Type declaration
|
|
3698
3742
|
|
|
@@ -3720,9 +3764,9 @@ optional beforeParse: (source) => string;
|
|
|
3720
3764
|
type WriteFileOptions = object;
|
|
3721
3765
|
```
|
|
3722
3766
|
|
|
3723
|
-
Defined in: [packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/
|
|
3767
|
+
Defined in: [packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L108)
|
|
3724
3768
|
|
|
3725
|
-
####
|
|
3769
|
+
#### Properties
|
|
3726
3770
|
|
|
3727
3771
|
##### chown?
|
|
3728
3772
|
|
|
@@ -3730,15 +3774,17 @@ Defined in: [packages/fs/src/types.ts:108](https://github.com/visulima/visulima/
|
|
|
3730
3774
|
optional chown: object;
|
|
3731
3775
|
```
|
|
3732
3776
|
|
|
3777
|
+
Defined in: [packages/fs/src/types.ts:112](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L112)
|
|
3778
|
+
|
|
3733
3779
|
The group and user ID used to set the file ownership. Default: `undefined`
|
|
3734
3780
|
|
|
3735
|
-
######
|
|
3781
|
+
###### gid
|
|
3736
3782
|
|
|
3737
3783
|
```ts
|
|
3738
3784
|
gid: number;
|
|
3739
3785
|
```
|
|
3740
3786
|
|
|
3741
|
-
######
|
|
3787
|
+
###### uid
|
|
3742
3788
|
|
|
3743
3789
|
```ts
|
|
3744
3790
|
uid: number;
|
|
@@ -3750,6 +3796,8 @@ uid: number;
|
|
|
3750
3796
|
optional encoding: BufferEncoding | null;
|
|
3751
3797
|
```
|
|
3752
3798
|
|
|
3799
|
+
Defined in: [packages/fs/src/types.ts:120](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L120)
|
|
3800
|
+
|
|
3753
3801
|
The encoding to use. Default: `utf8`
|
|
3754
3802
|
|
|
3755
3803
|
##### flag?
|
|
@@ -3758,6 +3806,8 @@ The encoding to use. Default: `utf8`
|
|
|
3758
3806
|
optional flag: string;
|
|
3759
3807
|
```
|
|
3760
3808
|
|
|
3809
|
+
Defined in: [packages/fs/src/types.ts:125](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L125)
|
|
3810
|
+
|
|
3761
3811
|
The flag used to write the file. Default: `w`
|
|
3762
3812
|
|
|
3763
3813
|
##### mode?
|
|
@@ -3766,6 +3816,8 @@ The flag used to write the file. Default: `w`
|
|
|
3766
3816
|
optional mode: number;
|
|
3767
3817
|
```
|
|
3768
3818
|
|
|
3819
|
+
Defined in: [packages/fs/src/types.ts:130](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L130)
|
|
3820
|
+
|
|
3769
3821
|
The file mode (permission and sticky bits). Default: `0o666`
|
|
3770
3822
|
|
|
3771
3823
|
##### overwrite?
|
|
@@ -3774,6 +3826,8 @@ The file mode (permission and sticky bits). Default: `0o666`
|
|
|
3774
3826
|
optional overwrite: boolean;
|
|
3775
3827
|
```
|
|
3776
3828
|
|
|
3829
|
+
Defined in: [packages/fs/src/types.ts:135](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L135)
|
|
3830
|
+
|
|
3777
3831
|
Indicates whether the file should be overwritten if it already exists. Default: `false`
|
|
3778
3832
|
|
|
3779
3833
|
##### recursive?
|
|
@@ -3782,6 +3836,8 @@ Indicates whether the file should be overwritten if it already exists. Default:
|
|
|
3782
3836
|
optional recursive: boolean;
|
|
3783
3837
|
```
|
|
3784
3838
|
|
|
3839
|
+
Defined in: [packages/fs/src/types.ts:140](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L140)
|
|
3840
|
+
|
|
3785
3841
|
Recursively create parent directories if needed. Default: `true`
|
|
3786
3842
|
|
|
3787
3843
|
***
|
|
@@ -3792,7 +3848,7 @@ Recursively create parent directories if needed. Default: `true`
|
|
|
3792
3848
|
type WriteJsonOptions = WriteFileOptions & object;
|
|
3793
3849
|
```
|
|
3794
3850
|
|
|
3795
|
-
Defined in: [packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/
|
|
3851
|
+
Defined in: [packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L146)
|
|
3796
3852
|
|
|
3797
3853
|
#### Type declaration
|
|
3798
3854
|
|
|
@@ -3838,7 +3894,7 @@ Override the default `JSON.stringify` method.
|
|
|
3838
3894
|
|
|
3839
3895
|
###### replacer
|
|
3840
3896
|
|
|
3841
|
-
[`JsonReplacer`](
|
|
3897
|
+
[`JsonReplacer`](#jsonreplacer)
|
|
3842
3898
|
|
|
3843
3899
|
###### space
|
|
3844
3900
|
|
|
@@ -3854,10 +3910,10 @@ Override the default `JSON.stringify` method.
|
|
|
3854
3910
|
### brotliSize()
|
|
3855
3911
|
|
|
3856
3912
|
```ts
|
|
3857
|
-
function brotliSize(input, options?): Promise<number
|
|
3913
|
+
function brotliSize(input, options?): Promise<number>;
|
|
3858
3914
|
```
|
|
3859
3915
|
|
|
3860
|
-
Defined in: [packages/fs/src/size.ts:
|
|
3916
|
+
Defined in: [packages/fs/src/size.ts:112](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/size.ts#L112)
|
|
3861
3917
|
|
|
3862
3918
|
Asynchronously calculates the Brotli compressed size of the input.
|
|
3863
3919
|
Uses memory-efficient streaming for large inputs.
|
|
@@ -3881,10 +3937,10 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3881
3937
|
### brotliSizeSync()
|
|
3882
3938
|
|
|
3883
3939
|
```ts
|
|
3884
|
-
function brotliSizeSync(input, options?): number
|
|
3940
|
+
function brotliSizeSync(input, options?): number;
|
|
3885
3941
|
```
|
|
3886
3942
|
|
|
3887
|
-
Defined in: [packages/fs/src/size.ts:
|
|
3943
|
+
Defined in: [packages/fs/src/size.ts:155](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/size.ts#L155)
|
|
3888
3944
|
|
|
3889
3945
|
Synchronously calculates the Brotli compressed size of the input.
|
|
3890
3946
|
Note: For large files, consider using the async brotliSize function instead.
|
|
@@ -3908,10 +3964,10 @@ Note: For large files, consider using the async brotliSize function instead.
|
|
|
3908
3964
|
### gzipSize()
|
|
3909
3965
|
|
|
3910
3966
|
```ts
|
|
3911
|
-
function gzipSize(input, options?): Promise<number
|
|
3967
|
+
function gzipSize(input, options?): Promise<number>;
|
|
3912
3968
|
```
|
|
3913
3969
|
|
|
3914
|
-
Defined in: [packages/fs/src/size.ts:
|
|
3970
|
+
Defined in: [packages/fs/src/size.ts:101](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/size.ts#L101)
|
|
3915
3971
|
|
|
3916
3972
|
Asynchronously calculates the gzipped size of the input.
|
|
3917
3973
|
Uses memory-efficient streaming for large inputs.
|
|
@@ -3935,10 +3991,10 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3935
3991
|
### gzipSizeSync()
|
|
3936
3992
|
|
|
3937
3993
|
```ts
|
|
3938
|
-
function gzipSizeSync(input, options?): number
|
|
3994
|
+
function gzipSizeSync(input, options?): number;
|
|
3939
3995
|
```
|
|
3940
3996
|
|
|
3941
|
-
Defined in: [packages/fs/src/size.ts:
|
|
3997
|
+
Defined in: [packages/fs/src/size.ts:134](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/size.ts#L134)
|
|
3942
3998
|
|
|
3943
3999
|
Synchronously calculates the gzipped size of the input.
|
|
3944
4000
|
Note: For large files, consider using the async gzipSize function instead.
|
|
@@ -3962,10 +4018,10 @@ Note: For large files, consider using the async gzipSize function instead.
|
|
|
3962
4018
|
### rawSize()
|
|
3963
4019
|
|
|
3964
4020
|
```ts
|
|
3965
|
-
function rawSize(input): Promise<number
|
|
4021
|
+
function rawSize(input): Promise<number>;
|
|
3966
4022
|
```
|
|
3967
4023
|
|
|
3968
|
-
Defined in: [packages/fs/src/size.ts:
|
|
4024
|
+
Defined in: [packages/fs/src/size.ts:123](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/size.ts#L123)
|
|
3969
4025
|
|
|
3970
4026
|
Asynchronously gets the raw size of the input without compression.
|
|
3971
4027
|
Uses memory-efficient streaming for large inputs.
|
|
@@ -3985,10 +4041,10 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3985
4041
|
### rawSizeSync()
|
|
3986
4042
|
|
|
3987
4043
|
```ts
|
|
3988
|
-
function rawSizeSync(input): number
|
|
4044
|
+
function rawSizeSync(input): number;
|
|
3989
4045
|
```
|
|
3990
4046
|
|
|
3991
|
-
Defined in: [packages/fs/src/size.ts:
|
|
4047
|
+
Defined in: [packages/fs/src/size.ts:176](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/size.ts#L176)
|
|
3992
4048
|
|
|
3993
4049
|
Synchronously gets the raw size of the input without compression.
|
|
3994
4050
|
Note: For large files, consider using the async rawSize function instead.
|
|
@@ -4008,7 +4064,7 @@ Note: For large files, consider using the async rawSize function instead.
|
|
|
4008
4064
|
|
|
4009
4065
|
### JSONError
|
|
4010
4066
|
|
|
4011
|
-
Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/visulima/blob/
|
|
4067
|
+
Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L1)
|
|
4012
4068
|
|
|
4013
4069
|
#### Extends
|
|
4014
4070
|
|
|
@@ -4016,13 +4072,13 @@ Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/
|
|
|
4016
4072
|
|
|
4017
4073
|
#### Constructors
|
|
4018
4074
|
|
|
4019
|
-
#####
|
|
4075
|
+
##### Constructor
|
|
4020
4076
|
|
|
4021
4077
|
```ts
|
|
4022
|
-
new JSONError(message): JSONError
|
|
4078
|
+
new JSONError(message): JSONError;
|
|
4023
4079
|
```
|
|
4024
4080
|
|
|
4025
|
-
Defined in: [packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/
|
|
4081
|
+
Defined in: [packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L11)
|
|
4026
4082
|
|
|
4027
4083
|
###### Parameters
|
|
4028
4084
|
|
|
@@ -4032,7 +4088,7 @@ Defined in: [packages/fs/src/error/json-error.ts:11](https://github.com/visulima
|
|
|
4032
4088
|
|
|
4033
4089
|
###### Returns
|
|
4034
4090
|
|
|
4035
|
-
[`JSONError`](
|
|
4091
|
+
[`JSONError`](#jsonerror)
|
|
4036
4092
|
|
|
4037
4093
|
###### Overrides
|
|
4038
4094
|
|
|
@@ -4047,10 +4103,10 @@ Error.constructor
|
|
|
4047
4103
|
###### Get Signature
|
|
4048
4104
|
|
|
4049
4105
|
```ts
|
|
4050
|
-
get message(): string
|
|
4106
|
+
get message(): string;
|
|
4051
4107
|
```
|
|
4052
4108
|
|
|
4053
|
-
Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
4109
|
+
Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L21)
|
|
4054
4110
|
|
|
4055
4111
|
###### Returns
|
|
4056
4112
|
|
|
@@ -4059,10 +4115,10 @@ Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima
|
|
|
4059
4115
|
###### Set Signature
|
|
4060
4116
|
|
|
4061
4117
|
```ts
|
|
4062
|
-
set message(message): void
|
|
4118
|
+
set message(message): void;
|
|
4063
4119
|
```
|
|
4064
4120
|
|
|
4065
|
-
Defined in: [packages/fs/src/error/json-error.ts:25](https://github.com/visulima/visulima/blob/
|
|
4121
|
+
Defined in: [packages/fs/src/error/json-error.ts:25](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L25)
|
|
4066
4122
|
|
|
4067
4123
|
###### Parameters
|
|
4068
4124
|
|
|
@@ -4085,7 +4141,7 @@ Error.message
|
|
|
4085
4141
|
##### captureStackTrace()
|
|
4086
4142
|
|
|
4087
4143
|
```ts
|
|
4088
|
-
static captureStackTrace(targetObject, constructorOpt?): void
|
|
4144
|
+
static captureStackTrace(targetObject, constructorOpt?): void;
|
|
4089
4145
|
```
|
|
4090
4146
|
|
|
4091
4147
|
Defined in: node\_modules/.pnpm/@types+node@18.19.71/node\_modules/@types/node/globals.d.ts:91
|
|
@@ -4120,7 +4176,7 @@ Error.captureStackTrace
|
|
|
4120
4176
|
optional cause: unknown;
|
|
4121
4177
|
```
|
|
4122
4178
|
|
|
4123
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
4179
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
4124
4180
|
|
|
4125
4181
|
###### Inherited from
|
|
4126
4182
|
|
|
@@ -4134,7 +4190,7 @@ Error.cause
|
|
|
4134
4190
|
codeFrame: string;
|
|
4135
4191
|
```
|
|
4136
4192
|
|
|
4137
|
-
Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
4193
|
+
Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L4)
|
|
4138
4194
|
|
|
4139
4195
|
##### fileName
|
|
4140
4196
|
|
|
@@ -4142,7 +4198,7 @@ Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/
|
|
|
4142
4198
|
fileName: string;
|
|
4143
4199
|
```
|
|
4144
4200
|
|
|
4145
|
-
Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/
|
|
4201
|
+
Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L2)
|
|
4146
4202
|
|
|
4147
4203
|
##### name
|
|
4148
4204
|
|
|
@@ -4150,7 +4206,7 @@ Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/
|
|
|
4150
4206
|
readonly name: "JSONError" = "JSONError";
|
|
4151
4207
|
```
|
|
4152
4208
|
|
|
4153
|
-
Defined in: [packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/
|
|
4209
|
+
Defined in: [packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/error/json-error.ts#L7)
|
|
4154
4210
|
|
|
4155
4211
|
###### Overrides
|
|
4156
4212
|
|
|
@@ -4164,7 +4220,7 @@ Error.name
|
|
|
4164
4220
|
optional stack: string;
|
|
4165
4221
|
```
|
|
4166
4222
|
|
|
4167
|
-
Defined in: node\_modules/.pnpm/typescript@5.8.
|
|
4223
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.3/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
4168
4224
|
|
|
4169
4225
|
###### Inherited from
|
|
4170
4226
|
|
|
@@ -4225,10 +4281,10 @@ Error.stackTraceLimit
|
|
|
4225
4281
|
### assertValidFileContents()
|
|
4226
4282
|
|
|
4227
4283
|
```ts
|
|
4228
|
-
function assertValidFileContents(contents): void
|
|
4284
|
+
function assertValidFileContents(contents): void;
|
|
4229
4285
|
```
|
|
4230
4286
|
|
|
4231
|
-
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/
|
|
4287
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/utils/assert-valid-file-contents.ts#L2)
|
|
4232
4288
|
|
|
4233
4289
|
#### Parameters
|
|
4234
4290
|
|
|
@@ -4245,10 +4301,10 @@ Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://gith
|
|
|
4245
4301
|
### assertValidFileOrDirectoryPath()
|
|
4246
4302
|
|
|
4247
4303
|
```ts
|
|
4248
|
-
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
4304
|
+
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void;
|
|
4249
4305
|
```
|
|
4250
4306
|
|
|
4251
|
-
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/
|
|
4307
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L2)
|
|
4252
4308
|
|
|
4253
4309
|
#### Parameters
|
|
4254
4310
|
|
|
@@ -4270,14 +4326,16 @@ Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](htt
|
|
|
4270
4326
|
function parseJson<T>(
|
|
4271
4327
|
string,
|
|
4272
4328
|
filename?,
|
|
4273
|
-
options?): T
|
|
4329
|
+
options?): T;
|
|
4274
4330
|
```
|
|
4275
4331
|
|
|
4276
|
-
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/
|
|
4332
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/utils/parse-json.ts#L60)
|
|
4277
4333
|
|
|
4278
4334
|
##### Type Parameters
|
|
4279
4335
|
|
|
4280
|
-
|
|
4336
|
+
###### T
|
|
4337
|
+
|
|
4338
|
+
`T` = `JsonValue`
|
|
4281
4339
|
|
|
4282
4340
|
##### Parameters
|
|
4283
4341
|
|
|
@@ -4304,14 +4362,16 @@ function parseJson<T>(
|
|
|
4304
4362
|
string,
|
|
4305
4363
|
reviver,
|
|
4306
4364
|
fileName?,
|
|
4307
|
-
options?): T
|
|
4365
|
+
options?): T;
|
|
4308
4366
|
```
|
|
4309
4367
|
|
|
4310
|
-
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/
|
|
4368
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/utils/parse-json.ts#L61)
|
|
4311
4369
|
|
|
4312
4370
|
##### Type Parameters
|
|
4313
4371
|
|
|
4314
|
-
|
|
4372
|
+
###### T
|
|
4373
|
+
|
|
4374
|
+
`T` = `JsonValue`
|
|
4315
4375
|
|
|
4316
4376
|
##### Parameters
|
|
4317
4377
|
|
|
@@ -4340,10 +4400,10 @@ Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima
|
|
|
4340
4400
|
### stripJsonComments()
|
|
4341
4401
|
|
|
4342
4402
|
```ts
|
|
4343
|
-
function stripJsonComments(jsonString, __namedParameters): string
|
|
4403
|
+
function stripJsonComments(jsonString, __namedParameters): string;
|
|
4344
4404
|
```
|
|
4345
4405
|
|
|
4346
|
-
Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/
|
|
4406
|
+
Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/utils/strip-json-comments.ts#L5)
|
|
4347
4407
|
|
|
4348
4408
|
#### Parameters
|
|
4349
4409
|
|
|
@@ -4361,21 +4421,21 @@ Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/
|
|
|
4361
4421
|
|
|
4362
4422
|
`string`
|
|
4363
4423
|
|
|
4364
|
-
|
|
4424
|
+
## Variables
|
|
4365
4425
|
|
|
4366
4426
|
### toPath()
|
|
4367
4427
|
|
|
4368
4428
|
```ts
|
|
4369
|
-
|
|
4429
|
+
const toPath: (urlOrPath) => string;
|
|
4370
4430
|
```
|
|
4371
4431
|
|
|
4372
|
-
Defined in: node\_modules/.pnpm/@visulima+path@1.3.
|
|
4432
|
+
Defined in: node\_modules/.pnpm/@visulima+path@1.3.5/node\_modules/@visulima/path/dist/utils.d.mts:7
|
|
4373
4433
|
|
|
4374
4434
|
#### Parameters
|
|
4375
4435
|
|
|
4376
4436
|
##### urlOrPath
|
|
4377
4437
|
|
|
4378
|
-
`
|
|
4438
|
+
`URL` | `string`
|
|
4379
4439
|
|
|
4380
4440
|
#### Returns
|
|
4381
4441
|
|
|
@@ -4389,14 +4449,16 @@ Defined in: node\_modules/.pnpm/@visulima+path@1.3.4/node\_modules/@visulima/pat
|
|
|
4389
4449
|
#### Call Signature
|
|
4390
4450
|
|
|
4391
4451
|
```ts
|
|
4392
|
-
function readYaml<R>(path, options?): Promise<R
|
|
4452
|
+
function readYaml<R>(path, options?): Promise<R>;
|
|
4393
4453
|
```
|
|
4394
4454
|
|
|
4395
|
-
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/
|
|
4455
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-yaml.ts#L6)
|
|
4396
4456
|
|
|
4397
4457
|
##### Type Parameters
|
|
4398
4458
|
|
|
4399
|
-
|
|
4459
|
+
###### R
|
|
4460
|
+
|
|
4461
|
+
`R` = `Record`\<`string`, `unknown`\>
|
|
4400
4462
|
|
|
4401
4463
|
##### Parameters
|
|
4402
4464
|
|
|
@@ -4418,14 +4480,16 @@ Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/vi
|
|
|
4418
4480
|
function readYaml<R>(
|
|
4419
4481
|
path,
|
|
4420
4482
|
reviver?,
|
|
4421
|
-
options?): Promise<R
|
|
4483
|
+
options?): Promise<R>;
|
|
4422
4484
|
```
|
|
4423
4485
|
|
|
4424
|
-
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/
|
|
4486
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-yaml.ts#L7)
|
|
4425
4487
|
|
|
4426
4488
|
##### Type Parameters
|
|
4427
4489
|
|
|
4428
|
-
|
|
4490
|
+
###### R
|
|
4491
|
+
|
|
4492
|
+
`R` = `Record`\<`string`, `unknown`\>
|
|
4429
4493
|
|
|
4430
4494
|
##### Parameters
|
|
4431
4495
|
|
|
@@ -4452,14 +4516,16 @@ Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/vi
|
|
|
4452
4516
|
#### Call Signature
|
|
4453
4517
|
|
|
4454
4518
|
```ts
|
|
4455
|
-
function readYamlSync<R>(path, options?): R
|
|
4519
|
+
function readYamlSync<R>(path, options?): R;
|
|
4456
4520
|
```
|
|
4457
4521
|
|
|
4458
|
-
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/
|
|
4522
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
4459
4523
|
|
|
4460
4524
|
##### Type Parameters
|
|
4461
4525
|
|
|
4462
|
-
|
|
4526
|
+
###### R
|
|
4527
|
+
|
|
4528
|
+
`R` = `Record`\<`string`, `unknown`\>
|
|
4463
4529
|
|
|
4464
4530
|
##### Parameters
|
|
4465
4531
|
|
|
@@ -4481,14 +4547,16 @@ Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visuli
|
|
|
4481
4547
|
function readYamlSync<R>(
|
|
4482
4548
|
path,
|
|
4483
4549
|
reviver?,
|
|
4484
|
-
options?): R
|
|
4550
|
+
options?): R;
|
|
4485
4551
|
```
|
|
4486
4552
|
|
|
4487
|
-
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/
|
|
4553
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
4488
4554
|
|
|
4489
4555
|
##### Type Parameters
|
|
4490
4556
|
|
|
4491
|
-
|
|
4557
|
+
###### R
|
|
4558
|
+
|
|
4559
|
+
`R` = `Record`\<`string`, `unknown`\>
|
|
4492
4560
|
|
|
4493
4561
|
##### Parameters
|
|
4494
4562
|
|
|
@@ -4518,10 +4586,10 @@ Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visuli
|
|
|
4518
4586
|
function writeYaml(
|
|
4519
4587
|
path,
|
|
4520
4588
|
data,
|
|
4521
|
-
options?): Promise<void
|
|
4589
|
+
options?): Promise<void>;
|
|
4522
4590
|
```
|
|
4523
4591
|
|
|
4524
|
-
Defined in: [packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/
|
|
4592
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-yaml.ts#L10)
|
|
4525
4593
|
|
|
4526
4594
|
##### Parameters
|
|
4527
4595
|
|
|
@@ -4548,10 +4616,10 @@ function writeYaml(
|
|
|
4548
4616
|
path,
|
|
4549
4617
|
data,
|
|
4550
4618
|
replacer?,
|
|
4551
|
-
options?): Promise<void
|
|
4619
|
+
options?): Promise<void>;
|
|
4552
4620
|
```
|
|
4553
4621
|
|
|
4554
|
-
Defined in: [packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/
|
|
4622
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-yaml.ts#L16)
|
|
4555
4623
|
|
|
4556
4624
|
##### Parameters
|
|
4557
4625
|
|
|
@@ -4585,10 +4653,10 @@ Defined in: [packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima
|
|
|
4585
4653
|
function writeYamlSync(
|
|
4586
4654
|
path,
|
|
4587
4655
|
data,
|
|
4588
|
-
options?): void
|
|
4656
|
+
options?): void;
|
|
4589
4657
|
```
|
|
4590
4658
|
|
|
4591
|
-
Defined in: [packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
4659
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-yaml-sync.ts#L10)
|
|
4592
4660
|
|
|
4593
4661
|
##### Parameters
|
|
4594
4662
|
|
|
@@ -4615,10 +4683,10 @@ function writeYamlSync(
|
|
|
4615
4683
|
path,
|
|
4616
4684
|
data,
|
|
4617
4685
|
replacer?,
|
|
4618
|
-
options?): void
|
|
4686
|
+
options?): void;
|
|
4619
4687
|
```
|
|
4620
4688
|
|
|
4621
|
-
Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
4689
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/write/write-yaml-sync.ts#L16)
|
|
4622
4690
|
|
|
4623
4691
|
##### Parameters
|
|
4624
4692
|
|
|
@@ -4650,7 +4718,7 @@ Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/vis
|
|
|
4650
4718
|
type YamlReplacer = JsonReplacer;
|
|
4651
4719
|
```
|
|
4652
4720
|
|
|
4653
|
-
Defined in: [packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/
|
|
4721
|
+
Defined in: [packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/605d0fc030334277c4a55eed06631ab95f470bdd/packages/fs/src/types.ts#L144)
|
|
4654
4722
|
|
|
4655
4723
|
<!-- /TYPEDOC -->
|
|
4656
4724
|
|