@visulima/fs 2.3.1 → 2.3.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 +18 -0
- package/README.md +106 -106
- package/package.json +10 -18
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,21 @@
|
|
|
1
|
+
## @visulima/fs [2.3.3](https://github.com/visulima/visulima/compare/@visulima/fs@2.3.2...@visulima/fs@2.3.3) (2024-12-31)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Dependencies
|
|
5
|
+
|
|
6
|
+
* **@visulima/path:** upgraded to 1.2.0
|
|
7
|
+
* **@visulima/error:** upgraded to 4.4.9
|
|
8
|
+
|
|
9
|
+
## @visulima/fs [2.3.2](https://github.com/visulima/visulima/compare/@visulima/fs@2.3.1...@visulima/fs@2.3.2) (2024-12-27)
|
|
10
|
+
|
|
11
|
+
### Bug Fixes
|
|
12
|
+
|
|
13
|
+
* **fs:** added missing yaml to dependencies ([210b995](https://github.com/visulima/visulima/commit/210b99503da7a30ceb3aa01019ae7d3f8bed6807))
|
|
14
|
+
|
|
15
|
+
### Miscellaneous Chores
|
|
16
|
+
|
|
17
|
+
* updated dev dependencies ([9de2eab](https://github.com/visulima/visulima/commit/9de2eab91e95c8b9289d12f863a5167218770650))
|
|
18
|
+
|
|
1
19
|
## @visulima/fs [2.3.1](https://github.com/visulima/visulima/compare/@visulima/fs@2.3.0...@visulima/fs@2.3.1) (2024-12-12)
|
|
2
20
|
|
|
3
21
|
### Bug Fixes
|
package/README.md
CHANGED
|
@@ -475,7 +475,7 @@ The error message.
|
|
|
475
475
|
|
|
476
476
|
###### Defined in
|
|
477
477
|
|
|
478
|
-
[packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
478
|
+
[packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/already-exists-error.ts#L9)
|
|
479
479
|
|
|
480
480
|
#### Accessors
|
|
481
481
|
|
|
@@ -499,7 +499,7 @@ set code(_name): void
|
|
|
499
499
|
|
|
500
500
|
###### Defined in
|
|
501
501
|
|
|
502
|
-
[packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
502
|
+
[packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/already-exists-error.ts#L14)
|
|
503
503
|
|
|
504
504
|
##### name
|
|
505
505
|
|
|
@@ -525,7 +525,7 @@ set name(_name): void
|
|
|
525
525
|
|
|
526
526
|
###### Defined in
|
|
527
527
|
|
|
528
|
-
[packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
528
|
+
[packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/already-exists-error.ts#L24)
|
|
529
529
|
|
|
530
530
|
#### Methods
|
|
531
531
|
|
|
@@ -679,7 +679,7 @@ The error message.
|
|
|
679
679
|
|
|
680
680
|
###### Defined in
|
|
681
681
|
|
|
682
|
-
[packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
682
|
+
[packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/directory-error.ts#L9)
|
|
683
683
|
|
|
684
684
|
#### Accessors
|
|
685
685
|
|
|
@@ -703,7 +703,7 @@ set code(_name): void
|
|
|
703
703
|
|
|
704
704
|
###### Defined in
|
|
705
705
|
|
|
706
|
-
[packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
706
|
+
[packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/directory-error.ts#L14)
|
|
707
707
|
|
|
708
708
|
##### name
|
|
709
709
|
|
|
@@ -729,7 +729,7 @@ set name(_name): void
|
|
|
729
729
|
|
|
730
730
|
###### Defined in
|
|
731
731
|
|
|
732
|
-
[packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
732
|
+
[packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/directory-error.ts#L24)
|
|
733
733
|
|
|
734
734
|
#### Methods
|
|
735
735
|
|
|
@@ -883,7 +883,7 @@ The error message.
|
|
|
883
883
|
|
|
884
884
|
###### Defined in
|
|
885
885
|
|
|
886
|
-
[packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
886
|
+
[packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/not-empty-error.ts#L9)
|
|
887
887
|
|
|
888
888
|
#### Accessors
|
|
889
889
|
|
|
@@ -907,7 +907,7 @@ set code(_name): void
|
|
|
907
907
|
|
|
908
908
|
###### Defined in
|
|
909
909
|
|
|
910
|
-
[packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
910
|
+
[packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/not-empty-error.ts#L14)
|
|
911
911
|
|
|
912
912
|
##### name
|
|
913
913
|
|
|
@@ -933,7 +933,7 @@ set name(_name): void
|
|
|
933
933
|
|
|
934
934
|
###### Defined in
|
|
935
935
|
|
|
936
|
-
[packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
936
|
+
[packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/not-empty-error.ts#L24)
|
|
937
937
|
|
|
938
938
|
#### Methods
|
|
939
939
|
|
|
@@ -1087,7 +1087,7 @@ The error message.
|
|
|
1087
1087
|
|
|
1088
1088
|
###### Defined in
|
|
1089
1089
|
|
|
1090
|
-
[packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1090
|
+
[packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/not-found-error.ts#L9)
|
|
1091
1091
|
|
|
1092
1092
|
#### Accessors
|
|
1093
1093
|
|
|
@@ -1111,7 +1111,7 @@ set code(_name): void
|
|
|
1111
1111
|
|
|
1112
1112
|
###### Defined in
|
|
1113
1113
|
|
|
1114
|
-
[packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
1114
|
+
[packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/not-found-error.ts#L14)
|
|
1115
1115
|
|
|
1116
1116
|
##### name
|
|
1117
1117
|
|
|
@@ -1137,7 +1137,7 @@ set name(_name): void
|
|
|
1137
1137
|
|
|
1138
1138
|
###### Defined in
|
|
1139
1139
|
|
|
1140
|
-
[packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1140
|
+
[packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/not-found-error.ts#L24)
|
|
1141
1141
|
|
|
1142
1142
|
#### Methods
|
|
1143
1143
|
|
|
@@ -1291,7 +1291,7 @@ The error message.
|
|
|
1291
1291
|
|
|
1292
1292
|
###### Defined in
|
|
1293
1293
|
|
|
1294
|
-
[packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1294
|
+
[packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/permission-error.ts#L9)
|
|
1295
1295
|
|
|
1296
1296
|
#### Accessors
|
|
1297
1297
|
|
|
@@ -1315,7 +1315,7 @@ set code(_name): void
|
|
|
1315
1315
|
|
|
1316
1316
|
###### Defined in
|
|
1317
1317
|
|
|
1318
|
-
[packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
1318
|
+
[packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/permission-error.ts#L14)
|
|
1319
1319
|
|
|
1320
1320
|
##### name
|
|
1321
1321
|
|
|
@@ -1341,7 +1341,7 @@ set name(_name): void
|
|
|
1341
1341
|
|
|
1342
1342
|
###### Defined in
|
|
1343
1343
|
|
|
1344
|
-
[packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1344
|
+
[packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/permission-error.ts#L24)
|
|
1345
1345
|
|
|
1346
1346
|
#### Methods
|
|
1347
1347
|
|
|
@@ -1495,7 +1495,7 @@ Constructs a new instance.
|
|
|
1495
1495
|
|
|
1496
1496
|
###### Defined in
|
|
1497
1497
|
|
|
1498
|
-
[packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/
|
|
1498
|
+
[packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/walk-error.ts#L12)
|
|
1499
1499
|
|
|
1500
1500
|
#### Accessors
|
|
1501
1501
|
|
|
@@ -1523,7 +1523,7 @@ set name(_name): void
|
|
|
1523
1523
|
|
|
1524
1524
|
###### Defined in
|
|
1525
1525
|
|
|
1526
|
-
[packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
1526
|
+
[packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/walk-error.ts#L21)
|
|
1527
1527
|
|
|
1528
1528
|
#### Methods
|
|
1529
1529
|
|
|
@@ -1593,7 +1593,7 @@ File path of the root that's being walked.
|
|
|
1593
1593
|
|
|
1594
1594
|
###### Defined in
|
|
1595
1595
|
|
|
1596
|
-
[packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1596
|
+
[packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/walk-error.ts#L9)
|
|
1597
1597
|
|
|
1598
1598
|
##### stack?
|
|
1599
1599
|
|
|
@@ -1680,7 +1680,7 @@ function collect(directory, options): Promise<string[]>
|
|
|
1680
1680
|
|
|
1681
1681
|
#### Defined in
|
|
1682
1682
|
|
|
1683
|
-
[packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/
|
|
1683
|
+
[packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/find/collect.ts#L4)
|
|
1684
1684
|
|
|
1685
1685
|
***
|
|
1686
1686
|
|
|
@@ -1702,7 +1702,7 @@ function collectSync(directory, options): string[]
|
|
|
1702
1702
|
|
|
1703
1703
|
#### Defined in
|
|
1704
1704
|
|
|
1705
|
-
[packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/
|
|
1705
|
+
[packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/find/collect-sync.ts#L4)
|
|
1706
1706
|
|
|
1707
1707
|
***
|
|
1708
1708
|
|
|
@@ -1725,7 +1725,7 @@ Returns null if no newline.
|
|
|
1725
1725
|
|
|
1726
1726
|
#### Defined in
|
|
1727
1727
|
|
|
1728
|
-
[packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/
|
|
1728
|
+
[packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/eol.ts#L20)
|
|
1729
1729
|
|
|
1730
1730
|
***
|
|
1731
1731
|
|
|
@@ -1752,7 +1752,7 @@ The directory itself is not deleted.
|
|
|
1752
1752
|
|
|
1753
1753
|
#### Defined in
|
|
1754
1754
|
|
|
1755
|
-
[packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/
|
|
1755
|
+
[packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/remove/empty-dir.ts#L19)
|
|
1756
1756
|
|
|
1757
1757
|
***
|
|
1758
1758
|
|
|
@@ -1779,7 +1779,7 @@ The directory itself is not deleted.
|
|
|
1779
1779
|
|
|
1780
1780
|
#### Defined in
|
|
1781
1781
|
|
|
1782
|
-
[packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
1782
|
+
[packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/remove/empty-dir-sync.ts#L18)
|
|
1783
1783
|
|
|
1784
1784
|
***
|
|
1785
1785
|
|
|
@@ -1802,7 +1802,7 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
1802
1802
|
|
|
1803
1803
|
#### Defined in
|
|
1804
1804
|
|
|
1805
|
-
[packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/
|
|
1805
|
+
[packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-dir.ts#L12)
|
|
1806
1806
|
|
|
1807
1807
|
***
|
|
1808
1808
|
|
|
@@ -1825,7 +1825,7 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
1825
1825
|
|
|
1826
1826
|
#### Defined in
|
|
1827
1827
|
|
|
1828
|
-
[packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/
|
|
1828
|
+
[packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-dir-sync.ts#L12)
|
|
1829
1829
|
|
|
1830
1830
|
***
|
|
1831
1831
|
|
|
@@ -1849,7 +1849,7 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
1849
1849
|
|
|
1850
1850
|
#### Defined in
|
|
1851
1851
|
|
|
1852
|
-
[packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/
|
|
1852
|
+
[packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-file.ts#L16)
|
|
1853
1853
|
|
|
1854
1854
|
***
|
|
1855
1855
|
|
|
@@ -1873,7 +1873,7 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
1873
1873
|
|
|
1874
1874
|
#### Defined in
|
|
1875
1875
|
|
|
1876
|
-
[packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
1876
|
+
[packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-file-sync.ts#L16)
|
|
1877
1877
|
|
|
1878
1878
|
***
|
|
1879
1879
|
|
|
@@ -1898,7 +1898,7 @@ If the directory structure does not exist, it is created.
|
|
|
1898
1898
|
|
|
1899
1899
|
#### Defined in
|
|
1900
1900
|
|
|
1901
|
-
[packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/
|
|
1901
|
+
[packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-link.ts#L15)
|
|
1902
1902
|
|
|
1903
1903
|
***
|
|
1904
1904
|
|
|
@@ -1923,7 +1923,7 @@ If the directory structure does not exist, it is created.
|
|
|
1923
1923
|
|
|
1924
1924
|
#### Defined in
|
|
1925
1925
|
|
|
1926
|
-
[packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
1926
|
+
[packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-link-sync.ts#L15)
|
|
1927
1927
|
|
|
1928
1928
|
***
|
|
1929
1929
|
|
|
@@ -1962,7 +1962,7 @@ A void promise that resolves once the link exists.
|
|
|
1962
1962
|
|
|
1963
1963
|
#### Defined in
|
|
1964
1964
|
|
|
1965
|
-
[packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/
|
|
1965
|
+
[packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-symlink.ts#L28)
|
|
1966
1966
|
|
|
1967
1967
|
***
|
|
1968
1968
|
|
|
@@ -2001,7 +2001,7 @@ A void.
|
|
|
2001
2001
|
|
|
2002
2002
|
#### Defined in
|
|
2003
2003
|
|
|
2004
|
-
[packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/
|
|
2004
|
+
[packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/ensure/ensure-symlink-sync.ts#L28)
|
|
2005
2005
|
|
|
2006
2006
|
***
|
|
2007
2007
|
|
|
@@ -2023,7 +2023,7 @@ function findUp(name, options): Promise<string>
|
|
|
2023
2023
|
|
|
2024
2024
|
#### Defined in
|
|
2025
2025
|
|
|
2026
|
-
[packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/
|
|
2026
|
+
[packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/find/find-up.ts#L11)
|
|
2027
2027
|
|
|
2028
2028
|
***
|
|
2029
2029
|
|
|
@@ -2045,7 +2045,7 @@ function findUpSync(name, options): string
|
|
|
2045
2045
|
|
|
2046
2046
|
#### Defined in
|
|
2047
2047
|
|
|
2048
|
-
[packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
2048
|
+
[packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/find/find-up-sync.ts#L11)
|
|
2049
2049
|
|
|
2050
2050
|
***
|
|
2051
2051
|
|
|
@@ -2069,7 +2069,7 @@ Format the file to the targeted EOL.
|
|
|
2069
2069
|
|
|
2070
2070
|
#### Defined in
|
|
2071
2071
|
|
|
2072
|
-
[packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/
|
|
2072
|
+
[packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/eol.ts#L36)
|
|
2073
2073
|
|
|
2074
2074
|
***
|
|
2075
2075
|
|
|
@@ -2093,7 +2093,7 @@ Returns a Promise that resolves to a boolean indicating if the path is accessibl
|
|
|
2093
2093
|
|
|
2094
2094
|
#### Defined in
|
|
2095
2095
|
|
|
2096
|
-
[packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/
|
|
2096
|
+
[packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/is-accessible.ts#L9)
|
|
2097
2097
|
|
|
2098
2098
|
***
|
|
2099
2099
|
|
|
@@ -2117,7 +2117,7 @@ Returns a boolean indicating if the path is accessible or not.
|
|
|
2117
2117
|
|
|
2118
2118
|
#### Defined in
|
|
2119
2119
|
|
|
2120
|
-
[packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/
|
|
2120
|
+
[packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/is-accessible-sync.ts#L9)
|
|
2121
2121
|
|
|
2122
2122
|
***
|
|
2123
2123
|
|
|
@@ -2163,7 +2163,7 @@ console.log('The file has been moved');
|
|
|
2163
2163
|
|
|
2164
2164
|
#### Defined in
|
|
2165
2165
|
|
|
2166
|
-
[packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/
|
|
2166
|
+
[packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/move/index.ts#L35)
|
|
2167
2167
|
|
|
2168
2168
|
***
|
|
2169
2169
|
|
|
@@ -2209,7 +2209,7 @@ console.log('The file has been moved');
|
|
|
2209
2209
|
|
|
2210
2210
|
#### Defined in
|
|
2211
2211
|
|
|
2212
|
-
[packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/
|
|
2212
|
+
[packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/move/index.ts#L61)
|
|
2213
2213
|
|
|
2214
2214
|
***
|
|
2215
2215
|
|
|
@@ -2235,7 +2235,7 @@ function readFile<O>(path, options?): Promise<ContentType<O>>
|
|
|
2235
2235
|
|
|
2236
2236
|
#### Defined in
|
|
2237
2237
|
|
|
2238
|
-
[packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/
|
|
2238
|
+
[packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-file.ts#L20)
|
|
2239
2239
|
|
|
2240
2240
|
***
|
|
2241
2241
|
|
|
@@ -2261,7 +2261,7 @@ function readFileSync<O>(path, options?): ContentType<O>
|
|
|
2261
2261
|
|
|
2262
2262
|
#### Defined in
|
|
2263
2263
|
|
|
2264
|
-
[packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
2264
|
+
[packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-file-sync.ts#L18)
|
|
2265
2265
|
|
|
2266
2266
|
***
|
|
2267
2267
|
|
|
@@ -2289,7 +2289,7 @@ function readJson<T>(path, options?): Promise<T>
|
|
|
2289
2289
|
|
|
2290
2290
|
##### Defined in
|
|
2291
2291
|
|
|
2292
|
-
[packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/
|
|
2292
|
+
[packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-json.ts#L8)
|
|
2293
2293
|
|
|
2294
2294
|
#### readJson(path, reviver, options)
|
|
2295
2295
|
|
|
@@ -2318,7 +2318,7 @@ options?): Promise<T>
|
|
|
2318
2318
|
|
|
2319
2319
|
##### Defined in
|
|
2320
2320
|
|
|
2321
|
-
[packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/
|
|
2321
|
+
[packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-json.ts#L10)
|
|
2322
2322
|
|
|
2323
2323
|
***
|
|
2324
2324
|
|
|
@@ -2346,7 +2346,7 @@ function readJsonSync<T>(path, options?): T
|
|
|
2346
2346
|
|
|
2347
2347
|
##### Defined in
|
|
2348
2348
|
|
|
2349
|
-
[packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/
|
|
2349
|
+
[packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-json-sync.ts#L8)
|
|
2350
2350
|
|
|
2351
2351
|
#### readJsonSync(path, reviver, options)
|
|
2352
2352
|
|
|
@@ -2375,7 +2375,7 @@ function readJsonSync<T>(
|
|
|
2375
2375
|
|
|
2376
2376
|
##### Defined in
|
|
2377
2377
|
|
|
2378
|
-
[packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
2378
|
+
[packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-json-sync.ts#L10)
|
|
2379
2379
|
|
|
2380
2380
|
***
|
|
2381
2381
|
|
|
@@ -2403,7 +2403,7 @@ function readYaml<R>(path, options?): Promise<R>
|
|
|
2403
2403
|
|
|
2404
2404
|
##### Defined in
|
|
2405
2405
|
|
|
2406
|
-
[packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/
|
|
2406
|
+
[packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-yaml.ts#L6)
|
|
2407
2407
|
|
|
2408
2408
|
#### readYaml(path, reviver, options)
|
|
2409
2409
|
|
|
@@ -2432,7 +2432,7 @@ options?): Promise<R>
|
|
|
2432
2432
|
|
|
2433
2433
|
##### Defined in
|
|
2434
2434
|
|
|
2435
|
-
[packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/
|
|
2435
|
+
[packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-yaml.ts#L7)
|
|
2436
2436
|
|
|
2437
2437
|
***
|
|
2438
2438
|
|
|
@@ -2460,7 +2460,7 @@ function readYamlSync<R>(path, options?): R
|
|
|
2460
2460
|
|
|
2461
2461
|
##### Defined in
|
|
2462
2462
|
|
|
2463
|
-
[packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/
|
|
2463
|
+
[packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
2464
2464
|
|
|
2465
2465
|
#### readYamlSync(path, reviver, options)
|
|
2466
2466
|
|
|
@@ -2489,7 +2489,7 @@ function readYamlSync<R>(
|
|
|
2489
2489
|
|
|
2490
2490
|
##### Defined in
|
|
2491
2491
|
|
|
2492
|
-
[packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/
|
|
2492
|
+
[packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
2493
2493
|
|
|
2494
2494
|
***
|
|
2495
2495
|
|
|
@@ -2536,7 +2536,7 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2536
2536
|
|
|
2537
2537
|
#### Defined in
|
|
2538
2538
|
|
|
2539
|
-
[packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/
|
|
2539
|
+
[packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/remove/remove.ts#L5)
|
|
2540
2540
|
|
|
2541
2541
|
***
|
|
2542
2542
|
|
|
@@ -2583,7 +2583,7 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2583
2583
|
|
|
2584
2584
|
#### Defined in
|
|
2585
2585
|
|
|
2586
|
-
[packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/
|
|
2586
|
+
[packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/remove/remove-sync.ts#L5)
|
|
2587
2587
|
|
|
2588
2588
|
***
|
|
2589
2589
|
|
|
@@ -2629,7 +2629,7 @@ console.log('The file has been renamed');
|
|
|
2629
2629
|
|
|
2630
2630
|
#### Defined in
|
|
2631
2631
|
|
|
2632
|
-
[packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/
|
|
2632
|
+
[packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/move/index.ts#L85)
|
|
2633
2633
|
|
|
2634
2634
|
***
|
|
2635
2635
|
|
|
@@ -2675,7 +2675,7 @@ console.log('The file has been renamed');
|
|
|
2675
2675
|
|
|
2676
2676
|
#### Defined in
|
|
2677
2677
|
|
|
2678
|
-
[packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/
|
|
2678
|
+
[packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/move/index.ts#L109)
|
|
2679
2679
|
|
|
2680
2680
|
***
|
|
2681
2681
|
|
|
@@ -2709,7 +2709,7 @@ Options:
|
|
|
2709
2709
|
|
|
2710
2710
|
#### Defined in
|
|
2711
2711
|
|
|
2712
|
-
[packages/fs/src/find/walk.ts:52](https://github.com/visulima/visulima/blob/
|
|
2712
|
+
[packages/fs/src/find/walk.ts:52](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/find/walk.ts#L52)
|
|
2713
2713
|
|
|
2714
2714
|
***
|
|
2715
2715
|
|
|
@@ -2733,7 +2733,7 @@ Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
|
2733
2733
|
|
|
2734
2734
|
#### Defined in
|
|
2735
2735
|
|
|
2736
|
-
[packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/
|
|
2736
|
+
[packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/find/walk-sync.ts#L40)
|
|
2737
2737
|
|
|
2738
2738
|
***
|
|
2739
2739
|
|
|
@@ -2760,7 +2760,7 @@ options?): Promise<void>
|
|
|
2760
2760
|
|
|
2761
2761
|
#### Defined in
|
|
2762
2762
|
|
|
2763
|
-
[packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/
|
|
2763
|
+
[packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-file.ts#L15)
|
|
2764
2764
|
|
|
2765
2765
|
***
|
|
2766
2766
|
|
|
@@ -2787,7 +2787,7 @@ function writeFileSync(
|
|
|
2787
2787
|
|
|
2788
2788
|
#### Defined in
|
|
2789
2789
|
|
|
2790
|
-
[packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
2790
|
+
[packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-file-sync.ts#L15)
|
|
2791
2791
|
|
|
2792
2792
|
***
|
|
2793
2793
|
|
|
@@ -2814,7 +2814,7 @@ options): Promise<void>
|
|
|
2814
2814
|
|
|
2815
2815
|
#### Defined in
|
|
2816
2816
|
|
|
2817
|
-
[packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/
|
|
2817
|
+
[packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-json.ts#L11)
|
|
2818
2818
|
|
|
2819
2819
|
***
|
|
2820
2820
|
|
|
@@ -2841,7 +2841,7 @@ function writeJsonSync(
|
|
|
2841
2841
|
|
|
2842
2842
|
#### Defined in
|
|
2843
2843
|
|
|
2844
|
-
[packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
2844
|
+
[packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-json-sync.ts#L11)
|
|
2845
2845
|
|
|
2846
2846
|
***
|
|
2847
2847
|
|
|
@@ -2870,7 +2870,7 @@ options?): Promise<void>
|
|
|
2870
2870
|
|
|
2871
2871
|
##### Defined in
|
|
2872
2872
|
|
|
2873
|
-
[packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/
|
|
2873
|
+
[packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-yaml.ts#L10)
|
|
2874
2874
|
|
|
2875
2875
|
#### writeYaml(path, data, replacer, options)
|
|
2876
2876
|
|
|
@@ -2898,7 +2898,7 @@ options?): Promise<void>
|
|
|
2898
2898
|
|
|
2899
2899
|
##### Defined in
|
|
2900
2900
|
|
|
2901
|
-
[packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/
|
|
2901
|
+
[packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-yaml.ts#L16)
|
|
2902
2902
|
|
|
2903
2903
|
***
|
|
2904
2904
|
|
|
@@ -2927,7 +2927,7 @@ function writeYamlSync(
|
|
|
2927
2927
|
|
|
2928
2928
|
##### Defined in
|
|
2929
2929
|
|
|
2930
|
-
[packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
2930
|
+
[packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-yaml-sync.ts#L10)
|
|
2931
2931
|
|
|
2932
2932
|
#### writeYamlSync(path, data, replacer, options)
|
|
2933
2933
|
|
|
@@ -2955,7 +2955,7 @@ function writeYamlSync(
|
|
|
2955
2955
|
|
|
2956
2956
|
##### Defined in
|
|
2957
2957
|
|
|
2958
|
-
[packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
2958
|
+
[packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/write/write-yaml-sync.ts#L16)
|
|
2959
2959
|
|
|
2960
2960
|
## Variables
|
|
2961
2961
|
|
|
@@ -2969,7 +2969,7 @@ End-of-line character for Windows platforms.
|
|
|
2969
2969
|
|
|
2970
2970
|
#### Defined in
|
|
2971
2971
|
|
|
2972
|
-
[packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/
|
|
2972
|
+
[packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/eol.ts#L9)
|
|
2973
2973
|
|
|
2974
2974
|
***
|
|
2975
2975
|
|
|
@@ -2983,7 +2983,7 @@ End-of-line character evaluated for the current platform.
|
|
|
2983
2983
|
|
|
2984
2984
|
#### Defined in
|
|
2985
2985
|
|
|
2986
|
-
[packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/
|
|
2986
|
+
[packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/eol.ts#L14)
|
|
2987
2987
|
|
|
2988
2988
|
***
|
|
2989
2989
|
|
|
@@ -2997,7 +2997,7 @@ Is the path visible to the calling process?
|
|
|
2997
2997
|
|
|
2998
2998
|
#### Defined in
|
|
2999
2999
|
|
|
3000
|
-
[packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/
|
|
3000
|
+
[packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/constants.ts#L2)
|
|
3001
3001
|
|
|
3002
3002
|
***
|
|
3003
3003
|
|
|
@@ -3009,7 +3009,7 @@ const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
|
3009
3009
|
|
|
3010
3010
|
#### Defined in
|
|
3011
3011
|
|
|
3012
|
-
[packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/
|
|
3012
|
+
[packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/constants.ts#L13)
|
|
3013
3013
|
|
|
3014
3014
|
***
|
|
3015
3015
|
|
|
@@ -3023,7 +3023,7 @@ End-of-line character for POSIX platforms such as macOS and Linux.
|
|
|
3023
3023
|
|
|
3024
3024
|
#### Defined in
|
|
3025
3025
|
|
|
3026
|
-
[packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/
|
|
3026
|
+
[packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/eol.ts#L6)
|
|
3027
3027
|
|
|
3028
3028
|
***
|
|
3029
3029
|
|
|
@@ -3037,7 +3037,7 @@ Is the path readable to the calling process?
|
|
|
3037
3037
|
|
|
3038
3038
|
#### Defined in
|
|
3039
3039
|
|
|
3040
|
-
[packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/
|
|
3040
|
+
[packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/constants.ts#L5)
|
|
3041
3041
|
|
|
3042
3042
|
***
|
|
3043
3043
|
|
|
@@ -3051,7 +3051,7 @@ Is the path writable to the calling process?
|
|
|
3051
3051
|
|
|
3052
3052
|
#### Defined in
|
|
3053
3053
|
|
|
3054
|
-
[packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/
|
|
3054
|
+
[packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/constants.ts#L8)
|
|
3055
3055
|
|
|
3056
3056
|
***
|
|
3057
3057
|
|
|
@@ -3065,7 +3065,7 @@ Is the path executable to the calling process?
|
|
|
3065
3065
|
|
|
3066
3066
|
#### Defined in
|
|
3067
3067
|
|
|
3068
|
-
[packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/
|
|
3068
|
+
[packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/constants.ts#L11)
|
|
3069
3069
|
|
|
3070
3070
|
## Interfaces
|
|
3071
3071
|
|
|
@@ -3181,7 +3181,7 @@ path: string;
|
|
|
3181
3181
|
|
|
3182
3182
|
###### Defined in
|
|
3183
3183
|
|
|
3184
|
-
[packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/
|
|
3184
|
+
[packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L57)
|
|
3185
3185
|
|
|
3186
3186
|
***
|
|
3187
3187
|
|
|
@@ -3206,7 +3206,7 @@ If specified, entries without the file extension specified by this option are ex
|
|
|
3206
3206
|
|
|
3207
3207
|
###### Defined in
|
|
3208
3208
|
|
|
3209
|
-
[packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/
|
|
3209
|
+
[packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L15)
|
|
3210
3210
|
|
|
3211
3211
|
##### followSymlinks?
|
|
3212
3212
|
|
|
@@ -3224,7 +3224,7 @@ Indicates whether symlinks should be resolved or not.
|
|
|
3224
3224
|
|
|
3225
3225
|
###### Defined in
|
|
3226
3226
|
|
|
3227
|
-
[packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/
|
|
3227
|
+
[packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L20)
|
|
3228
3228
|
|
|
3229
3229
|
##### includeDirs?
|
|
3230
3230
|
|
|
@@ -3242,7 +3242,7 @@ Indicates whether directory entries should be included or not.
|
|
|
3242
3242
|
|
|
3243
3243
|
###### Defined in
|
|
3244
3244
|
|
|
3245
|
-
[packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/
|
|
3245
|
+
[packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L25)
|
|
3246
3246
|
|
|
3247
3247
|
##### includeFiles?
|
|
3248
3248
|
|
|
@@ -3260,7 +3260,7 @@ Indicates whether file entries should be included or not.
|
|
|
3260
3260
|
|
|
3261
3261
|
###### Defined in
|
|
3262
3262
|
|
|
3263
|
-
[packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/
|
|
3263
|
+
[packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L30)
|
|
3264
3264
|
|
|
3265
3265
|
##### includeSymlinks?
|
|
3266
3266
|
|
|
@@ -3279,7 +3279,7 @@ This option is meaningful only if `followSymlinks` is set to `false`.
|
|
|
3279
3279
|
|
|
3280
3280
|
###### Defined in
|
|
3281
3281
|
|
|
3282
|
-
[packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/
|
|
3282
|
+
[packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L36)
|
|
3283
3283
|
|
|
3284
3284
|
##### match?
|
|
3285
3285
|
|
|
@@ -3298,7 +3298,7 @@ If specified, entries that do not match the patterns specified by this option ar
|
|
|
3298
3298
|
|
|
3299
3299
|
###### Defined in
|
|
3300
3300
|
|
|
3301
|
-
[packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/
|
|
3301
|
+
[packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L42)
|
|
3302
3302
|
|
|
3303
3303
|
##### maxDepth?
|
|
3304
3304
|
|
|
@@ -3316,7 +3316,7 @@ The maximum depth of the file tree to be walked recursively.
|
|
|
3316
3316
|
|
|
3317
3317
|
###### Defined in
|
|
3318
3318
|
|
|
3319
|
-
[packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/
|
|
3319
|
+
[packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L47)
|
|
3320
3320
|
|
|
3321
3321
|
##### skip?
|
|
3322
3322
|
|
|
@@ -3335,7 +3335,7 @@ If specified, entries matching the patterns specified by this option are exclude
|
|
|
3335
3335
|
|
|
3336
3336
|
###### Defined in
|
|
3337
3337
|
|
|
3338
|
-
[packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/
|
|
3338
|
+
[packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L53)
|
|
3339
3339
|
|
|
3340
3340
|
## Type Aliases
|
|
3341
3341
|
|
|
@@ -3361,7 +3361,7 @@ line: number;
|
|
|
3361
3361
|
|
|
3362
3362
|
#### Defined in
|
|
3363
3363
|
|
|
3364
|
-
[packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/
|
|
3364
|
+
[packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L91)
|
|
3365
3365
|
|
|
3366
3366
|
***
|
|
3367
3367
|
|
|
@@ -3408,7 +3408,7 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
3408
3408
|
|
|
3409
3409
|
#### Defined in
|
|
3410
3410
|
|
|
3411
|
-
[packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/
|
|
3411
|
+
[packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L188)
|
|
3412
3412
|
|
|
3413
3413
|
***
|
|
3414
3414
|
|
|
@@ -3420,7 +3420,7 @@ type FindUpName: string[] | string | (directory) => FindUpNameFnResult;
|
|
|
3420
3420
|
|
|
3421
3421
|
#### Defined in
|
|
3422
3422
|
|
|
3423
|
-
[packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/
|
|
3423
|
+
[packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L180)
|
|
3424
3424
|
|
|
3425
3425
|
***
|
|
3426
3426
|
|
|
@@ -3432,7 +3432,7 @@ type FindUpNameFnResult: PathLike | Promise<PathLike | typeof FIND_UP_STOP> | ty
|
|
|
3432
3432
|
|
|
3433
3433
|
#### Defined in
|
|
3434
3434
|
|
|
3435
|
-
[packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/
|
|
3435
|
+
[packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L178)
|
|
3436
3436
|
|
|
3437
3437
|
***
|
|
3438
3438
|
|
|
@@ -3444,7 +3444,7 @@ type FindUpNameSync: string[] | string | (directory) => FindUpNameSyncFnResult;
|
|
|
3444
3444
|
|
|
3445
3445
|
#### Defined in
|
|
3446
3446
|
|
|
3447
|
-
[packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/
|
|
3447
|
+
[packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L185)
|
|
3448
3448
|
|
|
3449
3449
|
***
|
|
3450
3450
|
|
|
@@ -3456,7 +3456,7 @@ type FindUpNameSyncFnResult: PathLike | typeof FIND_UP_STOP | undefined;
|
|
|
3456
3456
|
|
|
3457
3457
|
#### Defined in
|
|
3458
3458
|
|
|
3459
|
-
[packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/
|
|
3459
|
+
[packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L183)
|
|
3460
3460
|
|
|
3461
3461
|
***
|
|
3462
3462
|
|
|
@@ -3494,7 +3494,7 @@ optional type: "directory" | "file";
|
|
|
3494
3494
|
|
|
3495
3495
|
#### Defined in
|
|
3496
3496
|
|
|
3497
|
-
[packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/
|
|
3497
|
+
[packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L170)
|
|
3498
3498
|
|
|
3499
3499
|
***
|
|
3500
3500
|
|
|
@@ -3506,7 +3506,7 @@ type JsonReplacer: (number | string)[] | (this, key, value) => unknown | null;
|
|
|
3506
3506
|
|
|
3507
3507
|
#### Defined in
|
|
3508
3508
|
|
|
3509
|
-
[packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/
|
|
3509
|
+
[packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L143)
|
|
3510
3510
|
|
|
3511
3511
|
***
|
|
3512
3512
|
|
|
@@ -3518,7 +3518,7 @@ type JsonReviver: Parameters<typeof JSON["parse"]>["1"];
|
|
|
3518
3518
|
|
|
3519
3519
|
#### Defined in
|
|
3520
3520
|
|
|
3521
|
-
[packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/
|
|
3521
|
+
[packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L89)
|
|
3522
3522
|
|
|
3523
3523
|
***
|
|
3524
3524
|
|
|
@@ -3577,7 +3577,7 @@ true
|
|
|
3577
3577
|
|
|
3578
3578
|
#### Defined in
|
|
3579
3579
|
|
|
3580
|
-
[packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/
|
|
3580
|
+
[packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/move/types.ts#L3)
|
|
3581
3581
|
|
|
3582
3582
|
***
|
|
3583
3583
|
|
|
@@ -3600,7 +3600,7 @@ type ReadFileEncoding:
|
|
|
3600
3600
|
|
|
3601
3601
|
#### Defined in
|
|
3602
3602
|
|
|
3603
|
-
[packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/
|
|
3603
|
+
[packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L61)
|
|
3604
3604
|
|
|
3605
3605
|
***
|
|
3606
3606
|
|
|
@@ -3654,7 +3654,7 @@ The flag used to open the file. Default: `r`
|
|
|
3654
3654
|
|
|
3655
3655
|
#### Defined in
|
|
3656
3656
|
|
|
3657
|
-
[packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/
|
|
3657
|
+
[packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L63)
|
|
3658
3658
|
|
|
3659
3659
|
***
|
|
3660
3660
|
|
|
@@ -3682,7 +3682,7 @@ optional beforeParse: (source) => string;
|
|
|
3682
3682
|
|
|
3683
3683
|
#### Defined in
|
|
3684
3684
|
|
|
3685
|
-
[packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/
|
|
3685
|
+
[packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L104)
|
|
3686
3686
|
|
|
3687
3687
|
***
|
|
3688
3688
|
|
|
@@ -3756,7 +3756,7 @@ Recursively create parent directories if needed. Default: `true`
|
|
|
3756
3756
|
|
|
3757
3757
|
#### Defined in
|
|
3758
3758
|
|
|
3759
|
-
[packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/
|
|
3759
|
+
[packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L108)
|
|
3760
3760
|
|
|
3761
3761
|
***
|
|
3762
3762
|
|
|
@@ -3816,7 +3816,7 @@ Override the default `JSON.stringify` method.
|
|
|
3816
3816
|
|
|
3817
3817
|
#### Defined in
|
|
3818
3818
|
|
|
3819
|
-
[packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/
|
|
3819
|
+
[packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L146)
|
|
3820
3820
|
|
|
3821
3821
|
***
|
|
3822
3822
|
|
|
@@ -3828,7 +3828,7 @@ type YamlReplacer: JsonReplacer;
|
|
|
3828
3828
|
|
|
3829
3829
|
#### Defined in
|
|
3830
3830
|
|
|
3831
|
-
[packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/
|
|
3831
|
+
[packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/types.ts#L144)
|
|
3832
3832
|
# utils
|
|
3833
3833
|
|
|
3834
3834
|
## Classes
|
|
@@ -3861,7 +3861,7 @@ new JSONError(message): JSONError
|
|
|
3861
3861
|
|
|
3862
3862
|
###### Defined in
|
|
3863
3863
|
|
|
3864
|
-
[packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/
|
|
3864
|
+
[packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/json-error.ts#L11)
|
|
3865
3865
|
|
|
3866
3866
|
#### Accessors
|
|
3867
3867
|
|
|
@@ -3889,7 +3889,7 @@ set message(message): void
|
|
|
3889
3889
|
|
|
3890
3890
|
###### Defined in
|
|
3891
3891
|
|
|
3892
|
-
[packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
3892
|
+
[packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/json-error.ts#L21)
|
|
3893
3893
|
|
|
3894
3894
|
#### Methods
|
|
3895
3895
|
|
|
@@ -3943,7 +3943,7 @@ codeFrame: string;
|
|
|
3943
3943
|
|
|
3944
3944
|
###### Defined in
|
|
3945
3945
|
|
|
3946
|
-
[packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
3946
|
+
[packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/json-error.ts#L4)
|
|
3947
3947
|
|
|
3948
3948
|
##### fileName
|
|
3949
3949
|
|
|
@@ -3953,7 +3953,7 @@ fileName: string;
|
|
|
3953
3953
|
|
|
3954
3954
|
###### Defined in
|
|
3955
3955
|
|
|
3956
|
-
[packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/
|
|
3956
|
+
[packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/json-error.ts#L2)
|
|
3957
3957
|
|
|
3958
3958
|
##### name
|
|
3959
3959
|
|
|
@@ -3967,7 +3967,7 @@ readonly name: "JSONError" = "JSONError";
|
|
|
3967
3967
|
|
|
3968
3968
|
###### Defined in
|
|
3969
3969
|
|
|
3970
|
-
[packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/
|
|
3970
|
+
[packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/error/json-error.ts#L7)
|
|
3971
3971
|
|
|
3972
3972
|
##### stack?
|
|
3973
3973
|
|
|
@@ -4045,7 +4045,7 @@ function assertValidFileContents(contents): void
|
|
|
4045
4045
|
|
|
4046
4046
|
#### Defined in
|
|
4047
4047
|
|
|
4048
|
-
[packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/
|
|
4048
|
+
[packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/utils/assert-valid-file-contents.ts#L2)
|
|
4049
4049
|
|
|
4050
4050
|
***
|
|
4051
4051
|
|
|
@@ -4065,7 +4065,7 @@ function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
|
4065
4065
|
|
|
4066
4066
|
#### Defined in
|
|
4067
4067
|
|
|
4068
|
-
[packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/
|
|
4068
|
+
[packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L2)
|
|
4069
4069
|
|
|
4070
4070
|
***
|
|
4071
4071
|
|
|
@@ -4098,7 +4098,7 @@ function parseJson<T>(
|
|
|
4098
4098
|
|
|
4099
4099
|
##### Defined in
|
|
4100
4100
|
|
|
4101
|
-
[packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/
|
|
4101
|
+
[packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/utils/parse-json.ts#L60)
|
|
4102
4102
|
|
|
4103
4103
|
#### parseJson(string, reviver, fileName, options)
|
|
4104
4104
|
|
|
@@ -4130,7 +4130,7 @@ function parseJson<T>(
|
|
|
4130
4130
|
|
|
4131
4131
|
##### Defined in
|
|
4132
4132
|
|
|
4133
|
-
[packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/
|
|
4133
|
+
[packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/utils/parse-json.ts#L61)
|
|
4134
4134
|
|
|
4135
4135
|
***
|
|
4136
4136
|
|
|
@@ -4154,7 +4154,7 @@ function stripJsonComments(jsonString, __namedParameters): string
|
|
|
4154
4154
|
|
|
4155
4155
|
#### Defined in
|
|
4156
4156
|
|
|
4157
|
-
[packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/
|
|
4157
|
+
[packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/2374dadf62026394df061c7bf8ce1e99ce0304c4/packages/fs/src/utils/strip-json-comments.ts#L5)
|
|
4158
4158
|
|
|
4159
4159
|
***
|
|
4160
4160
|
|
|
@@ -4174,7 +4174,7 @@ function toPath(urlOrPath): string
|
|
|
4174
4174
|
|
|
4175
4175
|
#### Defined in
|
|
4176
4176
|
|
|
4177
|
-
node\_modules/.pnpm/@visulima+path@1.1.
|
|
4177
|
+
node\_modules/.pnpm/@visulima+path@1.1.2/node\_modules/@visulima/path/dist/utils.d.mts:7
|
|
4178
4178
|
|
|
4179
4179
|
<!-- /TYPEDOC -->
|
|
4180
4180
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@visulima/fs",
|
|
3
|
-
"version": "2.3.
|
|
3
|
+
"version": "2.3.3",
|
|
4
4
|
"description": "Human friendly file system utilities for Node.js",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"anolilab",
|
|
@@ -132,19 +132,20 @@
|
|
|
132
132
|
"LICENSE.md"
|
|
133
133
|
],
|
|
134
134
|
"dependencies": {
|
|
135
|
-
"@visulima/path": "1.
|
|
135
|
+
"@visulima/path": "1.2.0",
|
|
136
|
+
"yaml": "^2.6.1"
|
|
136
137
|
},
|
|
137
138
|
"devDependencies": {
|
|
138
139
|
"@anolilab/eslint-config": "^15.0.3",
|
|
139
140
|
"@anolilab/prettier-config": "^5.0.14",
|
|
140
|
-
"@anolilab/semantic-release-pnpm": "^1.1.
|
|
141
|
-
"@anolilab/semantic-release-preset": "^9.0.
|
|
142
|
-
"@arethetypeswrong/cli": "^0.17.
|
|
141
|
+
"@anolilab/semantic-release-pnpm": "^1.1.6",
|
|
142
|
+
"@anolilab/semantic-release-preset": "^9.0.3",
|
|
143
|
+
"@arethetypeswrong/cli": "^0.17.2",
|
|
143
144
|
"@babel/core": "^7.26.0",
|
|
144
145
|
"@ckeditor/typedoc-plugins": "43.0.0",
|
|
145
146
|
"@rushstack/eslint-plugin-security": "^0.8.3",
|
|
146
147
|
"@types/node": "18.19.15",
|
|
147
|
-
"@visulima/error": "4.4.
|
|
148
|
+
"@visulima/error": "4.4.9",
|
|
148
149
|
"@visulima/packem": "1.1.1",
|
|
149
150
|
"@vitest/coverage-v8": "^2.1.8",
|
|
150
151
|
"@vitest/ui": "^2.1.8",
|
|
@@ -161,26 +162,17 @@
|
|
|
161
162
|
"eslint-plugin-vitest-globals": "^1.5.0",
|
|
162
163
|
"fast-safe-stringify": "2.1.1",
|
|
163
164
|
"prettier": "^3.4.2",
|
|
164
|
-
"redos-detector": "^
|
|
165
|
+
"redos-detector": "^6.1.1",
|
|
165
166
|
"rimraf": "6.0.1",
|
|
166
167
|
"safe-regex2": "^4.0.0",
|
|
167
168
|
"semantic-release": "24.1.3",
|
|
168
169
|
"tempy": "^3.1.0",
|
|
169
|
-
"type-fest": "^4.
|
|
170
|
+
"type-fest": "^4.31.0",
|
|
170
171
|
"typedoc": "0.26.10",
|
|
171
172
|
"typedoc-plugin-markdown": "4.2.9",
|
|
172
173
|
"typedoc-plugin-rename-defaults": "0.7.1",
|
|
173
174
|
"typescript": "5.6.3",
|
|
174
|
-
"vitest": "^2.1.8"
|
|
175
|
-
"yaml": "^2.6.1"
|
|
176
|
-
},
|
|
177
|
-
"peerDependencies": {
|
|
178
|
-
"yaml": ">=2.4"
|
|
179
|
-
},
|
|
180
|
-
"peerDependenciesMeta": {
|
|
181
|
-
"yaml": {
|
|
182
|
-
"optional": true
|
|
183
|
-
}
|
|
175
|
+
"vitest": "^2.1.8"
|
|
184
176
|
},
|
|
185
177
|
"engines": {
|
|
186
178
|
"node": ">=18.* <=23.*"
|