@visulima/fs 3.1.0 → 3.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +10 -0
- package/README.md +166 -165
- package/dist/error.d.ts +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.d.ts +3 -3
- package/dist/index.mjs +2 -2
- package/dist/packem_shared/{collect-BtDVJEOm.mjs → collect-DIZ3yuRZ.mjs} +1 -1
- package/dist/packem_shared/{collect-DxUriHCH.cjs → collect-DZVa0P7v.cjs} +1 -1
- package/dist/packem_shared/{walk-BW7b4GXI.cjs → walk-1LfF6MKY.cjs} +6 -12
- package/dist/packem_shared/{walk-CNcSYQVq.mjs → walk-CSp2zlI2.mjs} +6 -12
- package/dist/utils.d.ts +3 -3
- package/dist/yaml.d.ts +1 -1
- package/package.json +1 -1
- /package/dist/packem_shared/{json-error-ZPgZIXcg.d.mjs → json-error-ZPgZIXcg.d.ts} +0 -0
- /package/dist/packem_shared/{observable-like.d-BlD8q22s.d.mjs → observable-like.d-BlD8q22s.d.ts} +0 -0
- /package/dist/packem_shared/{types-CiwAWOQj.d.mjs → types-CiwAWOQj.d.ts} +0 -0
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/already-exists-error.ts#L4)
|
|
463
463
|
|
|
464
464
|
Error thrown when file already exists.
|
|
465
465
|
|
|
@@ -475,7 +475,7 @@ Error thrown when file already exists.
|
|
|
475
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/already-exists-error.ts#L9)
|
|
479
479
|
|
|
480
480
|
Creates a new instance.
|
|
481
481
|
|
|
@@ -507,7 +507,7 @@ Error.constructor
|
|
|
507
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/already-exists-error.ts#L14)
|
|
511
511
|
|
|
512
512
|
###### Returns
|
|
513
513
|
|
|
@@ -519,7 +519,7 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:14](https://github.co
|
|
|
519
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/already-exists-error.ts#L19)
|
|
523
523
|
|
|
524
524
|
###### Parameters
|
|
525
525
|
|
|
@@ -539,7 +539,7 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:19](https://github.co
|
|
|
539
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/already-exists-error.ts#L24)
|
|
543
543
|
|
|
544
544
|
###### Returns
|
|
545
545
|
|
|
@@ -551,7 +551,7 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:24](https://github.co
|
|
|
551
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/already-exists-error.ts#L29)
|
|
555
555
|
|
|
556
556
|
###### Parameters
|
|
557
557
|
|
|
@@ -609,7 +609,7 @@ Error.captureStackTrace
|
|
|
609
609
|
optional cause: unknown;
|
|
610
610
|
```
|
|
611
611
|
|
|
612
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
612
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
626
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
640
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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/8efc158e8358bd5becfd263879837701b26d16d4/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
|
|
|
@@ -713,7 +713,7 @@ Error thrown when an operation is not allowed on a directory.
|
|
|
713
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/directory-error.ts#L9)
|
|
717
717
|
|
|
718
718
|
Creates a new instance.
|
|
719
719
|
|
|
@@ -745,7 +745,7 @@ Error.constructor
|
|
|
745
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/directory-error.ts#L14)
|
|
749
749
|
|
|
750
750
|
###### Returns
|
|
751
751
|
|
|
@@ -757,7 +757,7 @@ Defined in: [packages/fs/src/error/directory-error.ts:14](https://github.com/vis
|
|
|
757
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/directory-error.ts#L19)
|
|
761
761
|
|
|
762
762
|
###### Parameters
|
|
763
763
|
|
|
@@ -777,7 +777,7 @@ Defined in: [packages/fs/src/error/directory-error.ts:19](https://github.com/vis
|
|
|
777
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/directory-error.ts#L24)
|
|
781
781
|
|
|
782
782
|
###### Returns
|
|
783
783
|
|
|
@@ -789,7 +789,7 @@ Defined in: [packages/fs/src/error/directory-error.ts:24](https://github.com/vis
|
|
|
789
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/directory-error.ts#L29)
|
|
793
793
|
|
|
794
794
|
###### Parameters
|
|
795
795
|
|
|
@@ -847,7 +847,7 @@ Error.captureStackTrace
|
|
|
847
847
|
optional cause: unknown;
|
|
848
848
|
```
|
|
849
849
|
|
|
850
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
850
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
864
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
878
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-empty-error.ts#L4)
|
|
939
939
|
|
|
940
940
|
Error thrown when a directory is not empty.
|
|
941
941
|
|
|
@@ -951,7 +951,7 @@ Error thrown when a directory is not empty.
|
|
|
951
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-empty-error.ts#L9)
|
|
955
955
|
|
|
956
956
|
Creates a new instance.
|
|
957
957
|
|
|
@@ -983,7 +983,7 @@ Error.constructor
|
|
|
983
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-empty-error.ts#L14)
|
|
987
987
|
|
|
988
988
|
###### Returns
|
|
989
989
|
|
|
@@ -995,7 +995,7 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:14](https://github.com/vis
|
|
|
995
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-empty-error.ts#L19)
|
|
999
999
|
|
|
1000
1000
|
###### Parameters
|
|
1001
1001
|
|
|
@@ -1015,7 +1015,7 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:19](https://github.com/vis
|
|
|
1015
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-empty-error.ts#L24)
|
|
1019
1019
|
|
|
1020
1020
|
###### Returns
|
|
1021
1021
|
|
|
@@ -1027,7 +1027,7 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:24](https://github.com/vis
|
|
|
1027
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-empty-error.ts#L29)
|
|
1031
1031
|
|
|
1032
1032
|
###### Parameters
|
|
1033
1033
|
|
|
@@ -1085,7 +1085,7 @@ Error.captureStackTrace
|
|
|
1085
1085
|
optional cause: unknown;
|
|
1086
1086
|
```
|
|
1087
1087
|
|
|
1088
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
1088
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1102
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1116
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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/8efc158e8358bd5becfd263879837701b26d16d4/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
|
|
|
@@ -1189,7 +1189,7 @@ Error thrown when a file or directory is not found.
|
|
|
1189
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-found-error.ts#L9)
|
|
1193
1193
|
|
|
1194
1194
|
Creates a new instance.
|
|
1195
1195
|
|
|
@@ -1221,7 +1221,7 @@ Error.constructor
|
|
|
1221
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-found-error.ts#L14)
|
|
1225
1225
|
|
|
1226
1226
|
###### Returns
|
|
1227
1227
|
|
|
@@ -1233,7 +1233,7 @@ Defined in: [packages/fs/src/error/not-found-error.ts:14](https://github.com/vis
|
|
|
1233
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-found-error.ts#L19)
|
|
1237
1237
|
|
|
1238
1238
|
###### Parameters
|
|
1239
1239
|
|
|
@@ -1253,7 +1253,7 @@ Defined in: [packages/fs/src/error/not-found-error.ts:19](https://github.com/vis
|
|
|
1253
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-found-error.ts#L24)
|
|
1257
1257
|
|
|
1258
1258
|
###### Returns
|
|
1259
1259
|
|
|
@@ -1265,7 +1265,7 @@ Defined in: [packages/fs/src/error/not-found-error.ts:24](https://github.com/vis
|
|
|
1265
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/not-found-error.ts#L29)
|
|
1269
1269
|
|
|
1270
1270
|
###### Parameters
|
|
1271
1271
|
|
|
@@ -1323,7 +1323,7 @@ Error.captureStackTrace
|
|
|
1323
1323
|
optional cause: unknown;
|
|
1324
1324
|
```
|
|
1325
1325
|
|
|
1326
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
1326
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1340
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1354
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/permission-error.ts#L4)
|
|
1415
1415
|
|
|
1416
1416
|
Error thrown when an operation is not permitted.
|
|
1417
1417
|
|
|
@@ -1427,7 +1427,7 @@ Error thrown when an operation is not permitted.
|
|
|
1427
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/permission-error.ts#L9)
|
|
1431
1431
|
|
|
1432
1432
|
Creates a new instance.
|
|
1433
1433
|
|
|
@@ -1459,7 +1459,7 @@ Error.constructor
|
|
|
1459
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/permission-error.ts#L14)
|
|
1463
1463
|
|
|
1464
1464
|
###### Returns
|
|
1465
1465
|
|
|
@@ -1471,7 +1471,7 @@ Defined in: [packages/fs/src/error/permission-error.ts:14](https://github.com/vi
|
|
|
1471
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/permission-error.ts#L19)
|
|
1475
1475
|
|
|
1476
1476
|
###### Parameters
|
|
1477
1477
|
|
|
@@ -1491,7 +1491,7 @@ Defined in: [packages/fs/src/error/permission-error.ts:19](https://github.com/vi
|
|
|
1491
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/permission-error.ts#L24)
|
|
1495
1495
|
|
|
1496
1496
|
###### Returns
|
|
1497
1497
|
|
|
@@ -1503,7 +1503,7 @@ Defined in: [packages/fs/src/error/permission-error.ts:24](https://github.com/vi
|
|
|
1503
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/permission-error.ts#L29)
|
|
1507
1507
|
|
|
1508
1508
|
###### Parameters
|
|
1509
1509
|
|
|
@@ -1561,7 +1561,7 @@ Error.captureStackTrace
|
|
|
1561
1561
|
optional cause: unknown;
|
|
1562
1562
|
```
|
|
1563
1563
|
|
|
1564
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
1564
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1578
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1592
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/walk-error.ts#L7)
|
|
1653
1653
|
|
|
1654
1654
|
Error thrown in walk or walkSync during iteration.
|
|
1655
1655
|
|
|
@@ -1665,7 +1665,7 @@ Error thrown in walk or walkSync during iteration.
|
|
|
1665
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/walk-error.ts#L12)
|
|
1669
1669
|
|
|
1670
1670
|
Constructs a new instance.
|
|
1671
1671
|
|
|
@@ -1699,7 +1699,7 @@ Error.constructor
|
|
|
1699
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/walk-error.ts#L21)
|
|
1703
1703
|
|
|
1704
1704
|
###### Returns
|
|
1705
1705
|
|
|
@@ -1711,7 +1711,7 @@ Defined in: [packages/fs/src/error/walk-error.ts:21](https://github.com/visulima
|
|
|
1711
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/walk-error.ts#L26)
|
|
1715
1715
|
|
|
1716
1716
|
###### Parameters
|
|
1717
1717
|
|
|
@@ -1769,7 +1769,7 @@ Error.captureStackTrace
|
|
|
1769
1769
|
optional cause: unknown;
|
|
1770
1770
|
```
|
|
1771
1771
|
|
|
1772
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
1772
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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.
|
|
1786
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
1810
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1811
1811
|
|
|
1812
1812
|
###### Inherited from
|
|
1813
1813
|
|
|
@@ -1878,7 +1878,7 @@ Re-exports [JSONError](utils.md#jsonerror)
|
|
|
1878
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/find/collect.ts#L4)
|
|
1882
1882
|
|
|
1883
1883
|
#### Parameters
|
|
1884
1884
|
|
|
@@ -1902,7 +1902,7 @@ Defined in: [packages/fs/src/find/collect.ts:4](https://github.com/visulima/visu
|
|
|
1902
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/find/collect-sync.ts#L4)
|
|
1906
1906
|
|
|
1907
1907
|
#### Parameters
|
|
1908
1908
|
|
|
@@ -1926,7 +1926,7 @@ Defined in: [packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima
|
|
|
1926
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/eol.ts#L20)
|
|
1930
1930
|
|
|
1931
1931
|
Detect the EOL character for string input.
|
|
1932
1932
|
Returns null if no newline.
|
|
@@ -1949,7 +1949,7 @@ Returns null if no newline.
|
|
|
1949
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -1978,7 +1978,7 @@ The directory itself is not deleted.
|
|
|
1978
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2007,7 +2007,7 @@ The directory itself is not deleted.
|
|
|
2007
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2030,7 +2030,7 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
2030
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2053,7 +2053,7 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
2053
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/8efc158e8358bd5becfd263879837701b26d16d4/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,
|
|
@@ -2077,7 +2077,7 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
2077
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/8efc158e8358bd5becfd263879837701b26d16d4/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,
|
|
@@ -2101,7 +2101,7 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
2101
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2128,7 +2128,7 @@ If the directory structure does not exist, it is created.
|
|
|
2128
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2158,7 +2158,7 @@ function ensureSymlink(
|
|
|
2158
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2201,7 +2201,7 @@ function ensureSymlinkSync(
|
|
|
2201
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/8efc158e8358bd5becfd263879837701b26d16d4/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.
|
|
@@ -2241,7 +2241,7 @@ A void.
|
|
|
2241
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/find/find-up.ts#L11)
|
|
2245
2245
|
|
|
2246
2246
|
#### Parameters
|
|
2247
2247
|
|
|
@@ -2265,7 +2265,7 @@ Defined in: [packages/fs/src/find/find-up.ts:11](https://github.com/visulima/vis
|
|
|
2265
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/find/find-up-sync.ts#L11)
|
|
2269
2269
|
|
|
2270
2270
|
#### Parameters
|
|
2271
2271
|
|
|
@@ -2289,7 +2289,7 @@ Defined in: [packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulim
|
|
|
2289
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/eol.ts#L36)
|
|
2293
2293
|
|
|
2294
2294
|
Format the file to the targeted EOL.
|
|
2295
2295
|
|
|
@@ -2315,7 +2315,7 @@ Format the file to the targeted EOL.
|
|
|
2315
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/8efc158e8358bd5becfd263879837701b26d16d4/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
|
|
|
@@ -2341,7 +2341,7 @@ Returns a Promise that resolves to a boolean indicating if the path is accessibl
|
|
|
2341
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/8efc158e8358bd5becfd263879837701b26d16d4/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
|
|
|
@@ -2370,7 +2370,7 @@ function move(
|
|
|
2370
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/move/index.ts#L35)
|
|
2374
2374
|
|
|
2375
2375
|
Move a file asynchronously.
|
|
2376
2376
|
|
|
@@ -2420,7 +2420,7 @@ function moveSync(
|
|
|
2420
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/move/index.ts#L61)
|
|
2424
2424
|
|
|
2425
2425
|
Move a file synchronously.
|
|
2426
2426
|
|
|
@@ -2467,7 +2467,7 @@ console.log('The file has been moved');
|
|
|
2467
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/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-file.ts#L20)
|
|
2471
2471
|
|
|
2472
2472
|
#### Type Parameters
|
|
2473
2473
|
|
|
@@ -2495,7 +2495,7 @@ Defined in: [packages/fs/src/read/read-file.ts:20](https://github.com/visulima/v
|
|
|
2495
2495
|
function readFileSync<O>(path, options?): ContentType<O>
|
|
2496
2496
|
```
|
|
2497
2497
|
|
|
2498
|
-
Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
2498
|
+
Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-file-sync.ts#L18)
|
|
2499
2499
|
|
|
2500
2500
|
#### Type Parameters
|
|
2501
2501
|
|
|
@@ -2525,7 +2525,7 @@ Defined in: [packages/fs/src/read/read-file-sync.ts:18](https://github.com/visul
|
|
|
2525
2525
|
function readJson<T>(path, options?): Promise<T>
|
|
2526
2526
|
```
|
|
2527
2527
|
|
|
2528
|
-
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/
|
|
2528
|
+
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-json.ts#L8)
|
|
2529
2529
|
|
|
2530
2530
|
##### Type Parameters
|
|
2531
2531
|
|
|
@@ -2554,7 +2554,7 @@ function readJson<T>(
|
|
|
2554
2554
|
options?): Promise<T>
|
|
2555
2555
|
```
|
|
2556
2556
|
|
|
2557
|
-
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/
|
|
2557
|
+
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-json.ts#L10)
|
|
2558
2558
|
|
|
2559
2559
|
##### Type Parameters
|
|
2560
2560
|
|
|
@@ -2588,7 +2588,7 @@ Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/v
|
|
|
2588
2588
|
function readJsonSync<T>(path, options?): T
|
|
2589
2589
|
```
|
|
2590
2590
|
|
|
2591
|
-
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/
|
|
2591
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-json-sync.ts#L8)
|
|
2592
2592
|
|
|
2593
2593
|
##### Type Parameters
|
|
2594
2594
|
|
|
@@ -2617,7 +2617,7 @@ function readJsonSync<T>(
|
|
|
2617
2617
|
options?): T
|
|
2618
2618
|
```
|
|
2619
2619
|
|
|
2620
|
-
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
2620
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-json-sync.ts#L10)
|
|
2621
2621
|
|
|
2622
2622
|
##### Type Parameters
|
|
2623
2623
|
|
|
@@ -2649,7 +2649,7 @@ Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visul
|
|
|
2649
2649
|
function remove(path, options): Promise<void>
|
|
2650
2650
|
```
|
|
2651
2651
|
|
|
2652
|
-
Defined in: [packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/
|
|
2652
|
+
Defined in: [packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/remove/remove.ts#L5)
|
|
2653
2653
|
|
|
2654
2654
|
#### Parameters
|
|
2655
2655
|
|
|
@@ -2659,7 +2659,7 @@ Defined in: [packages/fs/src/remove/remove.ts:5](https://github.com/visulima/vis
|
|
|
2659
2659
|
|
|
2660
2660
|
##### options
|
|
2661
2661
|
|
|
2662
|
-
###### maxRetries
|
|
2662
|
+
###### maxRetries?
|
|
2663
2663
|
|
|
2664
2664
|
`number`
|
|
2665
2665
|
|
|
@@ -2675,7 +2675,7 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
2675
2675
|
0
|
|
2676
2676
|
```
|
|
2677
2677
|
|
|
2678
|
-
###### retryDelay
|
|
2678
|
+
###### retryDelay?
|
|
2679
2679
|
|
|
2680
2680
|
`number`
|
|
2681
2681
|
|
|
@@ -2700,7 +2700,7 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2700
2700
|
function removeSync(path, options): void
|
|
2701
2701
|
```
|
|
2702
2702
|
|
|
2703
|
-
Defined in: [packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/
|
|
2703
|
+
Defined in: [packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/remove/remove-sync.ts#L5)
|
|
2704
2704
|
|
|
2705
2705
|
#### Parameters
|
|
2706
2706
|
|
|
@@ -2710,7 +2710,7 @@ Defined in: [packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulim
|
|
|
2710
2710
|
|
|
2711
2711
|
##### options
|
|
2712
2712
|
|
|
2713
|
-
###### maxRetries
|
|
2713
|
+
###### maxRetries?
|
|
2714
2714
|
|
|
2715
2715
|
`number`
|
|
2716
2716
|
|
|
@@ -2726,7 +2726,7 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
2726
2726
|
0
|
|
2727
2727
|
```
|
|
2728
2728
|
|
|
2729
|
-
###### retryDelay
|
|
2729
|
+
###### retryDelay?
|
|
2730
2730
|
|
|
2731
2731
|
`number`
|
|
2732
2732
|
|
|
@@ -2754,7 +2754,7 @@ function rename(
|
|
|
2754
2754
|
options?): Promise<void>
|
|
2755
2755
|
```
|
|
2756
2756
|
|
|
2757
|
-
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/
|
|
2757
|
+
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/move/index.ts#L85)
|
|
2758
2758
|
|
|
2759
2759
|
Rename a file asynchronously.
|
|
2760
2760
|
|
|
@@ -2804,7 +2804,7 @@ function renameSync(
|
|
|
2804
2804
|
options?): void
|
|
2805
2805
|
```
|
|
2806
2806
|
|
|
2807
|
-
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/
|
|
2807
|
+
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/move/index.ts#L109)
|
|
2808
2808
|
|
|
2809
2809
|
Rename a file synchronously.
|
|
2810
2810
|
|
|
@@ -2851,7 +2851,7 @@ console.log('The file has been renamed');
|
|
|
2851
2851
|
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry>
|
|
2852
2852
|
```
|
|
2853
2853
|
|
|
2854
|
-
Defined in: [packages/fs/src/find/walk.ts:
|
|
2854
|
+
Defined in: [packages/fs/src/find/walk.ts:49](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/find/walk.ts#L49)
|
|
2855
2855
|
|
|
2856
2856
|
Walks the file tree rooted at root, yielding each file or directory in the
|
|
2857
2857
|
tree filtered according to the given options.
|
|
@@ -2887,7 +2887,7 @@ Options:
|
|
|
2887
2887
|
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry>
|
|
2888
2888
|
```
|
|
2889
2889
|
|
|
2890
|
-
Defined in: [packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/
|
|
2890
|
+
Defined in: [packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/find/walk-sync.ts#L40)
|
|
2891
2891
|
|
|
2892
2892
|
Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
2893
2893
|
|
|
@@ -2916,7 +2916,7 @@ function writeFile(
|
|
|
2916
2916
|
options?): Promise<void>
|
|
2917
2917
|
```
|
|
2918
2918
|
|
|
2919
|
-
Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/
|
|
2919
|
+
Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-file.ts#L15)
|
|
2920
2920
|
|
|
2921
2921
|
#### Parameters
|
|
2922
2922
|
|
|
@@ -2926,7 +2926,7 @@ Defined in: [packages/fs/src/write/write-file.ts:15](https://github.com/visulima
|
|
|
2926
2926
|
|
|
2927
2927
|
##### content
|
|
2928
2928
|
|
|
2929
|
-
`string` | `ArrayBuffer` | `ArrayBufferView
|
|
2929
|
+
`string` | `ArrayBuffer` | `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
2930
2930
|
|
|
2931
2931
|
##### options?
|
|
2932
2932
|
|
|
@@ -2947,7 +2947,7 @@ function writeFileSync(
|
|
|
2947
2947
|
options?): void
|
|
2948
2948
|
```
|
|
2949
2949
|
|
|
2950
|
-
Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
2950
|
+
Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-file-sync.ts#L15)
|
|
2951
2951
|
|
|
2952
2952
|
#### Parameters
|
|
2953
2953
|
|
|
@@ -2957,7 +2957,7 @@ Defined in: [packages/fs/src/write/write-file-sync.ts:15](https://github.com/vis
|
|
|
2957
2957
|
|
|
2958
2958
|
##### content
|
|
2959
2959
|
|
|
2960
|
-
`string` | `ArrayBuffer` | `ArrayBufferView
|
|
2960
|
+
`string` | `ArrayBuffer` | `ArrayBufferView`\<`ArrayBufferLike`\>
|
|
2961
2961
|
|
|
2962
2962
|
##### options?
|
|
2963
2963
|
|
|
@@ -2978,7 +2978,7 @@ function writeJson(
|
|
|
2978
2978
|
options): Promise<void>
|
|
2979
2979
|
```
|
|
2980
2980
|
|
|
2981
|
-
Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/
|
|
2981
|
+
Defined in: [packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-json.ts#L11)
|
|
2982
2982
|
|
|
2983
2983
|
#### Parameters
|
|
2984
2984
|
|
|
@@ -3009,7 +3009,7 @@ function writeJsonSync(
|
|
|
3009
3009
|
options): void
|
|
3010
3010
|
```
|
|
3011
3011
|
|
|
3012
|
-
Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
3012
|
+
Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-json-sync.ts#L11)
|
|
3013
3013
|
|
|
3014
3014
|
#### Parameters
|
|
3015
3015
|
|
|
@@ -3037,7 +3037,7 @@ Defined in: [packages/fs/src/write/write-json-sync.ts:11](https://github.com/vis
|
|
|
3037
3037
|
const CRLF: "\r\n";
|
|
3038
3038
|
```
|
|
3039
3039
|
|
|
3040
|
-
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/
|
|
3040
|
+
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/eol.ts#L9)
|
|
3041
3041
|
|
|
3042
3042
|
End-of-line character for Windows platforms.
|
|
3043
3043
|
|
|
@@ -3049,7 +3049,7 @@ End-of-line character for Windows platforms.
|
|
|
3049
3049
|
const EOL: "\n" | "\r\n";
|
|
3050
3050
|
```
|
|
3051
3051
|
|
|
3052
|
-
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/
|
|
3052
|
+
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/eol.ts#L14)
|
|
3053
3053
|
|
|
3054
3054
|
End-of-line character evaluated for the current platform.
|
|
3055
3055
|
|
|
@@ -3061,7 +3061,7 @@ End-of-line character evaluated for the current platform.
|
|
|
3061
3061
|
const F_OK: 0 = 0;
|
|
3062
3062
|
```
|
|
3063
3063
|
|
|
3064
|
-
Defined in: [packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/
|
|
3064
|
+
Defined in: [packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/constants.ts#L2)
|
|
3065
3065
|
|
|
3066
3066
|
Is the path visible to the calling process?
|
|
3067
3067
|
|
|
@@ -3073,7 +3073,7 @@ Is the path visible to the calling process?
|
|
|
3073
3073
|
const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
3074
3074
|
```
|
|
3075
3075
|
|
|
3076
|
-
Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/
|
|
3076
|
+
Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/constants.ts#L13)
|
|
3077
3077
|
|
|
3078
3078
|
***
|
|
3079
3079
|
|
|
@@ -3083,7 +3083,7 @@ Defined in: [packages/fs/src/constants.ts:13](https://github.com/visulima/visuli
|
|
|
3083
3083
|
const LF: "\n";
|
|
3084
3084
|
```
|
|
3085
3085
|
|
|
3086
|
-
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/
|
|
3086
|
+
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/eol.ts#L6)
|
|
3087
3087
|
|
|
3088
3088
|
End-of-line character for POSIX platforms such as macOS and Linux.
|
|
3089
3089
|
|
|
@@ -3095,7 +3095,7 @@ End-of-line character for POSIX platforms such as macOS and Linux.
|
|
|
3095
3095
|
const R_OK: 4 = 4;
|
|
3096
3096
|
```
|
|
3097
3097
|
|
|
3098
|
-
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/
|
|
3098
|
+
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/constants.ts#L5)
|
|
3099
3099
|
|
|
3100
3100
|
Is the path readable to the calling process?
|
|
3101
3101
|
|
|
@@ -3107,7 +3107,7 @@ Is the path readable to the calling process?
|
|
|
3107
3107
|
const W_OK: 2 = 2;
|
|
3108
3108
|
```
|
|
3109
3109
|
|
|
3110
|
-
Defined in: [packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/
|
|
3110
|
+
Defined in: [packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/constants.ts#L8)
|
|
3111
3111
|
|
|
3112
3112
|
Is the path writable to the calling process?
|
|
3113
3113
|
|
|
@@ -3119,7 +3119,7 @@ Is the path writable to the calling process?
|
|
|
3119
3119
|
const X_OK: 1 = 1;
|
|
3120
3120
|
```
|
|
3121
3121
|
|
|
3122
|
-
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/
|
|
3122
|
+
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/constants.ts#L11)
|
|
3123
3123
|
|
|
3124
3124
|
Is the path executable to the calling process?
|
|
3125
3125
|
|
|
@@ -3127,7 +3127,7 @@ Is the path executable to the calling process?
|
|
|
3127
3127
|
|
|
3128
3128
|
### WalkEntry
|
|
3129
3129
|
|
|
3130
|
-
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/
|
|
3130
|
+
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L56)
|
|
3131
3131
|
|
|
3132
3132
|
#### Extends
|
|
3133
3133
|
|
|
@@ -3237,13 +3237,13 @@ Pick.name
|
|
|
3237
3237
|
path: string;
|
|
3238
3238
|
```
|
|
3239
3239
|
|
|
3240
|
-
Defined in: [packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/
|
|
3240
|
+
Defined in: [packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L57)
|
|
3241
3241
|
|
|
3242
3242
|
***
|
|
3243
3243
|
|
|
3244
3244
|
### WalkOptions
|
|
3245
3245
|
|
|
3246
|
-
Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/blob/
|
|
3246
|
+
Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L9)
|
|
3247
3247
|
|
|
3248
3248
|
#### Properties
|
|
3249
3249
|
|
|
@@ -3253,7 +3253,7 @@ Defined in: [packages/fs/src/types.ts:9](https://github.com/visulima/visulima/bl
|
|
|
3253
3253
|
optional extensions: string[];
|
|
3254
3254
|
```
|
|
3255
3255
|
|
|
3256
|
-
Defined in: [packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/
|
|
3256
|
+
Defined in: [packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L15)
|
|
3257
3257
|
|
|
3258
3258
|
List of file extensions used to filter entries.
|
|
3259
3259
|
If specified, entries without the file extension specified by this option are excluded.
|
|
@@ -3270,7 +3270,7 @@ If specified, entries without the file extension specified by this option are ex
|
|
|
3270
3270
|
optional followSymlinks: boolean;
|
|
3271
3271
|
```
|
|
3272
3272
|
|
|
3273
|
-
Defined in: [packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/
|
|
3273
|
+
Defined in: [packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L20)
|
|
3274
3274
|
|
|
3275
3275
|
Indicates whether symlinks should be resolved or not.
|
|
3276
3276
|
|
|
@@ -3286,7 +3286,7 @@ Indicates whether symlinks should be resolved or not.
|
|
|
3286
3286
|
optional includeDirs: boolean;
|
|
3287
3287
|
```
|
|
3288
3288
|
|
|
3289
|
-
Defined in: [packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/
|
|
3289
|
+
Defined in: [packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L25)
|
|
3290
3290
|
|
|
3291
3291
|
Indicates whether directory entries should be included or not.
|
|
3292
3292
|
|
|
@@ -3302,7 +3302,7 @@ Indicates whether directory entries should be included or not.
|
|
|
3302
3302
|
optional includeFiles: boolean;
|
|
3303
3303
|
```
|
|
3304
3304
|
|
|
3305
|
-
Defined in: [packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/
|
|
3305
|
+
Defined in: [packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L30)
|
|
3306
3306
|
|
|
3307
3307
|
Indicates whether file entries should be included or not.
|
|
3308
3308
|
|
|
@@ -3318,7 +3318,7 @@ Indicates whether file entries should be included or not.
|
|
|
3318
3318
|
optional includeSymlinks: boolean;
|
|
3319
3319
|
```
|
|
3320
3320
|
|
|
3321
|
-
Defined in: [packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/
|
|
3321
|
+
Defined in: [packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L36)
|
|
3322
3322
|
|
|
3323
3323
|
Indicates whether symlink entries should be included or not.
|
|
3324
3324
|
This option is meaningful only if `followSymlinks` is set to `false`.
|
|
@@ -3335,7 +3335,7 @@ This option is meaningful only if `followSymlinks` is set to `false`.
|
|
|
3335
3335
|
optional match: (string | RegExp)[];
|
|
3336
3336
|
```
|
|
3337
3337
|
|
|
3338
|
-
Defined in: [packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/
|
|
3338
|
+
Defined in: [packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L42)
|
|
3339
3339
|
|
|
3340
3340
|
List of regular expression or glob patterns used to filter entries.
|
|
3341
3341
|
If specified, entries that do not match the patterns specified by this option are excluded.
|
|
@@ -3352,7 +3352,7 @@ If specified, entries that do not match the patterns specified by this option ar
|
|
|
3352
3352
|
optional maxDepth: number;
|
|
3353
3353
|
```
|
|
3354
3354
|
|
|
3355
|
-
Defined in: [packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/
|
|
3355
|
+
Defined in: [packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L47)
|
|
3356
3356
|
|
|
3357
3357
|
The maximum depth of the file tree to be walked recursively.
|
|
3358
3358
|
|
|
@@ -3368,7 +3368,7 @@ The maximum depth of the file tree to be walked recursively.
|
|
|
3368
3368
|
optional skip: (string | RegExp)[];
|
|
3369
3369
|
```
|
|
3370
3370
|
|
|
3371
|
-
Defined in: [packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/
|
|
3371
|
+
Defined in: [packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L53)
|
|
3372
3372
|
|
|
3373
3373
|
List of regular expression or glob patterns used to filter entries.
|
|
3374
3374
|
If specified, entries matching the patterns specified by this option are excluded.
|
|
@@ -3387,7 +3387,7 @@ If specified, entries matching the patterns specified by this option are exclude
|
|
|
3387
3387
|
type CodeFrameLocation = object;
|
|
3388
3388
|
```
|
|
3389
3389
|
|
|
3390
|
-
Defined in: [packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/
|
|
3390
|
+
Defined in: [packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L91)
|
|
3391
3391
|
|
|
3392
3392
|
#### Type declaration
|
|
3393
3393
|
|
|
@@ -3411,7 +3411,7 @@ line: number;
|
|
|
3411
3411
|
type EmptyDirOptions = object;
|
|
3412
3412
|
```
|
|
3413
3413
|
|
|
3414
|
-
Defined in: [packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/
|
|
3414
|
+
Defined in: [packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L188)
|
|
3415
3415
|
|
|
3416
3416
|
#### Type declaration
|
|
3417
3417
|
|
|
@@ -3459,7 +3459,7 @@ type FindUpName =
|
|
|
3459
3459
|
| (directory) => FindUpNameFnResult;
|
|
3460
3460
|
```
|
|
3461
3461
|
|
|
3462
|
-
Defined in: [packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/
|
|
3462
|
+
Defined in: [packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L180)
|
|
3463
3463
|
|
|
3464
3464
|
***
|
|
3465
3465
|
|
|
@@ -3473,7 +3473,7 @@ type FindUpNameFnResult =
|
|
|
3473
3473
|
| undefined;
|
|
3474
3474
|
```
|
|
3475
3475
|
|
|
3476
|
-
Defined in: [packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/
|
|
3476
|
+
Defined in: [packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L178)
|
|
3477
3477
|
|
|
3478
3478
|
***
|
|
3479
3479
|
|
|
@@ -3486,7 +3486,7 @@ type FindUpNameSync =
|
|
|
3486
3486
|
| (directory) => FindUpNameSyncFnResult;
|
|
3487
3487
|
```
|
|
3488
3488
|
|
|
3489
|
-
Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/
|
|
3489
|
+
Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L185)
|
|
3490
3490
|
|
|
3491
3491
|
***
|
|
3492
3492
|
|
|
@@ -3496,7 +3496,7 @@ Defined in: [packages/fs/src/types.ts:185](https://github.com/visulima/visulima/
|
|
|
3496
3496
|
type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
|
|
3497
3497
|
```
|
|
3498
3498
|
|
|
3499
|
-
Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/
|
|
3499
|
+
Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L183)
|
|
3500
3500
|
|
|
3501
3501
|
***
|
|
3502
3502
|
|
|
@@ -3506,7 +3506,7 @@ Defined in: [packages/fs/src/types.ts:183](https://github.com/visulima/visulima/
|
|
|
3506
3506
|
type FindUpOptions = object;
|
|
3507
3507
|
```
|
|
3508
3508
|
|
|
3509
|
-
Defined in: [packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/
|
|
3509
|
+
Defined in: [packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L170)
|
|
3510
3510
|
|
|
3511
3511
|
#### Type declaration
|
|
3512
3512
|
|
|
@@ -3542,7 +3542,7 @@ optional type: "directory" | "file";
|
|
|
3542
3542
|
type JsonReplacer = (number | string)[] | (this, key, value) => unknown | null;
|
|
3543
3543
|
```
|
|
3544
3544
|
|
|
3545
|
-
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/
|
|
3545
|
+
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L143)
|
|
3546
3546
|
|
|
3547
3547
|
***
|
|
3548
3548
|
|
|
@@ -3552,7 +3552,7 @@ Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/
|
|
|
3552
3552
|
type JsonReviver = Parameters<typeof JSON["parse"]>["1"];
|
|
3553
3553
|
```
|
|
3554
3554
|
|
|
3555
|
-
Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/
|
|
3555
|
+
Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L89)
|
|
3556
3556
|
|
|
3557
3557
|
***
|
|
3558
3558
|
|
|
@@ -3562,7 +3562,7 @@ Defined in: [packages/fs/src/types.ts:89](https://github.com/visulima/visulima/b
|
|
|
3562
3562
|
type MoveOptions = object;
|
|
3563
3563
|
```
|
|
3564
3564
|
|
|
3565
|
-
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/
|
|
3565
|
+
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/move/types.ts#L3)
|
|
3566
3566
|
|
|
3567
3567
|
#### Type declaration
|
|
3568
3568
|
|
|
@@ -3630,7 +3630,7 @@ type ReadFileEncoding =
|
|
|
3630
3630
|
| "utf16le";
|
|
3631
3631
|
```
|
|
3632
3632
|
|
|
3633
|
-
Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/
|
|
3633
|
+
Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L61)
|
|
3634
3634
|
|
|
3635
3635
|
***
|
|
3636
3636
|
|
|
@@ -3640,7 +3640,7 @@ Defined in: [packages/fs/src/types.ts:61](https://github.com/visulima/visulima/b
|
|
|
3640
3640
|
type ReadFileOptions<C> = object;
|
|
3641
3641
|
```
|
|
3642
3642
|
|
|
3643
|
-
Defined in: [packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/
|
|
3643
|
+
Defined in: [packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L63)
|
|
3644
3644
|
|
|
3645
3645
|
#### Type Parameters
|
|
3646
3646
|
|
|
@@ -3692,7 +3692,7 @@ The flag used to open the file. Default: `r`
|
|
|
3692
3692
|
type ReadJsonOptions = CodeFrameOptions & object;
|
|
3693
3693
|
```
|
|
3694
3694
|
|
|
3695
|
-
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/
|
|
3695
|
+
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L104)
|
|
3696
3696
|
|
|
3697
3697
|
#### Type declaration
|
|
3698
3698
|
|
|
@@ -3720,7 +3720,7 @@ optional beforeParse: (source) => string;
|
|
|
3720
3720
|
type WriteFileOptions = object;
|
|
3721
3721
|
```
|
|
3722
3722
|
|
|
3723
|
-
Defined in: [packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/
|
|
3723
|
+
Defined in: [packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L108)
|
|
3724
3724
|
|
|
3725
3725
|
#### Type declaration
|
|
3726
3726
|
|
|
@@ -3792,7 +3792,7 @@ Recursively create parent directories if needed. Default: `true`
|
|
|
3792
3792
|
type WriteJsonOptions = WriteFileOptions & object;
|
|
3793
3793
|
```
|
|
3794
3794
|
|
|
3795
|
-
Defined in: [packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/
|
|
3795
|
+
Defined in: [packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L146)
|
|
3796
3796
|
|
|
3797
3797
|
#### Type declaration
|
|
3798
3798
|
|
|
@@ -3857,7 +3857,7 @@ Override the default `JSON.stringify` method.
|
|
|
3857
3857
|
function brotliSize(input, options?): Promise<number>
|
|
3858
3858
|
```
|
|
3859
3859
|
|
|
3860
|
-
Defined in: [packages/fs/src/size.ts:109](https://github.com/visulima/visulima/blob/
|
|
3860
|
+
Defined in: [packages/fs/src/size.ts:109](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/size.ts#L109)
|
|
3861
3861
|
|
|
3862
3862
|
Asynchronously calculates the Brotli compressed size of the input.
|
|
3863
3863
|
Uses memory-efficient streaming for large inputs.
|
|
@@ -3866,7 +3866,7 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3866
3866
|
|
|
3867
3867
|
##### input
|
|
3868
3868
|
|
|
3869
|
-
`string` | `URL` | `Buffer
|
|
3869
|
+
`string` | `URL` | `Buffer`\<`ArrayBufferLike`\> | `Readable`
|
|
3870
3870
|
|
|
3871
3871
|
##### options?
|
|
3872
3872
|
|
|
@@ -3884,7 +3884,7 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3884
3884
|
function brotliSizeSync(input, options?): number
|
|
3885
3885
|
```
|
|
3886
3886
|
|
|
3887
|
-
Defined in: [packages/fs/src/size.ts:151](https://github.com/visulima/visulima/blob/
|
|
3887
|
+
Defined in: [packages/fs/src/size.ts:151](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/size.ts#L151)
|
|
3888
3888
|
|
|
3889
3889
|
Synchronously calculates the Brotli compressed size of the input.
|
|
3890
3890
|
Note: For large files, consider using the async brotliSize function instead.
|
|
@@ -3893,7 +3893,7 @@ Note: For large files, consider using the async brotliSize function instead.
|
|
|
3893
3893
|
|
|
3894
3894
|
##### input
|
|
3895
3895
|
|
|
3896
|
-
`string` | `URL` | `Buffer
|
|
3896
|
+
`string` | `URL` | `Buffer`\<`ArrayBufferLike`\>
|
|
3897
3897
|
|
|
3898
3898
|
##### options?
|
|
3899
3899
|
|
|
@@ -3911,7 +3911,7 @@ Note: For large files, consider using the async brotliSize function instead.
|
|
|
3911
3911
|
function gzipSize(input, options?): Promise<number>
|
|
3912
3912
|
```
|
|
3913
3913
|
|
|
3914
|
-
Defined in: [packages/fs/src/size.ts:98](https://github.com/visulima/visulima/blob/
|
|
3914
|
+
Defined in: [packages/fs/src/size.ts:98](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/size.ts#L98)
|
|
3915
3915
|
|
|
3916
3916
|
Asynchronously calculates the gzipped size of the input.
|
|
3917
3917
|
Uses memory-efficient streaming for large inputs.
|
|
@@ -3920,7 +3920,7 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3920
3920
|
|
|
3921
3921
|
##### input
|
|
3922
3922
|
|
|
3923
|
-
`string` | `URL` | `Buffer
|
|
3923
|
+
`string` | `URL` | `Buffer`\<`ArrayBufferLike`\> | `Readable`
|
|
3924
3924
|
|
|
3925
3925
|
##### options?
|
|
3926
3926
|
|
|
@@ -3938,7 +3938,7 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3938
3938
|
function gzipSizeSync(input, options?): number
|
|
3939
3939
|
```
|
|
3940
3940
|
|
|
3941
|
-
Defined in: [packages/fs/src/size.ts:131](https://github.com/visulima/visulima/blob/
|
|
3941
|
+
Defined in: [packages/fs/src/size.ts:131](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/size.ts#L131)
|
|
3942
3942
|
|
|
3943
3943
|
Synchronously calculates the gzipped size of the input.
|
|
3944
3944
|
Note: For large files, consider using the async gzipSize function instead.
|
|
@@ -3947,7 +3947,7 @@ Note: For large files, consider using the async gzipSize function instead.
|
|
|
3947
3947
|
|
|
3948
3948
|
##### input
|
|
3949
3949
|
|
|
3950
|
-
`string` | `URL` | `Buffer
|
|
3950
|
+
`string` | `URL` | `Buffer`\<`ArrayBufferLike`\>
|
|
3951
3951
|
|
|
3952
3952
|
##### options?
|
|
3953
3953
|
|
|
@@ -3965,7 +3965,7 @@ Note: For large files, consider using the async gzipSize function instead.
|
|
|
3965
3965
|
function rawSize(input): Promise<number>
|
|
3966
3966
|
```
|
|
3967
3967
|
|
|
3968
|
-
Defined in: [packages/fs/src/size.ts:120](https://github.com/visulima/visulima/blob/
|
|
3968
|
+
Defined in: [packages/fs/src/size.ts:120](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/size.ts#L120)
|
|
3969
3969
|
|
|
3970
3970
|
Asynchronously gets the raw size of the input without compression.
|
|
3971
3971
|
Uses memory-efficient streaming for large inputs.
|
|
@@ -3974,7 +3974,7 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3974
3974
|
|
|
3975
3975
|
##### input
|
|
3976
3976
|
|
|
3977
|
-
`string` | `URL` | `Buffer
|
|
3977
|
+
`string` | `URL` | `Buffer`\<`ArrayBufferLike`\> | `Readable`
|
|
3978
3978
|
|
|
3979
3979
|
#### Returns
|
|
3980
3980
|
|
|
@@ -3988,7 +3988,7 @@ Uses memory-efficient streaming for large inputs.
|
|
|
3988
3988
|
function rawSizeSync(input): number
|
|
3989
3989
|
```
|
|
3990
3990
|
|
|
3991
|
-
Defined in: [packages/fs/src/size.ts:171](https://github.com/visulima/visulima/blob/
|
|
3991
|
+
Defined in: [packages/fs/src/size.ts:171](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/size.ts#L171)
|
|
3992
3992
|
|
|
3993
3993
|
Synchronously gets the raw size of the input without compression.
|
|
3994
3994
|
Note: For large files, consider using the async rawSize function instead.
|
|
@@ -3997,7 +3997,7 @@ Note: For large files, consider using the async rawSize function instead.
|
|
|
3997
3997
|
|
|
3998
3998
|
##### input
|
|
3999
3999
|
|
|
4000
|
-
`string` | `URL` | `Buffer
|
|
4000
|
+
`string` | `URL` | `Buffer`\<`ArrayBufferLike`\>
|
|
4001
4001
|
|
|
4002
4002
|
#### Returns
|
|
4003
4003
|
|
|
@@ -4008,7 +4008,7 @@ Note: For large files, consider using the async rawSize function instead.
|
|
|
4008
4008
|
|
|
4009
4009
|
### JSONError
|
|
4010
4010
|
|
|
4011
|
-
Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/visulima/blob/
|
|
4011
|
+
Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L1)
|
|
4012
4012
|
|
|
4013
4013
|
#### Extends
|
|
4014
4014
|
|
|
@@ -4022,7 +4022,7 @@ Defined in: [packages/fs/src/error/json-error.ts:1](https://github.com/visulima/
|
|
|
4022
4022
|
new JSONError(message): JSONError
|
|
4023
4023
|
```
|
|
4024
4024
|
|
|
4025
|
-
Defined in: [packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/
|
|
4025
|
+
Defined in: [packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L11)
|
|
4026
4026
|
|
|
4027
4027
|
###### Parameters
|
|
4028
4028
|
|
|
@@ -4050,7 +4050,7 @@ Error.constructor
|
|
|
4050
4050
|
get message(): string
|
|
4051
4051
|
```
|
|
4052
4052
|
|
|
4053
|
-
Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
4053
|
+
Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L21)
|
|
4054
4054
|
|
|
4055
4055
|
###### Returns
|
|
4056
4056
|
|
|
@@ -4062,7 +4062,7 @@ Defined in: [packages/fs/src/error/json-error.ts:21](https://github.com/visulima
|
|
|
4062
4062
|
set message(message): void
|
|
4063
4063
|
```
|
|
4064
4064
|
|
|
4065
|
-
Defined in: [packages/fs/src/error/json-error.ts:25](https://github.com/visulima/visulima/blob/
|
|
4065
|
+
Defined in: [packages/fs/src/error/json-error.ts:25](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L25)
|
|
4066
4066
|
|
|
4067
4067
|
###### Parameters
|
|
4068
4068
|
|
|
@@ -4120,7 +4120,7 @@ Error.captureStackTrace
|
|
|
4120
4120
|
optional cause: unknown;
|
|
4121
4121
|
```
|
|
4122
4122
|
|
|
4123
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
4123
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es2022.error.d.ts:26
|
|
4124
4124
|
|
|
4125
4125
|
###### Inherited from
|
|
4126
4126
|
|
|
@@ -4134,7 +4134,7 @@ Error.cause
|
|
|
4134
4134
|
codeFrame: string;
|
|
4135
4135
|
```
|
|
4136
4136
|
|
|
4137
|
-
Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
4137
|
+
Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L4)
|
|
4138
4138
|
|
|
4139
4139
|
##### fileName
|
|
4140
4140
|
|
|
@@ -4142,7 +4142,7 @@ Defined in: [packages/fs/src/error/json-error.ts:4](https://github.com/visulima/
|
|
|
4142
4142
|
fileName: string;
|
|
4143
4143
|
```
|
|
4144
4144
|
|
|
4145
|
-
Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/
|
|
4145
|
+
Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L2)
|
|
4146
4146
|
|
|
4147
4147
|
##### name
|
|
4148
4148
|
|
|
@@ -4150,7 +4150,7 @@ Defined in: [packages/fs/src/error/json-error.ts:2](https://github.com/visulima/
|
|
|
4150
4150
|
readonly name: "JSONError" = "JSONError";
|
|
4151
4151
|
```
|
|
4152
4152
|
|
|
4153
|
-
Defined in: [packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/
|
|
4153
|
+
Defined in: [packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/error/json-error.ts#L7)
|
|
4154
4154
|
|
|
4155
4155
|
###### Overrides
|
|
4156
4156
|
|
|
@@ -4164,7 +4164,7 @@ Error.name
|
|
|
4164
4164
|
optional stack: string;
|
|
4165
4165
|
```
|
|
4166
4166
|
|
|
4167
|
-
Defined in: node\_modules/.pnpm/typescript@5.
|
|
4167
|
+
Defined in: node\_modules/.pnpm/typescript@5.8.2/node\_modules/typescript/lib/lib.es5.d.ts:1078
|
|
4168
4168
|
|
|
4169
4169
|
###### Inherited from
|
|
4170
4170
|
|
|
@@ -4228,7 +4228,7 @@ Error.stackTraceLimit
|
|
|
4228
4228
|
function assertValidFileContents(contents): void
|
|
4229
4229
|
```
|
|
4230
4230
|
|
|
4231
|
-
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/
|
|
4231
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/utils/assert-valid-file-contents.ts#L2)
|
|
4232
4232
|
|
|
4233
4233
|
#### Parameters
|
|
4234
4234
|
|
|
@@ -4248,7 +4248,7 @@ Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:2](https://gith
|
|
|
4248
4248
|
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
4249
4249
|
```
|
|
4250
4250
|
|
|
4251
|
-
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/
|
|
4251
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L2)
|
|
4252
4252
|
|
|
4253
4253
|
#### Parameters
|
|
4254
4254
|
|
|
@@ -4273,7 +4273,7 @@ function parseJson<T>(
|
|
|
4273
4273
|
options?): T
|
|
4274
4274
|
```
|
|
4275
4275
|
|
|
4276
|
-
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/
|
|
4276
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/utils/parse-json.ts#L60)
|
|
4277
4277
|
|
|
4278
4278
|
##### Type Parameters
|
|
4279
4279
|
|
|
@@ -4307,7 +4307,7 @@ function parseJson<T>(
|
|
|
4307
4307
|
options?): T
|
|
4308
4308
|
```
|
|
4309
4309
|
|
|
4310
|
-
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/
|
|
4310
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/utils/parse-json.ts#L61)
|
|
4311
4311
|
|
|
4312
4312
|
##### Type Parameters
|
|
4313
4313
|
|
|
@@ -4343,7 +4343,7 @@ Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima
|
|
|
4343
4343
|
function stripJsonComments(jsonString, __namedParameters): string
|
|
4344
4344
|
```
|
|
4345
4345
|
|
|
4346
|
-
Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/
|
|
4346
|
+
Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/utils/strip-json-comments.ts#L5)
|
|
4347
4347
|
|
|
4348
4348
|
#### Parameters
|
|
4349
4349
|
|
|
@@ -4353,7 +4353,7 @@ Defined in: [packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/
|
|
|
4353
4353
|
|
|
4354
4354
|
##### \_\_namedParameters
|
|
4355
4355
|
|
|
4356
|
-
###### whitespace
|
|
4356
|
+
###### whitespace?
|
|
4357
4357
|
|
|
4358
4358
|
`boolean` = `true`
|
|
4359
4359
|
|
|
@@ -4392,7 +4392,7 @@ Defined in: node\_modules/.pnpm/@visulima+path@1.3.4/node\_modules/@visulima/pat
|
|
|
4392
4392
|
function readYaml<R>(path, options?): Promise<R>
|
|
4393
4393
|
```
|
|
4394
4394
|
|
|
4395
|
-
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/
|
|
4395
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-yaml.ts#L6)
|
|
4396
4396
|
|
|
4397
4397
|
##### Type Parameters
|
|
4398
4398
|
|
|
@@ -4421,7 +4421,7 @@ function readYaml<R>(
|
|
|
4421
4421
|
options?): Promise<R>
|
|
4422
4422
|
```
|
|
4423
4423
|
|
|
4424
|
-
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/
|
|
4424
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-yaml.ts#L7)
|
|
4425
4425
|
|
|
4426
4426
|
##### Type Parameters
|
|
4427
4427
|
|
|
@@ -4455,7 +4455,7 @@ Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/vi
|
|
|
4455
4455
|
function readYamlSync<R>(path, options?): R
|
|
4456
4456
|
```
|
|
4457
4457
|
|
|
4458
|
-
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/
|
|
4458
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
4459
4459
|
|
|
4460
4460
|
##### Type Parameters
|
|
4461
4461
|
|
|
@@ -4484,7 +4484,7 @@ function readYamlSync<R>(
|
|
|
4484
4484
|
options?): R
|
|
4485
4485
|
```
|
|
4486
4486
|
|
|
4487
|
-
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/
|
|
4487
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
4488
4488
|
|
|
4489
4489
|
##### Type Parameters
|
|
4490
4490
|
|
|
@@ -4521,7 +4521,7 @@ function writeYaml(
|
|
|
4521
4521
|
options?): Promise<void>
|
|
4522
4522
|
```
|
|
4523
4523
|
|
|
4524
|
-
Defined in: [packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/
|
|
4524
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-yaml.ts#L10)
|
|
4525
4525
|
|
|
4526
4526
|
##### Parameters
|
|
4527
4527
|
|
|
@@ -4551,7 +4551,7 @@ function writeYaml(
|
|
|
4551
4551
|
options?): Promise<void>
|
|
4552
4552
|
```
|
|
4553
4553
|
|
|
4554
|
-
Defined in: [packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/
|
|
4554
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-yaml.ts#L16)
|
|
4555
4555
|
|
|
4556
4556
|
##### Parameters
|
|
4557
4557
|
|
|
@@ -4588,7 +4588,7 @@ function writeYamlSync(
|
|
|
4588
4588
|
options?): void
|
|
4589
4589
|
```
|
|
4590
4590
|
|
|
4591
|
-
Defined in: [packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
4591
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-yaml-sync.ts#L10)
|
|
4592
4592
|
|
|
4593
4593
|
##### Parameters
|
|
4594
4594
|
|
|
@@ -4618,7 +4618,7 @@ function writeYamlSync(
|
|
|
4618
4618
|
options?): void
|
|
4619
4619
|
```
|
|
4620
4620
|
|
|
4621
|
-
Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
4621
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/write/write-yaml-sync.ts#L16)
|
|
4622
4622
|
|
|
4623
4623
|
##### Parameters
|
|
4624
4624
|
|
|
@@ -4650,7 +4650,7 @@ Defined in: [packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/vis
|
|
|
4650
4650
|
type YamlReplacer = JsonReplacer;
|
|
4651
4651
|
```
|
|
4652
4652
|
|
|
4653
|
-
Defined in: [packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/
|
|
4653
|
+
Defined in: [packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/8efc158e8358bd5becfd263879837701b26d16d4/packages/fs/src/types.ts#L144)
|
|
4654
4654
|
|
|
4655
4655
|
<!-- /TYPEDOC -->
|
|
4656
4656
|
|
|
@@ -4684,6 +4684,7 @@ If you would like to help take a look at the [list of issues](https://github.com
|
|
|
4684
4684
|
The visulima fs is open-sourced software licensed under the [MIT][license-url]
|
|
4685
4685
|
|
|
4686
4686
|
[typescript-image]: https://img.shields.io/badge/Typescript-294E80.svg?style=for-the-badge&logo=typescript
|
|
4687
|
+
|
|
4687
4688
|
[typescript-url]: https://www.typescriptlang.org/ "TypeScript" "typescript"
|
|
4688
4689
|
[license-image]: https://img.shields.io/npm/l/@visulima/fs?color=blueviolet&style=for-the-badge
|
|
4689
4690
|
[license-url]: LICENSE.md "license"
|