@visulima/fs 3.1.6 → 3.1.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/LICENSE.md +125 -0
- package/README.md +153 -153
- package/dist/eol.cjs +3 -28
- package/dist/eol.mjs +3 -20
- package/dist/error.cjs +1 -21
- package/dist/error.mjs +1 -7
- package/dist/index.cjs +1 -80
- package/dist/index.d.cts +2 -2
- package/dist/index.d.mts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.mjs +1 -31
- package/dist/packem_shared/AlreadyExistsError-CEu6_Tjb.mjs +1 -0
- package/dist/packem_shared/AlreadyExistsError-GC2XUgzJ.cjs +1 -0
- package/dist/packem_shared/DirectoryError-aGtmQVph.cjs +1 -0
- package/dist/packem_shared/DirectoryError-ddlbUV8C.mjs +1 -0
- package/dist/packem_shared/F_OK-7T91O6Oz.cjs +1 -0
- package/dist/packem_shared/F_OK-B71i3mUa.mjs +1 -0
- package/dist/packem_shared/JSONError-CVkb3xZ3.mjs +4 -0
- package/dist/packem_shared/JSONError-CWuiGmNc.cjs +4 -0
- package/dist/packem_shared/NotEmptyError-BWGfec5K.cjs +1 -0
- package/dist/packem_shared/NotEmptyError-DMh1o7UL.mjs +1 -0
- package/dist/packem_shared/NotFoundError-BPiW0icm.mjs +1 -0
- package/dist/packem_shared/NotFoundError-Diij7oqe.cjs +1 -0
- package/dist/packem_shared/PermissionError-B1Emi5a9.mjs +1 -0
- package/dist/packem_shared/PermissionError-Ck1Es7al.cjs +1 -0
- package/dist/packem_shared/WalkError-BsngoIKJ.mjs +1 -0
- package/dist/packem_shared/WalkError-gKgp0TWD.cjs +1 -0
- package/dist/packem_shared/assertValidFileContents-BZFnXa7K.mjs +1 -0
- package/dist/packem_shared/assertValidFileContents-CrbDz09d.cjs +1 -0
- package/dist/packem_shared/assertValidFileOrDirectoryPath-DgPIPmZT.mjs +1 -0
- package/dist/packem_shared/assertValidFileOrDirectoryPath-HOUs73Jk.cjs +1 -0
- package/dist/packem_shared/collect-Bl2Oc1qs.cjs +1 -0
- package/dist/packem_shared/collect-CyYPQFMs.mjs +1 -0
- package/dist/packem_shared/collectSync-BHjyXWq4.cjs +1 -0
- package/dist/packem_shared/collectSync-CD9cXw2g.mjs +1 -0
- package/dist/packem_shared/emptyDir-BdjO-6Gu.mjs +1 -0
- package/dist/packem_shared/emptyDir-DGRw4yE9.cjs +1 -0
- package/dist/packem_shared/emptyDirSync-C1vsMEp-.mjs +1 -0
- package/dist/packem_shared/emptyDirSync-DzjDZxOx.cjs +1 -0
- package/dist/packem_shared/ensureDir-BuIFF_6B.mjs +1 -0
- package/dist/packem_shared/ensureDir-DtQzyA70.cjs +1 -0
- package/dist/packem_shared/ensureDirSync-BuPHxdP4.mjs +1 -0
- package/dist/packem_shared/ensureDirSync-C8hIoS3o.cjs +1 -0
- package/dist/packem_shared/ensureFile-DcAODM6a.mjs +1 -0
- package/dist/packem_shared/ensureFile-wR8zBfXh.cjs +1 -0
- package/dist/packem_shared/ensureFileSync-BI1fIdNf.cjs +1 -0
- package/dist/packem_shared/ensureFileSync-CzPN6ucX.mjs +1 -0
- package/dist/packem_shared/ensureLink-BaZLXxgx.mjs +1 -0
- package/dist/packem_shared/ensureLink-DCPuU0Za.cjs +1 -0
- package/dist/packem_shared/ensureLinkSync-9C2JL-Sl.mjs +1 -0
- package/dist/packem_shared/ensureLinkSync-CuRZmQlV.cjs +1 -0
- package/dist/packem_shared/ensureSymlink-BH6wbylb.mjs +1 -0
- package/dist/packem_shared/ensureSymlink-J83jhdfA.cjs +1 -0
- package/dist/packem_shared/ensureSymlinkSync-CZSPodAm.mjs +1 -0
- package/dist/packem_shared/ensureSymlinkSync-VNtMTaV8.cjs +1 -0
- package/dist/packem_shared/findUp-C5aWsLuD.cjs +1 -0
- package/dist/packem_shared/findUp-CMGMYNty.mjs +1 -0
- package/dist/packem_shared/findUpSync-QP_ZEsJN.mjs +1 -0
- package/dist/packem_shared/findUpSync-U1lTgv4y.cjs +1 -0
- package/dist/packem_shared/get-file-info-type-CaWGXRjY.mjs +1 -0
- package/dist/packem_shared/get-file-info-type-DDbpRlDl.cjs +1 -0
- package/dist/packem_shared/index-BSjF-5vj.mjs +1 -0
- package/dist/packem_shared/index-DPla58ce.cjs +1 -0
- package/dist/packem_shared/is-stats-identical-Bti7K05l.cjs +1 -0
- package/dist/packem_shared/is-stats-identical-CohsLtWy.mjs +1 -0
- package/dist/packem_shared/isAccessible-BQZd1_xn.cjs +1 -0
- package/dist/packem_shared/isAccessible-CL4eE5VL.mjs +1 -0
- package/dist/packem_shared/isAccessibleSync-BP5N8k_-.cjs +1 -0
- package/dist/packem_shared/isAccessibleSync-_HU_ppdG.mjs +1 -0
- package/dist/packem_shared/move--o4NZLpD.mjs +1 -0
- package/dist/packem_shared/move-DwG6APiG.cjs +1 -0
- package/dist/packem_shared/parseJson-B_GwHpKj.cjs +6 -0
- package/dist/packem_shared/parseJson-Bqic0nN8.mjs +6 -0
- package/dist/packem_shared/readFile-BvefDyr_.cjs +1 -0
- package/dist/packem_shared/readFile-Cix_ijtX.mjs +1 -0
- package/dist/packem_shared/readFileSync-B0O-8BH0.mjs +1 -0
- package/dist/packem_shared/readFileSync-Ct8Ql4Vs.cjs +1 -0
- package/dist/packem_shared/readJson-BLvd2Bsj.mjs +1 -0
- package/dist/packem_shared/readJson-cP5ArpPg.cjs +1 -0
- package/dist/packem_shared/readJsonSync-B6h6A3Un.cjs +1 -0
- package/dist/packem_shared/readJsonSync-Br5dHGAI.mjs +1 -0
- package/dist/packem_shared/readYaml-BOYTR5D1.mjs +1 -0
- package/dist/packem_shared/readYaml-BzMFDsYe.cjs +1 -0
- package/dist/packem_shared/readYamlSync-BbK0khJu.cjs +1 -0
- package/dist/packem_shared/readYamlSync-md9g88k7.mjs +1 -0
- package/dist/packem_shared/remove-CtnFqEpd.mjs +1 -0
- package/dist/packem_shared/remove-DPCf2Qdb.cjs +1 -0
- package/dist/packem_shared/removeSync-Cyriz7r8.cjs +1 -0
- package/dist/packem_shared/removeSync-DI-IjqVp.mjs +1 -0
- package/dist/packem_shared/resolve-symlink-target-BofZSDIc.mjs +1 -0
- package/dist/packem_shared/resolve-symlink-target-zilkQ_AU.cjs +1 -0
- package/dist/packem_shared/stripJsonComments-Cp5SNAB7.mjs +1 -0
- package/dist/packem_shared/stripJsonComments-CvZSDnYT.cjs +1 -0
- package/dist/packem_shared/to-uint-8-array-2-3EvGd7.cjs +1 -0
- package/dist/packem_shared/to-uint-8-array-DwgaTasY.mjs +1 -0
- package/dist/packem_shared/{types-BaMGfHdp.d.ts → types-XsSUZ9oS.d.cts} +1 -1
- package/dist/packem_shared/{types-BaMGfHdp.d.mts → types-XsSUZ9oS.d.mts} +1 -1
- package/dist/packem_shared/{types-BaMGfHdp.d.cts → types-XsSUZ9oS.d.ts} +1 -1
- package/dist/packem_shared/walk-BZTXbT87.mjs +1 -0
- package/dist/packem_shared/walk-DyN_HVFW.cjs +1 -0
- package/dist/packem_shared/walk-include-C9pVST87.mjs +1 -0
- package/dist/packem_shared/walk-include-DkK-WJl4.cjs +1 -0
- package/dist/packem_shared/walkSync-BHlEzV_m.mjs +1 -0
- package/dist/packem_shared/walkSync-Bqi7L2yG.cjs +1 -0
- package/dist/packem_shared/writeFile-COOAkvOE.mjs +1 -0
- package/dist/packem_shared/writeFile-CjgQEfur.cjs +1 -0
- package/dist/packem_shared/writeFileSync-CQuRHo9n.cjs +1 -0
- package/dist/packem_shared/writeFileSync-rhu-y_zx.mjs +1 -0
- package/dist/packem_shared/writeJson-BYT4WInm.mjs +4 -0
- package/dist/packem_shared/writeJson-CJIciZ_Q.cjs +4 -0
- package/dist/packem_shared/writeJsonSync-BIsrhRbV.cjs +4 -0
- package/dist/packem_shared/writeJsonSync-CLlXOFDm.mjs +4 -0
- package/dist/packem_shared/writeYaml-CjzVd0K-.mjs +1 -0
- package/dist/packem_shared/writeYaml-VmX1VKhN.cjs +1 -0
- package/dist/packem_shared/writeYamlSync-D9A9Ixe1.mjs +1 -0
- package/dist/packem_shared/writeYamlSync-DYsM6XBi.cjs +1 -0
- package/dist/size.cjs +1 -118
- package/dist/size.mjs +1 -109
- package/dist/utils.cjs +1 -19
- package/dist/utils.d.cts +1 -1
- package/dist/utils.d.mts +1 -1
- package/dist/utils.d.ts +1 -1
- package/dist/utils.mjs +1 -6
- package/dist/yaml.cjs +1 -15
- package/dist/yaml.d.cts +1 -1
- package/dist/yaml.d.mts +1 -1
- package/dist/yaml.d.ts +1 -1
- package/dist/yaml.mjs +1 -4
- package/package.json +1 -1
- package/dist/packem_shared/AlreadyExistsError-DpxtwQot.cjs +0 -34
- package/dist/packem_shared/AlreadyExistsError-GK7J9fVA.mjs +0 -32
- package/dist/packem_shared/DirectoryError-D8FHcAqu.cjs +0 -34
- package/dist/packem_shared/DirectoryError-DByTWE7t.mjs +0 -32
- package/dist/packem_shared/F_OK-CWSqQIdF.cjs +0 -17
- package/dist/packem_shared/F_OK-JER1LjUr.mjs +0 -8
- package/dist/packem_shared/JSONError-5-wHnrxX.cjs +0 -34
- package/dist/packem_shared/JSONError-CaKt7MhC.mjs +0 -32
- package/dist/packem_shared/NotEmptyError-BCS_5pPt.cjs +0 -34
- package/dist/packem_shared/NotEmptyError-DCXooh5l.mjs +0 -32
- package/dist/packem_shared/NotFoundError-B_1nPl3K.cjs +0 -34
- package/dist/packem_shared/NotFoundError-CUdcC61I.mjs +0 -32
- package/dist/packem_shared/PermissionError-CqGMI9qC.mjs +0 -32
- package/dist/packem_shared/PermissionError-QFMKgk2l.cjs +0 -34
- package/dist/packem_shared/WalkError-B4-yr8Kk.cjs +0 -31
- package/dist/packem_shared/WalkError-DvEBTTaj.mjs +0 -29
- package/dist/packem_shared/assertValidFileContents-CRVvyM6b.cjs +0 -11
- package/dist/packem_shared/assertValidFileContents-Ox-ScfeK.mjs +0 -9
- package/dist/packem_shared/assertValidFileOrDirectoryPath-BMbgA-eI.cjs +0 -11
- package/dist/packem_shared/assertValidFileOrDirectoryPath-BWWgA1wj.mjs +0 -9
- package/dist/packem_shared/collect-3Paj1Vqw.mjs +0 -16
- package/dist/packem_shared/collect-DnfQeSOL.cjs +0 -18
- package/dist/packem_shared/collectSync-D4vym4QD.cjs +0 -18
- package/dist/packem_shared/collectSync-DwJLL8SD.mjs +0 -16
- package/dist/packem_shared/emptyDir-DcCfiNcf.cjs +0 -22
- package/dist/packem_shared/emptyDir-Dw5xSBox.mjs +0 -20
- package/dist/packem_shared/emptyDirSync-BWA4n6TB.cjs +0 -21
- package/dist/packem_shared/emptyDirSync-DMAaCiC_.mjs +0 -19
- package/dist/packem_shared/ensureDir-BOfUZlxG.cjs +0 -35
- package/dist/packem_shared/ensureDir-BnA_fY1A.mjs +0 -33
- package/dist/packem_shared/ensureDirSync-DHmWi3CF.cjs +0 -35
- package/dist/packem_shared/ensureDirSync-Dm4az3YF.mjs +0 -33
- package/dist/packem_shared/ensureFile-BKrJMHfr.mjs +0 -27
- package/dist/packem_shared/ensureFile-CeGryLJI.cjs +0 -29
- package/dist/packem_shared/ensureFileSync-B7THM1sN.cjs +0 -29
- package/dist/packem_shared/ensureFileSync-BnhFBXaR.mjs +0 -27
- package/dist/packem_shared/ensureLink-ChsWDTK5.mjs +0 -34
- package/dist/packem_shared/ensureLink-CrxLNmHE.cjs +0 -36
- package/dist/packem_shared/ensureLinkSync-CG-DTUoV.mjs +0 -34
- package/dist/packem_shared/ensureLinkSync-D8uMqLh4.cjs +0 -36
- package/dist/packem_shared/ensureSymlink-BwJ_QhzJ.mjs +0 -52
- package/dist/packem_shared/ensureSymlink-D_ieOVYa.cjs +0 -54
- package/dist/packem_shared/ensureSymlinkSync-BamG29QK.mjs +0 -56
- package/dist/packem_shared/ensureSymlinkSync-DTMvUYZD.cjs +0 -58
- package/dist/packem_shared/findUp-D5W-MTpT.mjs +0 -63
- package/dist/packem_shared/findUp-DVIYN2wV.cjs +0 -65
- package/dist/packem_shared/findUpSync-BOiVyUOx.cjs +0 -65
- package/dist/packem_shared/findUpSync-DL3NPCYg.mjs +0 -63
- package/dist/packem_shared/get-file-info-type-BlryFnpp.cjs +0 -18
- package/dist/packem_shared/get-file-info-type-ButUVD6d.mjs +0 -16
- package/dist/packem_shared/index-BVZL6YMm.cjs +0 -110
- package/dist/packem_shared/index-r9Pk9gBe.mjs +0 -108
- package/dist/packem_shared/is-stats-identical-BfdEfO6i.cjs +0 -7
- package/dist/packem_shared/is-stats-identical-ByTYZ2Aw.mjs +0 -5
- package/dist/packem_shared/isAccessible-Bonsm1Ez.mjs +0 -20
- package/dist/packem_shared/isAccessible-ZNVGsSb7.cjs +0 -22
- package/dist/packem_shared/isAccessibleSync-3gnUWUwX.mjs +0 -20
- package/dist/packem_shared/isAccessibleSync-VWjQa-US.cjs +0 -22
- package/dist/packem_shared/move-DgF7Ul9L.mjs +0 -114
- package/dist/packem_shared/move-Dh925GL9.cjs +0 -121
- package/dist/packem_shared/parseJson-BA7Xrggq.mjs +0 -248
- package/dist/packem_shared/parseJson-LgPGI5ic.cjs +0 -250
- package/dist/packem_shared/readFile-b7UBVv17.mjs +0 -46
- package/dist/packem_shared/readFile-iFUhZHnh.cjs +0 -48
- package/dist/packem_shared/readFileSync-B3NTOR-W.cjs +0 -33
- package/dist/packem_shared/readFileSync-CkEJBqZB.mjs +0 -31
- package/dist/packem_shared/readJson-CEBHyuYq.cjs +0 -27
- package/dist/packem_shared/readJson-Ce9b06cu.mjs +0 -25
- package/dist/packem_shared/readJsonSync-B22hej0y.cjs +0 -27
- package/dist/packem_shared/readJsonSync-CkUI9_z5.mjs +0 -25
- package/dist/packem_shared/readYaml-C5MSs2GE.mjs +0 -13
- package/dist/packem_shared/readYaml-sR4bqUel.cjs +0 -15
- package/dist/packem_shared/readYamlSync-C3oOzxiN.cjs +0 -15
- package/dist/packem_shared/readYamlSync-CPjA-DLv.mjs +0 -13
- package/dist/packem_shared/remove-B2nxUObP.mjs +0 -18
- package/dist/packem_shared/remove-BpDiVPns.cjs +0 -20
- package/dist/packem_shared/removeSync-BosXW624.cjs +0 -20
- package/dist/packem_shared/removeSync-C87yepDI.mjs +0 -18
- package/dist/packem_shared/resolve-symlink-target-BbpEHdU2.mjs +0 -18
- package/dist/packem_shared/resolve-symlink-target-DImIddt6.cjs +0 -20
- package/dist/packem_shared/stripJsonComments-B66nRaTZ.mjs +0 -21
- package/dist/packem_shared/stripJsonComments-eDrcJvBT.cjs +0 -23
- package/dist/packem_shared/to-uint-8-array-B4CjMOD3.mjs +0 -21
- package/dist/packem_shared/to-uint-8-array-BaTEyX3D.cjs +0 -23
- package/dist/packem_shared/walk-CI3ygmrw.cjs +0 -100
- package/dist/packem_shared/walk-D7YA43g8.mjs +0 -98
- package/dist/packem_shared/walk-include-CMUSRa86.mjs +0 -20
- package/dist/packem_shared/walk-include-yUdRrF16.cjs +0 -23
- package/dist/packem_shared/walkSync-DLTsnwuJ.mjs +0 -103
- package/dist/packem_shared/walkSync-oXkmn9ZA.cjs +0 -105
- package/dist/packem_shared/writeFile-BZ4JBQxc.mjs +0 -58
- package/dist/packem_shared/writeFile-DgCFRCe5.cjs +0 -60
- package/dist/packem_shared/writeFileSync-Ctw5pNQH.mjs +0 -58
- package/dist/packem_shared/writeFileSync-DzXhx1pF.cjs +0 -60
- package/dist/packem_shared/writeJson-Bh4sU1Ly.cjs +0 -33
- package/dist/packem_shared/writeJson-axO_14yL.mjs +0 -31
- package/dist/packem_shared/writeJsonSync-CzngmuKb.mjs +0 -31
- package/dist/packem_shared/writeJsonSync-HFdHjunl.cjs +0 -33
- package/dist/packem_shared/writeYaml-3XQT2qtb.cjs +0 -29
- package/dist/packem_shared/writeYaml-BSFEuWp2.mjs +0 -27
- package/dist/packem_shared/writeYamlSync-B6VcXXIb.mjs +0 -27
- package/dist/packem_shared/writeYamlSync-BZR3If9v.cjs +0 -29
package/README.md
CHANGED
|
@@ -463,7 +463,7 @@ The printable section of the JSON which produces the error.
|
|
|
463
463
|
function detect(content): "\n" | "\r\n";
|
|
464
464
|
```
|
|
465
465
|
|
|
466
|
-
Defined in: [packages/fs/src/eol.ts:29](https://github.com/visulima/visulima/blob/
|
|
466
|
+
Defined in: [packages/fs/src/eol.ts:29](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/eol.ts#L29)
|
|
467
467
|
|
|
468
468
|
Detect the EOL character for string input.
|
|
469
469
|
Returns null if no newline.
|
|
@@ -498,7 +498,7 @@ detect("HelloWorld"); // null
|
|
|
498
498
|
function format(content, eol): string;
|
|
499
499
|
```
|
|
500
500
|
|
|
501
|
-
Defined in: [packages/fs/src/eol.ts:54](https://github.com/visulima/visulima/blob/
|
|
501
|
+
Defined in: [packages/fs/src/eol.ts:54](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/eol.ts#L54)
|
|
502
502
|
|
|
503
503
|
Format the file to the targeted EOL.
|
|
504
504
|
|
|
@@ -537,7 +537,7 @@ format("Hello\nWorld\r\nWindows", CRLF); // "Hello\r\nWorld\r\nWindows"
|
|
|
537
537
|
const CRLF: "\r\n";
|
|
538
538
|
```
|
|
539
539
|
|
|
540
|
-
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/
|
|
540
|
+
Defined in: [packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/eol.ts#L9)
|
|
541
541
|
|
|
542
542
|
End-of-line character for Windows platforms.
|
|
543
543
|
|
|
@@ -549,7 +549,7 @@ End-of-line character for Windows platforms.
|
|
|
549
549
|
const EOL: "\n" | "\r\n";
|
|
550
550
|
```
|
|
551
551
|
|
|
552
|
-
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/
|
|
552
|
+
Defined in: [packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/eol.ts#L14)
|
|
553
553
|
|
|
554
554
|
End-of-line character evaluated for the current platform.
|
|
555
555
|
|
|
@@ -561,7 +561,7 @@ End-of-line character evaluated for the current platform.
|
|
|
561
561
|
const LF: "\n";
|
|
562
562
|
```
|
|
563
563
|
|
|
564
|
-
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/
|
|
564
|
+
Defined in: [packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/eol.ts#L6)
|
|
565
565
|
|
|
566
566
|
End-of-line character for POSIX platforms such as macOS and Linux.
|
|
567
567
|
# error
|
|
@@ -570,7 +570,7 @@ End-of-line character for POSIX platforms such as macOS and Linux.
|
|
|
570
570
|
|
|
571
571
|
### AlreadyExistsError
|
|
572
572
|
|
|
573
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:28](https://github.com/visulima/visulima/blob/
|
|
573
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:28](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/already-exists-error.ts#L28)
|
|
574
574
|
|
|
575
575
|
Error thrown when a file or directory already exists at a specified path, and an operation was expecting it not to.
|
|
576
576
|
|
|
@@ -612,7 +612,7 @@ try {
|
|
|
612
612
|
new AlreadyExistsError(message): AlreadyExistsError;
|
|
613
613
|
```
|
|
614
614
|
|
|
615
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:33](https://github.com/visulima/visulima/blob/
|
|
615
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:33](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/already-exists-error.ts#L33)
|
|
616
616
|
|
|
617
617
|
Creates a new instance.
|
|
618
618
|
|
|
@@ -644,7 +644,7 @@ Error.constructor
|
|
|
644
644
|
get code(): string;
|
|
645
645
|
```
|
|
646
646
|
|
|
647
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:38](https://github.com/visulima/visulima/blob/
|
|
647
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:38](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/already-exists-error.ts#L38)
|
|
648
648
|
|
|
649
649
|
###### Returns
|
|
650
650
|
|
|
@@ -656,7 +656,7 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:38](https://github.co
|
|
|
656
656
|
set code(_name): void;
|
|
657
657
|
```
|
|
658
658
|
|
|
659
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:43](https://github.com/visulima/visulima/blob/
|
|
659
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:43](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/already-exists-error.ts#L43)
|
|
660
660
|
|
|
661
661
|
###### Parameters
|
|
662
662
|
|
|
@@ -676,7 +676,7 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:43](https://github.co
|
|
|
676
676
|
get name(): string;
|
|
677
677
|
```
|
|
678
678
|
|
|
679
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:48](https://github.com/visulima/visulima/blob/
|
|
679
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:48](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/already-exists-error.ts#L48)
|
|
680
680
|
|
|
681
681
|
###### Returns
|
|
682
682
|
|
|
@@ -688,7 +688,7 @@ Defined in: [packages/fs/src/error/already-exists-error.ts:48](https://github.co
|
|
|
688
688
|
set name(_name): void;
|
|
689
689
|
```
|
|
690
690
|
|
|
691
|
-
Defined in: [packages/fs/src/error/already-exists-error.ts:53](https://github.com/visulima/visulima/blob/
|
|
691
|
+
Defined in: [packages/fs/src/error/already-exists-error.ts:53](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/already-exists-error.ts#L53)
|
|
692
692
|
|
|
693
693
|
###### Parameters
|
|
694
694
|
|
|
@@ -834,7 +834,7 @@ Error.stackTraceLimit
|
|
|
834
834
|
|
|
835
835
|
### DirectoryError
|
|
836
836
|
|
|
837
|
-
Defined in: [packages/fs/src/error/directory-error.ts:36](https://github.com/visulima/visulima/blob/
|
|
837
|
+
Defined in: [packages/fs/src/error/directory-error.ts:36](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/directory-error.ts#L36)
|
|
838
838
|
|
|
839
839
|
Error thrown when an operation that is not allowed on a directory is attempted.
|
|
840
840
|
This typically occurs when a file-specific operation is used on a directory path.
|
|
@@ -884,7 +884,7 @@ attemptToReadFileFromDir();
|
|
|
884
884
|
new DirectoryError(message): DirectoryError;
|
|
885
885
|
```
|
|
886
886
|
|
|
887
|
-
Defined in: [packages/fs/src/error/directory-error.ts:41](https://github.com/visulima/visulima/blob/
|
|
887
|
+
Defined in: [packages/fs/src/error/directory-error.ts:41](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/directory-error.ts#L41)
|
|
888
888
|
|
|
889
889
|
Creates a new instance.
|
|
890
890
|
|
|
@@ -916,7 +916,7 @@ Error.constructor
|
|
|
916
916
|
get code(): string;
|
|
917
917
|
```
|
|
918
918
|
|
|
919
|
-
Defined in: [packages/fs/src/error/directory-error.ts:46](https://github.com/visulima/visulima/blob/
|
|
919
|
+
Defined in: [packages/fs/src/error/directory-error.ts:46](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/directory-error.ts#L46)
|
|
920
920
|
|
|
921
921
|
###### Returns
|
|
922
922
|
|
|
@@ -928,7 +928,7 @@ Defined in: [packages/fs/src/error/directory-error.ts:46](https://github.com/vis
|
|
|
928
928
|
set code(_name): void;
|
|
929
929
|
```
|
|
930
930
|
|
|
931
|
-
Defined in: [packages/fs/src/error/directory-error.ts:51](https://github.com/visulima/visulima/blob/
|
|
931
|
+
Defined in: [packages/fs/src/error/directory-error.ts:51](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/directory-error.ts#L51)
|
|
932
932
|
|
|
933
933
|
###### Parameters
|
|
934
934
|
|
|
@@ -948,7 +948,7 @@ Defined in: [packages/fs/src/error/directory-error.ts:51](https://github.com/vis
|
|
|
948
948
|
get name(): string;
|
|
949
949
|
```
|
|
950
950
|
|
|
951
|
-
Defined in: [packages/fs/src/error/directory-error.ts:56](https://github.com/visulima/visulima/blob/
|
|
951
|
+
Defined in: [packages/fs/src/error/directory-error.ts:56](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/directory-error.ts#L56)
|
|
952
952
|
|
|
953
953
|
###### Returns
|
|
954
954
|
|
|
@@ -960,7 +960,7 @@ Defined in: [packages/fs/src/error/directory-error.ts:56](https://github.com/vis
|
|
|
960
960
|
set name(_name): void;
|
|
961
961
|
```
|
|
962
962
|
|
|
963
|
-
Defined in: [packages/fs/src/error/directory-error.ts:61](https://github.com/visulima/visulima/blob/
|
|
963
|
+
Defined in: [packages/fs/src/error/directory-error.ts:61](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/directory-error.ts#L61)
|
|
964
964
|
|
|
965
965
|
###### Parameters
|
|
966
966
|
|
|
@@ -1106,7 +1106,7 @@ Error.stackTraceLimit
|
|
|
1106
1106
|
|
|
1107
1107
|
### NotEmptyError
|
|
1108
1108
|
|
|
1109
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:40](https://github.com/visulima/visulima/blob/
|
|
1109
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:40](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-empty-error.ts#L40)
|
|
1110
1110
|
|
|
1111
1111
|
Error thrown when a directory is not empty.
|
|
1112
1112
|
|
|
@@ -1160,7 +1160,7 @@ attemptToRemoveNonEmptyDir();
|
|
|
1160
1160
|
new NotEmptyError(message): NotEmptyError;
|
|
1161
1161
|
```
|
|
1162
1162
|
|
|
1163
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:45](https://github.com/visulima/visulima/blob/
|
|
1163
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:45](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-empty-error.ts#L45)
|
|
1164
1164
|
|
|
1165
1165
|
Creates a new instance.
|
|
1166
1166
|
|
|
@@ -1192,7 +1192,7 @@ Error.constructor
|
|
|
1192
1192
|
get code(): string;
|
|
1193
1193
|
```
|
|
1194
1194
|
|
|
1195
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:50](https://github.com/visulima/visulima/blob/
|
|
1195
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:50](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-empty-error.ts#L50)
|
|
1196
1196
|
|
|
1197
1197
|
###### Returns
|
|
1198
1198
|
|
|
@@ -1204,7 +1204,7 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:50](https://github.com/vis
|
|
|
1204
1204
|
set code(_name): void;
|
|
1205
1205
|
```
|
|
1206
1206
|
|
|
1207
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:55](https://github.com/visulima/visulima/blob/
|
|
1207
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:55](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-empty-error.ts#L55)
|
|
1208
1208
|
|
|
1209
1209
|
###### Parameters
|
|
1210
1210
|
|
|
@@ -1224,7 +1224,7 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:55](https://github.com/vis
|
|
|
1224
1224
|
get name(): string;
|
|
1225
1225
|
```
|
|
1226
1226
|
|
|
1227
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:60](https://github.com/visulima/visulima/blob/
|
|
1227
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:60](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-empty-error.ts#L60)
|
|
1228
1228
|
|
|
1229
1229
|
###### Returns
|
|
1230
1230
|
|
|
@@ -1236,7 +1236,7 @@ Defined in: [packages/fs/src/error/not-empty-error.ts:60](https://github.com/vis
|
|
|
1236
1236
|
set name(_name): void;
|
|
1237
1237
|
```
|
|
1238
1238
|
|
|
1239
|
-
Defined in: [packages/fs/src/error/not-empty-error.ts:65](https://github.com/visulima/visulima/blob/
|
|
1239
|
+
Defined in: [packages/fs/src/error/not-empty-error.ts:65](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-empty-error.ts#L65)
|
|
1240
1240
|
|
|
1241
1241
|
###### Parameters
|
|
1242
1242
|
|
|
@@ -1382,7 +1382,7 @@ Error.stackTraceLimit
|
|
|
1382
1382
|
|
|
1383
1383
|
### NotFoundError
|
|
1384
1384
|
|
|
1385
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:33](https://github.com/visulima/visulima/blob/
|
|
1385
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:33](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-found-error.ts#L33)
|
|
1386
1386
|
|
|
1387
1387
|
Error thrown when a file or directory is not found at a specified path.
|
|
1388
1388
|
|
|
@@ -1429,7 +1429,7 @@ tryReadingNonExistentFile();
|
|
|
1429
1429
|
new NotFoundError(message): NotFoundError;
|
|
1430
1430
|
```
|
|
1431
1431
|
|
|
1432
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:38](https://github.com/visulima/visulima/blob/
|
|
1432
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:38](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-found-error.ts#L38)
|
|
1433
1433
|
|
|
1434
1434
|
Creates a new instance.
|
|
1435
1435
|
|
|
@@ -1461,7 +1461,7 @@ Error.constructor
|
|
|
1461
1461
|
get code(): string;
|
|
1462
1462
|
```
|
|
1463
1463
|
|
|
1464
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:43](https://github.com/visulima/visulima/blob/
|
|
1464
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:43](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-found-error.ts#L43)
|
|
1465
1465
|
|
|
1466
1466
|
###### Returns
|
|
1467
1467
|
|
|
@@ -1473,7 +1473,7 @@ Defined in: [packages/fs/src/error/not-found-error.ts:43](https://github.com/vis
|
|
|
1473
1473
|
set code(_name): void;
|
|
1474
1474
|
```
|
|
1475
1475
|
|
|
1476
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:48](https://github.com/visulima/visulima/blob/
|
|
1476
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:48](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-found-error.ts#L48)
|
|
1477
1477
|
|
|
1478
1478
|
###### Parameters
|
|
1479
1479
|
|
|
@@ -1493,7 +1493,7 @@ Defined in: [packages/fs/src/error/not-found-error.ts:48](https://github.com/vis
|
|
|
1493
1493
|
get name(): string;
|
|
1494
1494
|
```
|
|
1495
1495
|
|
|
1496
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:53](https://github.com/visulima/visulima/blob/
|
|
1496
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:53](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-found-error.ts#L53)
|
|
1497
1497
|
|
|
1498
1498
|
###### Returns
|
|
1499
1499
|
|
|
@@ -1505,7 +1505,7 @@ Defined in: [packages/fs/src/error/not-found-error.ts:53](https://github.com/vis
|
|
|
1505
1505
|
set name(_name): void;
|
|
1506
1506
|
```
|
|
1507
1507
|
|
|
1508
|
-
Defined in: [packages/fs/src/error/not-found-error.ts:58](https://github.com/visulima/visulima/blob/
|
|
1508
|
+
Defined in: [packages/fs/src/error/not-found-error.ts:58](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/not-found-error.ts#L58)
|
|
1509
1509
|
|
|
1510
1510
|
###### Parameters
|
|
1511
1511
|
|
|
@@ -1651,7 +1651,7 @@ Error.stackTraceLimit
|
|
|
1651
1651
|
|
|
1652
1652
|
### PermissionError
|
|
1653
1653
|
|
|
1654
|
-
Defined in: [packages/fs/src/error/permission-error.ts:34](https://github.com/visulima/visulima/blob/
|
|
1654
|
+
Defined in: [packages/fs/src/error/permission-error.ts:34](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/permission-error.ts#L34)
|
|
1655
1655
|
|
|
1656
1656
|
Error thrown when an operation is not permitted due to insufficient privileges
|
|
1657
1657
|
or other access control restrictions.
|
|
@@ -1699,7 +1699,7 @@ tryWritingToProtectedFile();
|
|
|
1699
1699
|
new PermissionError(message): PermissionError;
|
|
1700
1700
|
```
|
|
1701
1701
|
|
|
1702
|
-
Defined in: [packages/fs/src/error/permission-error.ts:39](https://github.com/visulima/visulima/blob/
|
|
1702
|
+
Defined in: [packages/fs/src/error/permission-error.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/permission-error.ts#L39)
|
|
1703
1703
|
|
|
1704
1704
|
Creates a new instance.
|
|
1705
1705
|
|
|
@@ -1731,7 +1731,7 @@ Error.constructor
|
|
|
1731
1731
|
get code(): string;
|
|
1732
1732
|
```
|
|
1733
1733
|
|
|
1734
|
-
Defined in: [packages/fs/src/error/permission-error.ts:44](https://github.com/visulima/visulima/blob/
|
|
1734
|
+
Defined in: [packages/fs/src/error/permission-error.ts:44](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/permission-error.ts#L44)
|
|
1735
1735
|
|
|
1736
1736
|
###### Returns
|
|
1737
1737
|
|
|
@@ -1743,7 +1743,7 @@ Defined in: [packages/fs/src/error/permission-error.ts:44](https://github.com/vi
|
|
|
1743
1743
|
set code(_name): void;
|
|
1744
1744
|
```
|
|
1745
1745
|
|
|
1746
|
-
Defined in: [packages/fs/src/error/permission-error.ts:49](https://github.com/visulima/visulima/blob/
|
|
1746
|
+
Defined in: [packages/fs/src/error/permission-error.ts:49](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/permission-error.ts#L49)
|
|
1747
1747
|
|
|
1748
1748
|
###### Parameters
|
|
1749
1749
|
|
|
@@ -1763,7 +1763,7 @@ Defined in: [packages/fs/src/error/permission-error.ts:49](https://github.com/vi
|
|
|
1763
1763
|
get name(): string;
|
|
1764
1764
|
```
|
|
1765
1765
|
|
|
1766
|
-
Defined in: [packages/fs/src/error/permission-error.ts:54](https://github.com/visulima/visulima/blob/
|
|
1766
|
+
Defined in: [packages/fs/src/error/permission-error.ts:54](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/permission-error.ts#L54)
|
|
1767
1767
|
|
|
1768
1768
|
###### Returns
|
|
1769
1769
|
|
|
@@ -1775,7 +1775,7 @@ Defined in: [packages/fs/src/error/permission-error.ts:54](https://github.com/vi
|
|
|
1775
1775
|
set name(_name): void;
|
|
1776
1776
|
```
|
|
1777
1777
|
|
|
1778
|
-
Defined in: [packages/fs/src/error/permission-error.ts:59](https://github.com/visulima/visulima/blob/
|
|
1778
|
+
Defined in: [packages/fs/src/error/permission-error.ts:59](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/permission-error.ts#L59)
|
|
1779
1779
|
|
|
1780
1780
|
###### Parameters
|
|
1781
1781
|
|
|
@@ -1921,7 +1921,7 @@ Error.stackTraceLimit
|
|
|
1921
1921
|
|
|
1922
1922
|
### WalkError
|
|
1923
1923
|
|
|
1924
|
-
Defined in: [packages/fs/src/error/walk-error.ts:43](https://github.com/visulima/visulima/blob/
|
|
1924
|
+
Defined in: [packages/fs/src/error/walk-error.ts:43](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/walk-error.ts#L43)
|
|
1925
1925
|
|
|
1926
1926
|
Error thrown in walk or walkSync during iteration.
|
|
1927
1927
|
|
|
@@ -1974,7 +1974,7 @@ processDirectory();
|
|
|
1974
1974
|
new WalkError(cause, root): WalkError;
|
|
1975
1975
|
```
|
|
1976
1976
|
|
|
1977
|
-
Defined in: [packages/fs/src/error/walk-error.ts:52](https://github.com/visulima/visulima/blob/
|
|
1977
|
+
Defined in: [packages/fs/src/error/walk-error.ts:52](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/walk-error.ts#L52)
|
|
1978
1978
|
|
|
1979
1979
|
Constructs a new instance.
|
|
1980
1980
|
|
|
@@ -2012,7 +2012,7 @@ Error.constructor
|
|
|
2012
2012
|
get name(): string;
|
|
2013
2013
|
```
|
|
2014
2014
|
|
|
2015
|
-
Defined in: [packages/fs/src/error/walk-error.ts:61](https://github.com/visulima/visulima/blob/
|
|
2015
|
+
Defined in: [packages/fs/src/error/walk-error.ts:61](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/walk-error.ts#L61)
|
|
2016
2016
|
|
|
2017
2017
|
###### Returns
|
|
2018
2018
|
|
|
@@ -2024,7 +2024,7 @@ Defined in: [packages/fs/src/error/walk-error.ts:61](https://github.com/visulima
|
|
|
2024
2024
|
set name(_name): void;
|
|
2025
2025
|
```
|
|
2026
2026
|
|
|
2027
|
-
Defined in: [packages/fs/src/error/walk-error.ts:66](https://github.com/visulima/visulima/blob/
|
|
2027
|
+
Defined in: [packages/fs/src/error/walk-error.ts:66](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/walk-error.ts#L66)
|
|
2028
2028
|
|
|
2029
2029
|
###### Parameters
|
|
2030
2030
|
|
|
@@ -2110,7 +2110,7 @@ Error.message
|
|
|
2110
2110
|
root: string;
|
|
2111
2111
|
```
|
|
2112
2112
|
|
|
2113
|
-
Defined in: [packages/fs/src/error/walk-error.ts:45](https://github.com/visulima/visulima/blob/
|
|
2113
|
+
Defined in: [packages/fs/src/error/walk-error.ts:45](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/walk-error.ts#L45)
|
|
2114
2114
|
|
|
2115
2115
|
File path of the root that's being walked.
|
|
2116
2116
|
|
|
@@ -2191,7 +2191,7 @@ Re-exports [JSONError](utils.md#jsonerror)
|
|
|
2191
2191
|
function collect(directory, options): Promise<string[]>;
|
|
2192
2192
|
```
|
|
2193
2193
|
|
|
2194
|
-
Defined in: [packages/fs/src/find/collect.ts:37](https://github.com/visulima/visulima/blob/
|
|
2194
|
+
Defined in: [packages/fs/src/find/collect.ts:37](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/find/collect.ts#L37)
|
|
2195
2195
|
|
|
2196
2196
|
Asynchronously collects all file paths within a directory that match the specified criteria.
|
|
2197
2197
|
By default, it searches for JavaScript and TypeScript file extensions.
|
|
@@ -2251,7 +2251,7 @@ collectFiles();
|
|
|
2251
2251
|
function collectSync(directory, options): string[];
|
|
2252
2252
|
```
|
|
2253
2253
|
|
|
2254
|
-
Defined in: [packages/fs/src/find/collect-sync.ts:33](https://github.com/visulima/visulima/blob/
|
|
2254
|
+
Defined in: [packages/fs/src/find/collect-sync.ts:33](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/find/collect-sync.ts#L33)
|
|
2255
2255
|
|
|
2256
2256
|
Synchronously collects all file paths within a directory that match the specified criteria.
|
|
2257
2257
|
By default, it searches for JavaScript and TypeScript file extensions.
|
|
@@ -2307,7 +2307,7 @@ console.log(jsFiles);
|
|
|
2307
2307
|
function emptyDir(dir, options?): Promise<void>;
|
|
2308
2308
|
```
|
|
2309
2309
|
|
|
2310
|
-
Defined in: [packages/fs/src/remove/empty-dir.ts:
|
|
2310
|
+
Defined in: [packages/fs/src/remove/empty-dir.ts:37](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/remove/empty-dir.ts#L37)
|
|
2311
2311
|
|
|
2312
2312
|
Ensures that a directory is empty.
|
|
2313
2313
|
Deletes directory contents if the directory is not empty.
|
|
@@ -2360,7 +2360,7 @@ clearTempDir();
|
|
|
2360
2360
|
function emptyDirSync(dir, options?): void;
|
|
2361
2361
|
```
|
|
2362
2362
|
|
|
2363
|
-
Defined in: [packages/fs/src/remove/empty-dir-sync.ts:
|
|
2363
|
+
Defined in: [packages/fs/src/remove/empty-dir-sync.ts:32](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/remove/empty-dir-sync.ts#L32)
|
|
2364
2364
|
|
|
2365
2365
|
Ensures that a directory is empty.
|
|
2366
2366
|
Deletes directory contents if the directory is not empty.
|
|
@@ -2409,7 +2409,7 @@ try {
|
|
|
2409
2409
|
function ensureDir(directory): Promise<void>;
|
|
2410
2410
|
```
|
|
2411
2411
|
|
|
2412
|
-
Defined in: [packages/fs/src/ensure/ensure-dir.ts:20](https://github.com/visulima/visulima/blob/
|
|
2412
|
+
Defined in: [packages/fs/src/ensure/ensure-dir.ts:20](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-dir.ts#L20)
|
|
2413
2413
|
|
|
2414
2414
|
Ensures that the directory exists.
|
|
2415
2415
|
If the directory structure does not exist, it is created. Like mkdir -p.
|
|
@@ -2443,7 +2443,7 @@ await ensureDir("/tmp/foo/bar/baz");
|
|
|
2443
2443
|
function ensureDirSync(directory): void;
|
|
2444
2444
|
```
|
|
2445
2445
|
|
|
2446
|
-
Defined in: [packages/fs/src/ensure/ensure-dir-sync.ts:20](https://github.com/visulima/visulima/blob/
|
|
2446
|
+
Defined in: [packages/fs/src/ensure/ensure-dir-sync.ts:20](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-dir-sync.ts#L20)
|
|
2447
2447
|
|
|
2448
2448
|
Ensures that the directory exists.
|
|
2449
2449
|
If the directory structure does not exist, it is created. Like mkdir -p.
|
|
@@ -2477,7 +2477,7 @@ ensureDirSync("/tmp/foo/bar/baz");
|
|
|
2477
2477
|
function ensureFile(filePath): Promise<void>;
|
|
2478
2478
|
```
|
|
2479
2479
|
|
|
2480
|
-
Defined in: [packages/fs/src/ensure/ensure-file.ts:37](https://github.com/visulima/visulima/blob/
|
|
2480
|
+
Defined in: [packages/fs/src/ensure/ensure-file.ts:37](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-file.ts#L37)
|
|
2481
2481
|
|
|
2482
2482
|
Asynchronously ensures that a file exists.
|
|
2483
2483
|
If the directory structure for the file does not exist, it is created.
|
|
@@ -2531,7 +2531,7 @@ import { ensureFile } from "@visulima/fs";
|
|
|
2531
2531
|
function ensureFileSync(filePath): void;
|
|
2532
2532
|
```
|
|
2533
2533
|
|
|
2534
|
-
Defined in: [packages/fs/src/ensure/ensure-file-sync.ts:24](https://github.com/visulima/visulima/blob/
|
|
2534
|
+
Defined in: [packages/fs/src/ensure/ensure-file-sync.ts:24](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-file-sync.ts#L24)
|
|
2535
2535
|
|
|
2536
2536
|
Ensures that the file exists.
|
|
2537
2537
|
If the file that is requested to be created is in directories that do not exist,
|
|
@@ -2566,7 +2566,7 @@ ensureFileSync("/tmp/foo/bar/baz.txt");
|
|
|
2566
2566
|
function ensureLink(source, destination): Promise<void>;
|
|
2567
2567
|
```
|
|
2568
2568
|
|
|
2569
|
-
Defined in: [packages/fs/src/ensure/ensure-link.ts:25](https://github.com/visulima/visulima/blob/
|
|
2569
|
+
Defined in: [packages/fs/src/ensure/ensure-link.ts:25](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-link.ts#L25)
|
|
2570
2570
|
|
|
2571
2571
|
Ensures that the hard link exists.
|
|
2572
2572
|
If the directory structure does not exist, it is created.
|
|
@@ -2607,7 +2607,7 @@ await ensureLink(join("/tmp", "foo", "bar.txt"), join("/tmp", "foo", "bar-link.t
|
|
|
2607
2607
|
function ensureLinkSync(source, destination): void;
|
|
2608
2608
|
```
|
|
2609
2609
|
|
|
2610
|
-
Defined in: [packages/fs/src/ensure/ensure-link-sync.ts:25](https://github.com/visulima/visulima/blob/
|
|
2610
|
+
Defined in: [packages/fs/src/ensure/ensure-link-sync.ts:25](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-link-sync.ts#L25)
|
|
2611
2611
|
|
|
2612
2612
|
Ensures that the hard link exists.
|
|
2613
2613
|
If the directory structure does not exist, it is created.
|
|
@@ -2651,7 +2651,7 @@ function ensureSymlink(
|
|
|
2651
2651
|
type?): Promise<void>;
|
|
2652
2652
|
```
|
|
2653
2653
|
|
|
2654
|
-
Defined in: [packages/fs/src/ensure/ensure-symlink.ts:39](https://github.com/visulima/visulima/blob/
|
|
2654
|
+
Defined in: [packages/fs/src/ensure/ensure-symlink.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-symlink.ts#L39)
|
|
2655
2655
|
|
|
2656
2656
|
Ensures that the link exists, and points to a valid file.
|
|
2657
2657
|
If the directory structure does not exist, it is created.
|
|
@@ -2707,7 +2707,7 @@ function ensureSymlinkSync(
|
|
|
2707
2707
|
type?): void;
|
|
2708
2708
|
```
|
|
2709
2709
|
|
|
2710
|
-
Defined in: [packages/fs/src/ensure/ensure-symlink-sync.ts:39](https://github.com/visulima/visulima/blob/
|
|
2710
|
+
Defined in: [packages/fs/src/ensure/ensure-symlink-sync.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/ensure/ensure-symlink-sync.ts#L39)
|
|
2711
2711
|
|
|
2712
2712
|
Ensures that the link exists, and points to a valid file.
|
|
2713
2713
|
If the directory structure does not exist, it is created.
|
|
@@ -2760,7 +2760,7 @@ ensureSymlinkSync(join("/tmp", "foo", "baz-dir"), join("/tmp", "foo", "link-to-b
|
|
|
2760
2760
|
function findUp(name, options): Promise<string>;
|
|
2761
2761
|
```
|
|
2762
2762
|
|
|
2763
|
-
Defined in: [packages/fs/src/find/find-up.ts:55](https://github.com/visulima/visulima/blob/
|
|
2763
|
+
Defined in: [packages/fs/src/find/find-up.ts:55](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/find/find-up.ts#L55)
|
|
2764
2764
|
|
|
2765
2765
|
Asynchronously finds a file or directory by walking up parent directories.
|
|
2766
2766
|
|
|
@@ -2831,7 +2831,7 @@ findProjectRoot();
|
|
|
2831
2831
|
function findUpSync(name, options): string;
|
|
2832
2832
|
```
|
|
2833
2833
|
|
|
2834
|
-
Defined in: [packages/fs/src/find/find-up-sync.ts:51](https://github.com/visulima/visulima/blob/
|
|
2834
|
+
Defined in: [packages/fs/src/find/find-up-sync.ts:51](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/find/find-up-sync.ts#L51)
|
|
2835
2835
|
|
|
2836
2836
|
Synchronously finds a file or directory by walking up parent directories.
|
|
2837
2837
|
|
|
@@ -2898,7 +2898,7 @@ console.log(customFound);
|
|
|
2898
2898
|
function isAccessible(path, mode?): Promise<boolean>;
|
|
2899
2899
|
```
|
|
2900
2900
|
|
|
2901
|
-
Defined in: [packages/fs/src/is-accessible.ts:36](https://github.com/visulima/visulima/blob/
|
|
2901
|
+
Defined in: [packages/fs/src/is-accessible.ts:36](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/is-accessible.ts#L36)
|
|
2902
2902
|
|
|
2903
2903
|
Asynchronously tests a user's permissions for the file or directory specified by path.
|
|
2904
2904
|
Returns a Promise that resolves to `true` if the accessibility check is successful, `false` otherwise.
|
|
@@ -2953,7 +2953,7 @@ import { isAccessible, F_OK, R_OK } from "@visulima/fs";
|
|
|
2953
2953
|
function isAccessibleSync(path, mode?): boolean;
|
|
2954
2954
|
```
|
|
2955
2955
|
|
|
2956
|
-
Defined in: [packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/
|
|
2956
|
+
Defined in: [packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/is-accessible-sync.ts#L9)
|
|
2957
2957
|
|
|
2958
2958
|
Synchronously tests a user's permissions for the file or directory specified by `path`.
|
|
2959
2959
|
If the accessibility check is successful, `true` is returned. Otherwise, `false` is returned.
|
|
@@ -3030,7 +3030,7 @@ function move(
|
|
|
3030
3030
|
options): Promise<void>;
|
|
3031
3031
|
```
|
|
3032
3032
|
|
|
3033
|
-
Defined in: [packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/
|
|
3033
|
+
Defined in: [packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/index.ts#L35)
|
|
3034
3034
|
|
|
3035
3035
|
Move a file asynchronously.
|
|
3036
3036
|
|
|
@@ -3080,7 +3080,7 @@ function moveSync(
|
|
|
3080
3080
|
options?): void;
|
|
3081
3081
|
```
|
|
3082
3082
|
|
|
3083
|
-
Defined in: [packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/
|
|
3083
|
+
Defined in: [packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/index.ts#L61)
|
|
3084
3084
|
|
|
3085
3085
|
Move a file synchronously.
|
|
3086
3086
|
|
|
@@ -3127,7 +3127,7 @@ console.log('The file has been moved');
|
|
|
3127
3127
|
function readFile<O>(path, options?): Promise<ContentType<O>>;
|
|
3128
3128
|
```
|
|
3129
3129
|
|
|
3130
|
-
Defined in: [packages/fs/src/read/read-file.ts:57](https://github.com/visulima/visulima/blob/
|
|
3130
|
+
Defined in: [packages/fs/src/read/read-file.ts:57](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-file.ts#L57)
|
|
3131
3131
|
|
|
3132
3132
|
Asynchronously reads the entire contents of a file.
|
|
3133
3133
|
It can also decompress the file content if a `compression` option is provided.
|
|
@@ -3198,7 +3198,7 @@ readMyFile();
|
|
|
3198
3198
|
function readFileSync<O>(path, options?): ContentType<O>;
|
|
3199
3199
|
```
|
|
3200
3200
|
|
|
3201
|
-
Defined in: [packages/fs/src/read/read-file-sync.ts:51](https://github.com/visulima/visulima/blob/
|
|
3201
|
+
Defined in: [packages/fs/src/read/read-file-sync.ts:51](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-file-sync.ts#L51)
|
|
3202
3202
|
|
|
3203
3203
|
Synchronously reads the entire contents of a file.
|
|
3204
3204
|
It can also decompress the file content if a `compression` option is provided.
|
|
@@ -3317,7 +3317,7 @@ readMyJson();
|
|
|
3317
3317
|
function readJson<T>(path, options?): Promise<T>;
|
|
3318
3318
|
```
|
|
3319
3319
|
|
|
3320
|
-
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/
|
|
3320
|
+
Defined in: [packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-json.ts#L8)
|
|
3321
3321
|
|
|
3322
3322
|
##### Type Parameters
|
|
3323
3323
|
|
|
@@ -3348,7 +3348,7 @@ function readJson<T>(
|
|
|
3348
3348
|
options?): Promise<T>;
|
|
3349
3349
|
```
|
|
3350
3350
|
|
|
3351
|
-
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/
|
|
3351
|
+
Defined in: [packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-json.ts#L10)
|
|
3352
3352
|
|
|
3353
3353
|
##### Type Parameters
|
|
3354
3354
|
|
|
@@ -3430,7 +3430,7 @@ try {
|
|
|
3430
3430
|
function readJsonSync<T>(path, options?): T;
|
|
3431
3431
|
```
|
|
3432
3432
|
|
|
3433
|
-
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/
|
|
3433
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-json-sync.ts#L8)
|
|
3434
3434
|
|
|
3435
3435
|
##### Type Parameters
|
|
3436
3436
|
|
|
@@ -3461,7 +3461,7 @@ function readJsonSync<T>(
|
|
|
3461
3461
|
options?): T;
|
|
3462
3462
|
```
|
|
3463
3463
|
|
|
3464
|
-
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
3464
|
+
Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-json-sync.ts#L10)
|
|
3465
3465
|
|
|
3466
3466
|
##### Type Parameters
|
|
3467
3467
|
|
|
@@ -3495,7 +3495,7 @@ Defined in: [packages/fs/src/read/read-json-sync.ts:10](https://github.com/visul
|
|
|
3495
3495
|
function remove(path, options): Promise<void>;
|
|
3496
3496
|
```
|
|
3497
3497
|
|
|
3498
|
-
Defined in: [packages/fs/src/remove/remove.ts:36](https://github.com/visulima/visulima/blob/
|
|
3498
|
+
Defined in: [packages/fs/src/remove/remove.ts:36](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/remove/remove.ts#L36)
|
|
3499
3499
|
|
|
3500
3500
|
Asynchronously removes a file or directory (recursively).
|
|
3501
3501
|
If the path does not exist, it does nothing.
|
|
@@ -3552,7 +3552,7 @@ deleteFileOrDir();
|
|
|
3552
3552
|
function removeSync(path, options): void;
|
|
3553
3553
|
```
|
|
3554
3554
|
|
|
3555
|
-
Defined in: [packages/fs/src/remove/remove-sync.ts:32](https://github.com/visulima/visulima/blob/
|
|
3555
|
+
Defined in: [packages/fs/src/remove/remove-sync.ts:32](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/remove/remove-sync.ts#L32)
|
|
3556
3556
|
|
|
3557
3557
|
Synchronously removes a file or directory (recursively).
|
|
3558
3558
|
If the path does not exist, it does nothing.
|
|
@@ -3608,7 +3608,7 @@ function rename(
|
|
|
3608
3608
|
options?): Promise<void>;
|
|
3609
3609
|
```
|
|
3610
3610
|
|
|
3611
|
-
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/
|
|
3611
|
+
Defined in: [packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/index.ts#L85)
|
|
3612
3612
|
|
|
3613
3613
|
Rename a file asynchronously.
|
|
3614
3614
|
|
|
@@ -3658,7 +3658,7 @@ function renameSync(
|
|
|
3658
3658
|
options?): void;
|
|
3659
3659
|
```
|
|
3660
3660
|
|
|
3661
|
-
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/
|
|
3661
|
+
Defined in: [packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/index.ts#L109)
|
|
3662
3662
|
|
|
3663
3663
|
Rename a file synchronously.
|
|
3664
3664
|
|
|
@@ -3705,7 +3705,7 @@ console.log('The file has been renamed');
|
|
|
3705
3705
|
function walk(directory, options): AsyncIterableIterator<WalkEntry>;
|
|
3706
3706
|
```
|
|
3707
3707
|
|
|
3708
|
-
Defined in: [packages/fs/src/find/walk.ts:64](https://github.com/visulima/visulima/blob/
|
|
3708
|
+
Defined in: [packages/fs/src/find/walk.ts:64](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/find/walk.ts#L64)
|
|
3709
3709
|
|
|
3710
3710
|
Asynchronously walks the file tree rooted at `directory`, yielding each file or directory that matches the criteria specified in `options`.
|
|
3711
3711
|
|
|
@@ -3760,7 +3760,7 @@ printEntries();
|
|
|
3760
3760
|
function walkSync(directory, options): IterableIterator<WalkEntry>;
|
|
3761
3761
|
```
|
|
3762
3762
|
|
|
3763
|
-
Defined in: [packages/fs/src/find/walk-sync.ts:64](https://github.com/visulima/visulima/blob/
|
|
3763
|
+
Defined in: [packages/fs/src/find/walk-sync.ts:64](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/find/walk-sync.ts#L64)
|
|
3764
3764
|
|
|
3765
3765
|
Synchronously walks the file tree rooted at `directory`, yielding each file or directory that matches the criteria specified in `options`.
|
|
3766
3766
|
This is the synchronous version of the [walk](#walk) function.
|
|
@@ -3815,7 +3815,7 @@ function writeFile(
|
|
|
3815
3815
|
options?): Promise<void>;
|
|
3816
3816
|
```
|
|
3817
3817
|
|
|
3818
|
-
Defined in: [packages/fs/src/write/write-file.ts:43](https://github.com/visulima/visulima/blob/
|
|
3818
|
+
Defined in: [packages/fs/src/write/write-file.ts:43](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-file.ts#L43)
|
|
3819
3819
|
|
|
3820
3820
|
Asynchronously writes data to a file, replacing the file if it already exists.
|
|
3821
3821
|
This function includes safeguards like writing to a temporary file first and then renaming, and handling permissions.
|
|
@@ -3878,7 +3878,7 @@ function writeFileSync(
|
|
|
3878
3878
|
options?): void;
|
|
3879
3879
|
```
|
|
3880
3880
|
|
|
3881
|
-
Defined in: [packages/fs/src/write/write-file-sync.ts:43](https://github.com/visulima/visulima/blob/
|
|
3881
|
+
Defined in: [packages/fs/src/write/write-file-sync.ts:43](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-file-sync.ts#L43)
|
|
3882
3882
|
|
|
3883
3883
|
Synchronously writes data to a file, replacing the file if it already exists.
|
|
3884
3884
|
This function includes safeguards like writing to a temporary file first and then renaming, and handling permissions.
|
|
@@ -3941,7 +3941,7 @@ function writeJson(
|
|
|
3941
3941
|
options): Promise<void>;
|
|
3942
3942
|
```
|
|
3943
3943
|
|
|
3944
|
-
Defined in: [packages/fs/src/write/write-json.ts:39](https://github.com/visulima/visulima/blob/
|
|
3944
|
+
Defined in: [packages/fs/src/write/write-json.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-json.ts#L39)
|
|
3945
3945
|
|
|
3946
3946
|
Asynchronously writes an object to a JSON file.
|
|
3947
3947
|
Handles indentation detection, custom stringifiers, and gracefully manages existing files.
|
|
@@ -4004,7 +4004,7 @@ function writeJsonSync(
|
|
|
4004
4004
|
options): void;
|
|
4005
4005
|
```
|
|
4006
4006
|
|
|
4007
|
-
Defined in: [packages/fs/src/write/write-json-sync.ts:39](https://github.com/visulima/visulima/blob/
|
|
4007
|
+
Defined in: [packages/fs/src/write/write-json-sync.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-json-sync.ts#L39)
|
|
4008
4008
|
|
|
4009
4009
|
Synchronously writes an object to a JSON file.
|
|
4010
4010
|
Handles indentation detection, custom stringifiers, and gracefully manages existing files.
|
|
@@ -4064,7 +4064,7 @@ writeMyJsonSync();
|
|
|
4064
4064
|
const F_OK: 0 = 0;
|
|
4065
4065
|
```
|
|
4066
4066
|
|
|
4067
|
-
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/
|
|
4067
|
+
Defined in: [packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/constants.ts#L5)
|
|
4068
4068
|
|
|
4069
4069
|
Constant to check if the path is visible to the calling process.
|
|
4070
4070
|
Corresponds to `node:fs.constants.F_OK`.
|
|
@@ -4077,7 +4077,7 @@ Corresponds to `node:fs.constants.F_OK`.
|
|
|
4077
4077
|
const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
4078
4078
|
```
|
|
4079
4079
|
|
|
4080
|
-
Defined in: [packages/fs/src/constants.ts:29](https://github.com/visulima/visulima/blob/
|
|
4080
|
+
Defined in: [packages/fs/src/constants.ts:29](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/constants.ts#L29)
|
|
4081
4081
|
|
|
4082
4082
|
A special symbol that can be returned by the matcher function in `findUp` or `findUpSync`
|
|
4083
4083
|
to stop the search process prematurely.
|
|
@@ -4090,7 +4090,7 @@ to stop the search process prematurely.
|
|
|
4090
4090
|
const R_OK: 4 = 4;
|
|
4091
4091
|
```
|
|
4092
4092
|
|
|
4093
|
-
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/
|
|
4093
|
+
Defined in: [packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/constants.ts#L11)
|
|
4094
4094
|
|
|
4095
4095
|
Constant to check if the path is readable to the calling process.
|
|
4096
4096
|
Corresponds to `node:fs.constants.R_OK`.
|
|
@@ -4103,7 +4103,7 @@ Corresponds to `node:fs.constants.R_OK`.
|
|
|
4103
4103
|
const W_OK: 2 = 2;
|
|
4104
4104
|
```
|
|
4105
4105
|
|
|
4106
|
-
Defined in: [packages/fs/src/constants.ts:17](https://github.com/visulima/visulima/blob/
|
|
4106
|
+
Defined in: [packages/fs/src/constants.ts:17](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/constants.ts#L17)
|
|
4107
4107
|
|
|
4108
4108
|
Constant to check if the path is writable to the calling process.
|
|
4109
4109
|
Corresponds to `node:fs.constants.W_OK`.
|
|
@@ -4116,7 +4116,7 @@ Corresponds to `node:fs.constants.W_OK`.
|
|
|
4116
4116
|
const X_OK: 1 = 1;
|
|
4117
4117
|
```
|
|
4118
4118
|
|
|
4119
|
-
Defined in: [packages/fs/src/constants.ts:23](https://github.com/visulima/visulima/blob/
|
|
4119
|
+
Defined in: [packages/fs/src/constants.ts:23](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/constants.ts#L23)
|
|
4120
4120
|
|
|
4121
4121
|
Constant to check if the path is executable by the calling process.
|
|
4122
4122
|
Corresponds to `node:fs.constants.X_OK`.
|
|
@@ -4125,7 +4125,7 @@ Corresponds to `node:fs.constants.X_OK`.
|
|
|
4125
4125
|
|
|
4126
4126
|
### WalkEntry
|
|
4127
4127
|
|
|
4128
|
-
Defined in: [packages/fs/src/types.ts:62](https://github.com/visulima/visulima/blob/
|
|
4128
|
+
Defined in: [packages/fs/src/types.ts:62](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L62)
|
|
4129
4129
|
|
|
4130
4130
|
Represents an entry found by `walk` or `walkSync`.
|
|
4131
4131
|
|
|
@@ -4237,7 +4237,7 @@ Pick.name
|
|
|
4237
4237
|
path: string;
|
|
4238
4238
|
```
|
|
4239
4239
|
|
|
4240
|
-
Defined in: [packages/fs/src/types.ts:64](https://github.com/visulima/visulima/blob/
|
|
4240
|
+
Defined in: [packages/fs/src/types.ts:64](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L64)
|
|
4241
4241
|
|
|
4242
4242
|
The full path to the entry.
|
|
4243
4243
|
|
|
@@ -4245,7 +4245,7 @@ The full path to the entry.
|
|
|
4245
4245
|
|
|
4246
4246
|
### WalkOptions
|
|
4247
4247
|
|
|
4248
|
-
Defined in: [packages/fs/src/types.ts:12](https://github.com/visulima/visulima/blob/
|
|
4248
|
+
Defined in: [packages/fs/src/types.ts:12](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L12)
|
|
4249
4249
|
|
|
4250
4250
|
Options for the `walk` and `walkSync` functions.
|
|
4251
4251
|
|
|
@@ -4257,7 +4257,7 @@ Options for the `walk` and `walkSync` functions.
|
|
|
4257
4257
|
optional extensions: string[];
|
|
4258
4258
|
```
|
|
4259
4259
|
|
|
4260
|
-
Defined in: [packages/fs/src/types.ts:18](https://github.com/visulima/visulima/blob/
|
|
4260
|
+
Defined in: [packages/fs/src/types.ts:18](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L18)
|
|
4261
4261
|
|
|
4262
4262
|
List of file extensions used to filter entries.
|
|
4263
4263
|
If specified, entries without the file extension specified by this option are excluded.
|
|
@@ -4274,7 +4274,7 @@ If specified, entries without the file extension specified by this option are ex
|
|
|
4274
4274
|
optional followSymlinks: boolean;
|
|
4275
4275
|
```
|
|
4276
4276
|
|
|
4277
|
-
Defined in: [packages/fs/src/types.ts:23](https://github.com/visulima/visulima/blob/
|
|
4277
|
+
Defined in: [packages/fs/src/types.ts:23](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L23)
|
|
4278
4278
|
|
|
4279
4279
|
Indicates whether symlinks should be resolved or not.
|
|
4280
4280
|
|
|
@@ -4290,7 +4290,7 @@ Indicates whether symlinks should be resolved or not.
|
|
|
4290
4290
|
optional includeDirs: boolean;
|
|
4291
4291
|
```
|
|
4292
4292
|
|
|
4293
|
-
Defined in: [packages/fs/src/types.ts:28](https://github.com/visulima/visulima/blob/
|
|
4293
|
+
Defined in: [packages/fs/src/types.ts:28](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L28)
|
|
4294
4294
|
|
|
4295
4295
|
Indicates whether directory entries should be included or not.
|
|
4296
4296
|
|
|
@@ -4306,7 +4306,7 @@ Indicates whether directory entries should be included or not.
|
|
|
4306
4306
|
optional includeFiles: boolean;
|
|
4307
4307
|
```
|
|
4308
4308
|
|
|
4309
|
-
Defined in: [packages/fs/src/types.ts:33](https://github.com/visulima/visulima/blob/
|
|
4309
|
+
Defined in: [packages/fs/src/types.ts:33](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L33)
|
|
4310
4310
|
|
|
4311
4311
|
Indicates whether file entries should be included or not.
|
|
4312
4312
|
|
|
@@ -4322,7 +4322,7 @@ Indicates whether file entries should be included or not.
|
|
|
4322
4322
|
optional includeSymlinks: boolean;
|
|
4323
4323
|
```
|
|
4324
4324
|
|
|
4325
|
-
Defined in: [packages/fs/src/types.ts:39](https://github.com/visulima/visulima/blob/
|
|
4325
|
+
Defined in: [packages/fs/src/types.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L39)
|
|
4326
4326
|
|
|
4327
4327
|
Indicates whether symlink entries should be included or not.
|
|
4328
4328
|
This option is meaningful only if `followSymlinks` is set to `false`.
|
|
@@ -4339,7 +4339,7 @@ This option is meaningful only if `followSymlinks` is set to `false`.
|
|
|
4339
4339
|
optional match: (string | RegExp)[];
|
|
4340
4340
|
```
|
|
4341
4341
|
|
|
4342
|
-
Defined in: [packages/fs/src/types.ts:45](https://github.com/visulima/visulima/blob/
|
|
4342
|
+
Defined in: [packages/fs/src/types.ts:45](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L45)
|
|
4343
4343
|
|
|
4344
4344
|
List of regular expression or glob patterns used to filter entries.
|
|
4345
4345
|
If specified, entries that do not match the patterns specified by this option are excluded.
|
|
@@ -4356,7 +4356,7 @@ If specified, entries that do not match the patterns specified by this option ar
|
|
|
4356
4356
|
optional maxDepth: number;
|
|
4357
4357
|
```
|
|
4358
4358
|
|
|
4359
|
-
Defined in: [packages/fs/src/types.ts:50](https://github.com/visulima/visulima/blob/
|
|
4359
|
+
Defined in: [packages/fs/src/types.ts:50](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L50)
|
|
4360
4360
|
|
|
4361
4361
|
The maximum depth of the file tree to be walked recursively.
|
|
4362
4362
|
|
|
@@ -4372,7 +4372,7 @@ The maximum depth of the file tree to be walked recursively.
|
|
|
4372
4372
|
optional skip: (string | RegExp)[];
|
|
4373
4373
|
```
|
|
4374
4374
|
|
|
4375
|
-
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/
|
|
4375
|
+
Defined in: [packages/fs/src/types.ts:56](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L56)
|
|
4376
4376
|
|
|
4377
4377
|
List of regular expression or glob patterns used to filter entries.
|
|
4378
4378
|
If specified, entries matching the patterns specified by this option are excluded.
|
|
@@ -4391,7 +4391,7 @@ If specified, entries matching the patterns specified by this option are exclude
|
|
|
4391
4391
|
type CodeFrameLocation = object;
|
|
4392
4392
|
```
|
|
4393
4393
|
|
|
4394
|
-
Defined in: [packages/fs/src/types.ts:117](https://github.com/visulima/visulima/blob/
|
|
4394
|
+
Defined in: [packages/fs/src/types.ts:117](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L117)
|
|
4395
4395
|
|
|
4396
4396
|
Specifies a location (line and column) in a file for code frame generation.
|
|
4397
4397
|
|
|
@@ -4403,7 +4403,7 @@ Specifies a location (line and column) in a file for code frame generation.
|
|
|
4403
4403
|
optional column: number;
|
|
4404
4404
|
```
|
|
4405
4405
|
|
|
4406
|
-
Defined in: [packages/fs/src/types.ts:119](https://github.com/visulima/visulima/blob/
|
|
4406
|
+
Defined in: [packages/fs/src/types.ts:119](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L119)
|
|
4407
4407
|
|
|
4408
4408
|
The column number.
|
|
4409
4409
|
|
|
@@ -4413,7 +4413,7 @@ The column number.
|
|
|
4413
4413
|
line: number;
|
|
4414
4414
|
```
|
|
4415
4415
|
|
|
4416
|
-
Defined in: [packages/fs/src/types.ts:121](https://github.com/visulima/visulima/blob/
|
|
4416
|
+
Defined in: [packages/fs/src/types.ts:121](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L121)
|
|
4417
4417
|
|
|
4418
4418
|
The line number.
|
|
4419
4419
|
|
|
@@ -4425,7 +4425,7 @@ The line number.
|
|
|
4425
4425
|
type CodeFrameOptions = object;
|
|
4426
4426
|
```
|
|
4427
4427
|
|
|
4428
|
-
Defined in: [packages/fs/src/types.ts:127](https://github.com/visulima/visulima/blob/
|
|
4428
|
+
Defined in: [packages/fs/src/types.ts:127](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L127)
|
|
4429
4429
|
|
|
4430
4430
|
Options for customizing the appearance of code frames.
|
|
4431
4431
|
|
|
@@ -4437,7 +4437,7 @@ Options for customizing the appearance of code frames.
|
|
|
4437
4437
|
optional color: object;
|
|
4438
4438
|
```
|
|
4439
4439
|
|
|
4440
|
-
Defined in: [packages/fs/src/types.ts:129](https://github.com/visulima/visulima/blob/
|
|
4440
|
+
Defined in: [packages/fs/src/types.ts:129](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L129)
|
|
4441
4441
|
|
|
4442
4442
|
Colorization methods for different parts of the code frame.
|
|
4443
4443
|
|
|
@@ -4473,7 +4473,7 @@ Color for the message.
|
|
|
4473
4473
|
type ContentType<O> = O extends object ? Buffer : string;
|
|
4474
4474
|
```
|
|
4475
4475
|
|
|
4476
|
-
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/
|
|
4476
|
+
Defined in: [packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L104)
|
|
4477
4477
|
|
|
4478
4478
|
Represents the content type of a read file, which can be a Buffer or a string based on options.
|
|
4479
4479
|
|
|
@@ -4496,7 +4496,7 @@ type FindUpName =
|
|
|
4496
4496
|
| (directory) => FindUpNameFnResult;
|
|
4497
4497
|
```
|
|
4498
4498
|
|
|
4499
|
-
Defined in: [packages/fs/src/types.ts:270](https://github.com/visulima/visulima/blob/
|
|
4499
|
+
Defined in: [packages/fs/src/types.ts:270](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L270)
|
|
4500
4500
|
|
|
4501
4501
|
Specifies the name(s) of the file or directory to search for in `findUp`.
|
|
4502
4502
|
Can be a single name, an array of names, or a function that returns a name or `FIND_UP_STOP`.
|
|
@@ -4513,7 +4513,7 @@ type FindUpNameFnResult =
|
|
|
4513
4513
|
| undefined;
|
|
4514
4514
|
```
|
|
4515
4515
|
|
|
4516
|
-
Defined in: [packages/fs/src/types.ts:264](https://github.com/visulima/visulima/blob/
|
|
4516
|
+
Defined in: [packages/fs/src/types.ts:264](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L264)
|
|
4517
4517
|
|
|
4518
4518
|
The result type for the name matcher function used in `findUp`.
|
|
4519
4519
|
It can be a `PathLike` (string, Buffer, or URL), a Promise resolving to `PathLike` or `FIND_UP_STOP`,
|
|
@@ -4530,7 +4530,7 @@ type FindUpNameSync =
|
|
|
4530
4530
|
| (directory) => FindUpNameSyncFnResult;
|
|
4531
4531
|
```
|
|
4532
4532
|
|
|
4533
|
-
Defined in: [packages/fs/src/types.ts:284](https://github.com/visulima/visulima/blob/
|
|
4533
|
+
Defined in: [packages/fs/src/types.ts:284](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L284)
|
|
4534
4534
|
|
|
4535
4535
|
Specifies the name(s) of the file or directory to search for in `findUpSync`.
|
|
4536
4536
|
Can be a single name, an array of names, or a function that returns a name or `FIND_UP_STOP`.
|
|
@@ -4543,7 +4543,7 @@ Can be a single name, an array of names, or a function that returns a name or `F
|
|
|
4543
4543
|
type FindUpNameSyncFnResult = PathLike | typeof FIND_UP_STOP | undefined;
|
|
4544
4544
|
```
|
|
4545
4545
|
|
|
4546
|
-
Defined in: [packages/fs/src/types.ts:278](https://github.com/visulima/visulima/blob/
|
|
4546
|
+
Defined in: [packages/fs/src/types.ts:278](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L278)
|
|
4547
4547
|
|
|
4548
4548
|
The result type for the name matcher function used in `findUpSync`.
|
|
4549
4549
|
It can be a `PathLike` (string, Buffer, or URL), `FIND_UP_STOP` to stop the search,
|
|
@@ -4557,7 +4557,7 @@ or `undefined` to continue.
|
|
|
4557
4557
|
type FindUpOptions = object;
|
|
4558
4558
|
```
|
|
4559
4559
|
|
|
4560
|
-
Defined in: [packages/fs/src/types.ts:235](https://github.com/visulima/visulima/blob/
|
|
4560
|
+
Defined in: [packages/fs/src/types.ts:235](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L235)
|
|
4561
4561
|
|
|
4562
4562
|
Options for the `findUp` and `findUpSync` functions.
|
|
4563
4563
|
|
|
@@ -4569,7 +4569,7 @@ Options for the `findUp` and `findUpSync` functions.
|
|
|
4569
4569
|
optional allowSymlinks: boolean;
|
|
4570
4570
|
```
|
|
4571
4571
|
|
|
4572
|
-
Defined in: [packages/fs/src/types.ts:240](https://github.com/visulima/visulima/blob/
|
|
4572
|
+
Defined in: [packages/fs/src/types.ts:240](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L240)
|
|
4573
4573
|
|
|
4574
4574
|
Whether to follow symbolic links.
|
|
4575
4575
|
|
|
@@ -4583,7 +4583,7 @@ undefined (behaves like `true` for `findUp`, `false` for `findUpSync` due to `fs
|
|
|
4583
4583
|
optional cwd: URL | string;
|
|
4584
4584
|
```
|
|
4585
4585
|
|
|
4586
|
-
Defined in: [packages/fs/src/types.ts:245](https://github.com/visulima/visulima/blob/
|
|
4586
|
+
Defined in: [packages/fs/src/types.ts:245](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L245)
|
|
4587
4587
|
|
|
4588
4588
|
The current working directory.
|
|
4589
4589
|
|
|
@@ -4599,7 +4599,7 @@ process.cwd()
|
|
|
4599
4599
|
optional stopAt: URL | string;
|
|
4600
4600
|
```
|
|
4601
4601
|
|
|
4602
|
-
Defined in: [packages/fs/src/types.ts:250](https://github.com/visulima/visulima/blob/
|
|
4602
|
+
Defined in: [packages/fs/src/types.ts:250](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L250)
|
|
4603
4603
|
|
|
4604
4604
|
The directory to stop searching at.
|
|
4605
4605
|
|
|
@@ -4615,7 +4615,7 @@ path.parse(cwd).root
|
|
|
4615
4615
|
optional type: "directory" | "file";
|
|
4616
4616
|
```
|
|
4617
4617
|
|
|
4618
|
-
Defined in: [packages/fs/src/types.ts:255](https://github.com/visulima/visulima/blob/
|
|
4618
|
+
Defined in: [packages/fs/src/types.ts:255](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L255)
|
|
4619
4619
|
|
|
4620
4620
|
The type of path to find.
|
|
4621
4621
|
|
|
@@ -4633,7 +4633,7 @@ The type of path to find.
|
|
|
4633
4633
|
type JsonReplacer = (number | string)[] | (this, key, value) => unknown | null;
|
|
4634
4634
|
```
|
|
4635
4635
|
|
|
4636
|
-
Defined in: [packages/fs/src/types.ts:197](https://github.com/visulima/visulima/blob/
|
|
4636
|
+
Defined in: [packages/fs/src/types.ts:197](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L197)
|
|
4637
4637
|
|
|
4638
4638
|
Type for the `replacer` parameter of `JSON.stringify()`.
|
|
4639
4639
|
Can be a function that alters the behavior of the stringification process,
|
|
@@ -4649,7 +4649,7 @@ If this value is null or not provided, all properties of the object are included
|
|
|
4649
4649
|
type JsonReviver = Parameters<typeof JSON["parse"]>["1"];
|
|
4650
4650
|
```
|
|
4651
4651
|
|
|
4652
|
-
Defined in: [packages/fs/src/types.ts:112](https://github.com/visulima/visulima/blob/
|
|
4652
|
+
Defined in: [packages/fs/src/types.ts:112](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L112)
|
|
4653
4653
|
|
|
4654
4654
|
Type for the `reviver` parameter of `JSON.parse()`.
|
|
4655
4655
|
A function that transforms the results. This function is called for each member of the object.
|
|
@@ -4663,7 +4663,7 @@ If a member contains nested objects, the nested objects are transformed before t
|
|
|
4663
4663
|
type MoveOptions = object;
|
|
4664
4664
|
```
|
|
4665
4665
|
|
|
4666
|
-
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/
|
|
4666
|
+
Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/types.ts#L3)
|
|
4667
4667
|
|
|
4668
4668
|
#### Properties
|
|
4669
4669
|
|
|
@@ -4673,7 +4673,7 @@ Defined in: [packages/fs/src/move/types.ts:3](https://github.com/visulima/visuli
|
|
|
4673
4673
|
optional cwd: URL | string;
|
|
4674
4674
|
```
|
|
4675
4675
|
|
|
4676
|
-
Defined in: [packages/fs/src/move/types.ts:10](https://github.com/visulima/visulima/blob/
|
|
4676
|
+
Defined in: [packages/fs/src/move/types.ts:10](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/types.ts#L10)
|
|
4677
4677
|
|
|
4678
4678
|
The working directory to find source files.
|
|
4679
4679
|
The source and destination path are relative to this.
|
|
@@ -4690,7 +4690,7 @@ process.cwd()
|
|
|
4690
4690
|
readonly optional directoryMode: FilePermissions;
|
|
4691
4691
|
```
|
|
4692
4692
|
|
|
4693
|
-
Defined in: [packages/fs/src/move/types.ts:19](https://github.com/visulima/visulima/blob/
|
|
4693
|
+
Defined in: [packages/fs/src/move/types.ts:19](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/types.ts#L19)
|
|
4694
4694
|
|
|
4695
4695
|
[Permissions](https://en.wikipedia.org/wiki/File-system_permissions#Numeric_notation) for created directories.
|
|
4696
4696
|
|
|
@@ -4708,7 +4708,7 @@ It has no effect on Windows.
|
|
|
4708
4708
|
readonly optional overwrite: boolean;
|
|
4709
4709
|
```
|
|
4710
4710
|
|
|
4711
|
-
Defined in: [packages/fs/src/move/types.ts:26](https://github.com/visulima/visulima/blob/
|
|
4711
|
+
Defined in: [packages/fs/src/move/types.ts:26](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/move/types.ts#L26)
|
|
4712
4712
|
|
|
4713
4713
|
Overwrite existing destination file.
|
|
4714
4714
|
|
|
@@ -4737,7 +4737,7 @@ type ReadFileEncoding =
|
|
|
4737
4737
|
| "utf16le";
|
|
4738
4738
|
```
|
|
4739
4739
|
|
|
4740
|
-
Defined in: [packages/fs/src/types.ts:71](https://github.com/visulima/visulima/blob/
|
|
4740
|
+
Defined in: [packages/fs/src/types.ts:71](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L71)
|
|
4741
4741
|
|
|
4742
4742
|
Supported file encodings for reading files.
|
|
4743
4743
|
|
|
@@ -4749,7 +4749,7 @@ Supported file encodings for reading files.
|
|
|
4749
4749
|
type ReadFileOptions<C> = object;
|
|
4750
4750
|
```
|
|
4751
4751
|
|
|
4752
|
-
Defined in: [packages/fs/src/types.ts:77](https://github.com/visulima/visulima/blob/
|
|
4752
|
+
Defined in: [packages/fs/src/types.ts:77](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L77)
|
|
4753
4753
|
|
|
4754
4754
|
Options for reading files.
|
|
4755
4755
|
|
|
@@ -4769,7 +4769,7 @@ The type of compression used.
|
|
|
4769
4769
|
optional buffer: boolean;
|
|
4770
4770
|
```
|
|
4771
4771
|
|
|
4772
|
-
Defined in: [packages/fs/src/types.ts:81](https://github.com/visulima/visulima/blob/
|
|
4772
|
+
Defined in: [packages/fs/src/types.ts:81](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L81)
|
|
4773
4773
|
|
|
4774
4774
|
Return content as a Buffer. Default: `false`
|
|
4775
4775
|
|
|
@@ -4779,7 +4779,7 @@ Return content as a Buffer. Default: `false`
|
|
|
4779
4779
|
optional compression: C;
|
|
4780
4780
|
```
|
|
4781
4781
|
|
|
4782
|
-
Defined in: [packages/fs/src/types.ts:86](https://github.com/visulima/visulima/blob/
|
|
4782
|
+
Defined in: [packages/fs/src/types.ts:86](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L86)
|
|
4783
4783
|
|
|
4784
4784
|
Compression method to decompress the file against. Default: `none`
|
|
4785
4785
|
|
|
@@ -4789,7 +4789,7 @@ Compression method to decompress the file against. Default: `none`
|
|
|
4789
4789
|
optional encoding: ReadFileEncoding;
|
|
4790
4790
|
```
|
|
4791
4791
|
|
|
4792
|
-
Defined in: [packages/fs/src/types.ts:92](https://github.com/visulima/visulima/blob/
|
|
4792
|
+
Defined in: [packages/fs/src/types.ts:92](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L92)
|
|
4793
4793
|
|
|
4794
4794
|
The encoding to use. Default: `utf8`
|
|
4795
4795
|
|
|
@@ -4803,7 +4803,7 @@ https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
|
|
|
4803
4803
|
optional flag: number | string;
|
|
4804
4804
|
```
|
|
4805
4805
|
|
|
4806
|
-
Defined in: [packages/fs/src/types.ts:97](https://github.com/visulima/visulima/blob/
|
|
4806
|
+
Defined in: [packages/fs/src/types.ts:97](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L97)
|
|
4807
4807
|
|
|
4808
4808
|
The flag used to open the file. Default: `r`
|
|
4809
4809
|
|
|
@@ -4815,7 +4815,7 @@ The flag used to open the file. Default: `r`
|
|
|
4815
4815
|
type ReadJsonOptions = CodeFrameOptions & object;
|
|
4816
4816
|
```
|
|
4817
4817
|
|
|
4818
|
-
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/
|
|
4818
|
+
Defined in: [packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L143)
|
|
4819
4819
|
|
|
4820
4820
|
Options for reading and parsing JSON files.
|
|
4821
4821
|
Extends [CodeFrameOptions](#codeframeoptions).
|
|
@@ -4852,7 +4852,7 @@ The transformed string content.
|
|
|
4852
4852
|
type WriteFileOptions = object;
|
|
4853
4853
|
```
|
|
4854
4854
|
|
|
4855
|
-
Defined in: [packages/fs/src/types.ts:155](https://github.com/visulima/visulima/blob/
|
|
4855
|
+
Defined in: [packages/fs/src/types.ts:155](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L155)
|
|
4856
4856
|
|
|
4857
4857
|
Options for writing files.
|
|
4858
4858
|
|
|
@@ -4864,7 +4864,7 @@ Options for writing files.
|
|
|
4864
4864
|
optional chown: object;
|
|
4865
4865
|
```
|
|
4866
4866
|
|
|
4867
|
-
Defined in: [packages/fs/src/types.ts:159](https://github.com/visulima/visulima/blob/
|
|
4867
|
+
Defined in: [packages/fs/src/types.ts:159](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L159)
|
|
4868
4868
|
|
|
4869
4869
|
The group and user ID used to set the file ownership. Default: `undefined`
|
|
4870
4870
|
|
|
@@ -4886,7 +4886,7 @@ uid: number;
|
|
|
4886
4886
|
optional encoding: BufferEncoding | null;
|
|
4887
4887
|
```
|
|
4888
4888
|
|
|
4889
|
-
Defined in: [packages/fs/src/types.ts:167](https://github.com/visulima/visulima/blob/
|
|
4889
|
+
Defined in: [packages/fs/src/types.ts:167](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L167)
|
|
4890
4890
|
|
|
4891
4891
|
The encoding to use. Default: `utf8`
|
|
4892
4892
|
|
|
@@ -4896,7 +4896,7 @@ The encoding to use. Default: `utf8`
|
|
|
4896
4896
|
optional flag: string;
|
|
4897
4897
|
```
|
|
4898
4898
|
|
|
4899
|
-
Defined in: [packages/fs/src/types.ts:172](https://github.com/visulima/visulima/blob/
|
|
4899
|
+
Defined in: [packages/fs/src/types.ts:172](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L172)
|
|
4900
4900
|
|
|
4901
4901
|
The flag used to write the file. Default: `w`
|
|
4902
4902
|
|
|
@@ -4906,7 +4906,7 @@ The flag used to write the file. Default: `w`
|
|
|
4906
4906
|
optional mode: number;
|
|
4907
4907
|
```
|
|
4908
4908
|
|
|
4909
|
-
Defined in: [packages/fs/src/types.ts:177](https://github.com/visulima/visulima/blob/
|
|
4909
|
+
Defined in: [packages/fs/src/types.ts:177](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L177)
|
|
4910
4910
|
|
|
4911
4911
|
The file mode (permission and sticky bits). Default: `0o666`
|
|
4912
4912
|
|
|
@@ -4916,7 +4916,7 @@ The file mode (permission and sticky bits). Default: `0o666`
|
|
|
4916
4916
|
optional overwrite: boolean;
|
|
4917
4917
|
```
|
|
4918
4918
|
|
|
4919
|
-
Defined in: [packages/fs/src/types.ts:182](https://github.com/visulima/visulima/blob/
|
|
4919
|
+
Defined in: [packages/fs/src/types.ts:182](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L182)
|
|
4920
4920
|
|
|
4921
4921
|
Indicates whether the file should be overwritten if it already exists. Default: `false`
|
|
4922
4922
|
|
|
@@ -4926,7 +4926,7 @@ Indicates whether the file should be overwritten if it already exists. Default:
|
|
|
4926
4926
|
optional recursive: boolean;
|
|
4927
4927
|
```
|
|
4928
4928
|
|
|
4929
|
-
Defined in: [packages/fs/src/types.ts:187](https://github.com/visulima/visulima/blob/
|
|
4929
|
+
Defined in: [packages/fs/src/types.ts:187](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L187)
|
|
4930
4930
|
|
|
4931
4931
|
Recursively create parent directories if needed. Default: `true`
|
|
4932
4932
|
|
|
@@ -4938,7 +4938,7 @@ Recursively create parent directories if needed. Default: `true`
|
|
|
4938
4938
|
type WriteJsonOptions = WriteFileOptions & object;
|
|
4939
4939
|
```
|
|
4940
4940
|
|
|
4941
|
-
Defined in: [packages/fs/src/types.ts:208](https://github.com/visulima/visulima/blob/
|
|
4941
|
+
Defined in: [packages/fs/src/types.ts:208](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L208)
|
|
4942
4942
|
|
|
4943
4943
|
Options for writing JSON files.
|
|
4944
4944
|
Extends [WriteFileOptions](#writefileoptions).
|
|
@@ -5036,7 +5036,7 @@ Re-exports [LF](eol.md#lf)
|
|
|
5036
5036
|
function brotliSize(input, options?): Promise<number>;
|
|
5037
5037
|
```
|
|
5038
5038
|
|
|
5039
|
-
Defined in: [packages/fs/src/size.ts:222](https://github.com/visulima/visulima/blob/
|
|
5039
|
+
Defined in: [packages/fs/src/size.ts:222](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/size.ts#L222)
|
|
5040
5040
|
|
|
5041
5041
|
Asynchronously calculates the Brotli compressed size of the given input.
|
|
5042
5042
|
The input can be a Buffer, a Readable stream, a URL object pointing to a file, or a string (file path or content).
|
|
@@ -5107,7 +5107,7 @@ main().catch(console.error);
|
|
|
5107
5107
|
function brotliSizeSync(input, options?): number;
|
|
5108
5108
|
```
|
|
5109
5109
|
|
|
5110
|
-
Defined in: [packages/fs/src/size.ts:370](https://github.com/visulima/visulima/blob/
|
|
5110
|
+
Defined in: [packages/fs/src/size.ts:370](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/size.ts#L370)
|
|
5111
5111
|
|
|
5112
5112
|
Synchronously calculates the Brotli compressed size of the given input.
|
|
5113
5113
|
The input can be a Buffer, a URL object pointing to a file, or a string (file path or content).
|
|
@@ -5171,7 +5171,7 @@ try {
|
|
|
5171
5171
|
function gzipSize(input, options?): Promise<number>;
|
|
5172
5172
|
```
|
|
5173
5173
|
|
|
5174
|
-
Defined in: [packages/fs/src/size.ts:171](https://github.com/visulima/visulima/blob/
|
|
5174
|
+
Defined in: [packages/fs/src/size.ts:171](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/size.ts#L171)
|
|
5175
5175
|
|
|
5176
5176
|
Asynchronously calculates the gzipped size of the given input.
|
|
5177
5177
|
The input can be a Buffer, a Readable stream, a URL object pointing to a file, or a string (file path or content).
|
|
@@ -5242,7 +5242,7 @@ main().catch(console.error);
|
|
|
5242
5242
|
function gzipSizeSync(input, options?): number;
|
|
5243
5243
|
```
|
|
5244
5244
|
|
|
5245
|
-
Defined in: [packages/fs/src/size.ts:316](https://github.com/visulima/visulima/blob/
|
|
5245
|
+
Defined in: [packages/fs/src/size.ts:316](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/size.ts#L316)
|
|
5246
5246
|
|
|
5247
5247
|
Synchronously calculates the gzipped size of the given input.
|
|
5248
5248
|
The input can be a Buffer, a URL object pointing to a file, or a string (file path or content).
|
|
@@ -5306,7 +5306,7 @@ try {
|
|
|
5306
5306
|
function rawSize(input): Promise<number>;
|
|
5307
5307
|
```
|
|
5308
5308
|
|
|
5309
|
-
Defined in: [packages/fs/src/size.ts:272](https://github.com/visulima/visulima/blob/
|
|
5309
|
+
Defined in: [packages/fs/src/size.ts:272](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/size.ts#L272)
|
|
5310
5310
|
|
|
5311
5311
|
Asynchronously calculates the raw (uncompressed) size of the given input.
|
|
5312
5312
|
The input can be a Buffer, a Readable stream, a URL object pointing to a file, or a string (file path or content).
|
|
@@ -5371,7 +5371,7 @@ main().catch(console.error);
|
|
|
5371
5371
|
function rawSizeSync(input): number;
|
|
5372
5372
|
```
|
|
5373
5373
|
|
|
5374
|
-
Defined in: [packages/fs/src/size.ts:424](https://github.com/visulima/visulima/blob/
|
|
5374
|
+
Defined in: [packages/fs/src/size.ts:424](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/size.ts#L424)
|
|
5375
5375
|
|
|
5376
5376
|
Synchronously calculates the raw (uncompressed) size of the given input.
|
|
5377
5377
|
The input can be a Buffer, a URL object pointing to a file, or a string (file path or content).
|
|
@@ -5427,7 +5427,7 @@ try {
|
|
|
5427
5427
|
|
|
5428
5428
|
### JSONError
|
|
5429
5429
|
|
|
5430
|
-
Defined in: [packages/fs/src/error/json-error.ts:39](https://github.com/visulima/visulima/blob/
|
|
5430
|
+
Defined in: [packages/fs/src/error/json-error.ts:39](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L39)
|
|
5431
5431
|
|
|
5432
5432
|
Custom error class for handling JSON parsing or related errors.
|
|
5433
5433
|
It can optionally include a file name and a code frame for better debugging.
|
|
@@ -5480,7 +5480,7 @@ try {
|
|
|
5480
5480
|
new JSONError(message): JSONError;
|
|
5481
5481
|
```
|
|
5482
5482
|
|
|
5483
|
-
Defined in: [packages/fs/src/error/json-error.ts:53](https://github.com/visulima/visulima/blob/
|
|
5483
|
+
Defined in: [packages/fs/src/error/json-error.ts:53](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L53)
|
|
5484
5484
|
|
|
5485
5485
|
Creates a new JSONError instance.
|
|
5486
5486
|
|
|
@@ -5512,7 +5512,7 @@ Error.constructor
|
|
|
5512
5512
|
get message(): string;
|
|
5513
5513
|
```
|
|
5514
5514
|
|
|
5515
|
-
Defined in: [packages/fs/src/error/json-error.ts:63](https://github.com/visulima/visulima/blob/
|
|
5515
|
+
Defined in: [packages/fs/src/error/json-error.ts:63](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L63)
|
|
5516
5516
|
|
|
5517
5517
|
###### Returns
|
|
5518
5518
|
|
|
@@ -5524,7 +5524,7 @@ Defined in: [packages/fs/src/error/json-error.ts:63](https://github.com/visulima
|
|
|
5524
5524
|
set message(message): void;
|
|
5525
5525
|
```
|
|
5526
5526
|
|
|
5527
|
-
Defined in: [packages/fs/src/error/json-error.ts:67](https://github.com/visulima/visulima/blob/
|
|
5527
|
+
Defined in: [packages/fs/src/error/json-error.ts:67](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L67)
|
|
5528
5528
|
|
|
5529
5529
|
###### Parameters
|
|
5530
5530
|
|
|
@@ -5596,7 +5596,7 @@ Error.cause
|
|
|
5596
5596
|
codeFrame: string;
|
|
5597
5597
|
```
|
|
5598
5598
|
|
|
5599
|
-
Defined in: [packages/fs/src/error/json-error.ts:42](https://github.com/visulima/visulima/blob/
|
|
5599
|
+
Defined in: [packages/fs/src/error/json-error.ts:42](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L42)
|
|
5600
5600
|
|
|
5601
5601
|
##### fileName
|
|
5602
5602
|
|
|
@@ -5604,7 +5604,7 @@ Defined in: [packages/fs/src/error/json-error.ts:42](https://github.com/visulima
|
|
|
5604
5604
|
fileName: string;
|
|
5605
5605
|
```
|
|
5606
5606
|
|
|
5607
|
-
Defined in: [packages/fs/src/error/json-error.ts:40](https://github.com/visulima/visulima/blob/
|
|
5607
|
+
Defined in: [packages/fs/src/error/json-error.ts:40](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L40)
|
|
5608
5608
|
|
|
5609
5609
|
##### name
|
|
5610
5610
|
|
|
@@ -5612,7 +5612,7 @@ Defined in: [packages/fs/src/error/json-error.ts:40](https://github.com/visulima
|
|
|
5612
5612
|
readonly name: "JSONError" = "JSONError";
|
|
5613
5613
|
```
|
|
5614
5614
|
|
|
5615
|
-
Defined in: [packages/fs/src/error/json-error.ts:45](https://github.com/visulima/visulima/blob/
|
|
5615
|
+
Defined in: [packages/fs/src/error/json-error.ts:45](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/error/json-error.ts#L45)
|
|
5616
5616
|
|
|
5617
5617
|
###### Overrides
|
|
5618
5618
|
|
|
@@ -5690,7 +5690,7 @@ Error.stackTraceLimit
|
|
|
5690
5690
|
function assertValidFileContents(contents): void;
|
|
5691
5691
|
```
|
|
5692
5692
|
|
|
5693
|
-
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:28](https://github.com/visulima/visulima/blob/
|
|
5693
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-contents.ts:28](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/utils/assert-valid-file-contents.ts#L28)
|
|
5694
5694
|
|
|
5695
5695
|
Asserts that the provided contents are valid for writing to a file.
|
|
5696
5696
|
Valid contents can be a string, an ArrayBuffer, or an ArrayBuffer view (e.g., Uint8Array).
|
|
@@ -5740,7 +5740,7 @@ try {
|
|
|
5740
5740
|
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void;
|
|
5741
5741
|
```
|
|
5742
5742
|
|
|
5743
|
-
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:27](https://github.com/visulima/visulima/blob/
|
|
5743
|
+
Defined in: [packages/fs/src/utils/assert-valid-file-or-directory-path.ts:27](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L27)
|
|
5744
5744
|
|
|
5745
5745
|
Asserts that the provided path is a valid file or directory path.
|
|
5746
5746
|
A valid path must be a non-empty string or a URL instance.
|
|
@@ -5864,7 +5864,7 @@ function parseJson<T>(
|
|
|
5864
5864
|
options?): T;
|
|
5865
5865
|
```
|
|
5866
5866
|
|
|
5867
|
-
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/
|
|
5867
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/utils/parse-json.ts#L60)
|
|
5868
5868
|
|
|
5869
5869
|
##### Type Parameters
|
|
5870
5870
|
|
|
@@ -5900,7 +5900,7 @@ function parseJson<T>(
|
|
|
5900
5900
|
options?): T;
|
|
5901
5901
|
```
|
|
5902
5902
|
|
|
5903
|
-
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/
|
|
5903
|
+
Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/utils/parse-json.ts#L61)
|
|
5904
5904
|
|
|
5905
5905
|
##### Type Parameters
|
|
5906
5906
|
|
|
@@ -5938,7 +5938,7 @@ Defined in: [packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima
|
|
|
5938
5938
|
function stripJsonComments(jsonString, options?): string;
|
|
5939
5939
|
```
|
|
5940
5940
|
|
|
5941
|
-
Defined in: [packages/fs/src/utils/strip-json-comments.ts:46](https://github.com/visulima/visulima/blob/
|
|
5941
|
+
Defined in: [packages/fs/src/utils/strip-json-comments.ts:46](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/utils/strip-json-comments.ts#L46)
|
|
5942
5942
|
|
|
5943
5943
|
Strips comments from a JSON string.
|
|
5944
5944
|
Handles both single-line (//) and multi-line (/* ... */) comments.
|
|
@@ -6081,7 +6081,7 @@ readMyYaml();
|
|
|
6081
6081
|
function readYaml<R>(path, options?): Promise<R>;
|
|
6082
6082
|
```
|
|
6083
6083
|
|
|
6084
|
-
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/
|
|
6084
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-yaml.ts#L6)
|
|
6085
6085
|
|
|
6086
6086
|
##### Type Parameters
|
|
6087
6087
|
|
|
@@ -6112,7 +6112,7 @@ function readYaml<R>(
|
|
|
6112
6112
|
options?): Promise<R>;
|
|
6113
6113
|
```
|
|
6114
6114
|
|
|
6115
|
-
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/
|
|
6115
|
+
Defined in: [packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-yaml.ts#L7)
|
|
6116
6116
|
|
|
6117
6117
|
##### Type Parameters
|
|
6118
6118
|
|
|
@@ -6193,7 +6193,7 @@ try {
|
|
|
6193
6193
|
function readYamlSync<R>(path, options?): R;
|
|
6194
6194
|
```
|
|
6195
6195
|
|
|
6196
|
-
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/
|
|
6196
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
6197
6197
|
|
|
6198
6198
|
##### Type Parameters
|
|
6199
6199
|
|
|
@@ -6224,7 +6224,7 @@ function readYamlSync<R>(
|
|
|
6224
6224
|
options?): R;
|
|
6225
6225
|
```
|
|
6226
6226
|
|
|
6227
|
-
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/
|
|
6227
|
+
Defined in: [packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
6228
6228
|
|
|
6229
6229
|
##### Type Parameters
|
|
6230
6230
|
|
|
@@ -6309,7 +6309,7 @@ function writeYaml(
|
|
|
6309
6309
|
options?): Promise<void>;
|
|
6310
6310
|
```
|
|
6311
6311
|
|
|
6312
|
-
Defined in: [packages/fs/src/write/write-yaml.ts:6](https://github.com/visulima/visulima/blob/
|
|
6312
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:6](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-yaml.ts#L6)
|
|
6313
6313
|
|
|
6314
6314
|
##### Parameters
|
|
6315
6315
|
|
|
@@ -6339,7 +6339,7 @@ function writeYaml(
|
|
|
6339
6339
|
options?): Promise<void>;
|
|
6340
6340
|
```
|
|
6341
6341
|
|
|
6342
|
-
Defined in: [packages/fs/src/write/write-yaml.ts:12](https://github.com/visulima/visulima/blob/
|
|
6342
|
+
Defined in: [packages/fs/src/write/write-yaml.ts:12](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-yaml.ts#L12)
|
|
6343
6343
|
|
|
6344
6344
|
##### Parameters
|
|
6345
6345
|
|
|
@@ -6422,7 +6422,7 @@ function writeYamlSync(
|
|
|
6422
6422
|
options?): void;
|
|
6423
6423
|
```
|
|
6424
6424
|
|
|
6425
|
-
Defined in: [packages/fs/src/write/write-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/
|
|
6425
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-yaml-sync.ts#L6)
|
|
6426
6426
|
|
|
6427
6427
|
##### Parameters
|
|
6428
6428
|
|
|
@@ -6452,7 +6452,7 @@ function writeYamlSync(
|
|
|
6452
6452
|
options?): void;
|
|
6453
6453
|
```
|
|
6454
6454
|
|
|
6455
|
-
Defined in: [packages/fs/src/write/write-yaml-sync.ts:12](https://github.com/visulima/visulima/blob/
|
|
6455
|
+
Defined in: [packages/fs/src/write/write-yaml-sync.ts:12](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/write/write-yaml-sync.ts#L12)
|
|
6456
6456
|
|
|
6457
6457
|
##### Parameters
|
|
6458
6458
|
|
|
@@ -6484,7 +6484,7 @@ Defined in: [packages/fs/src/write/write-yaml-sync.ts:12](https://github.com/vis
|
|
|
6484
6484
|
type YamlReplacer = JsonReplacer;
|
|
6485
6485
|
```
|
|
6486
6486
|
|
|
6487
|
-
Defined in: [packages/fs/src/types.ts:202](https://github.com/visulima/visulima/blob/
|
|
6487
|
+
Defined in: [packages/fs/src/types.ts:202](https://github.com/visulima/visulima/blob/2ba2196cfa1aecc6ede047ef10ca5785def47ef1/packages/fs/src/types.ts#L202)
|
|
6488
6488
|
|
|
6489
6489
|
Type for the `replacer` parameter used in YAML serialization, similar to `JSON.stringify`'s replacer.
|
|
6490
6490
|
|