@visulima/fs 2.3.5 → 2.3.6
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 +12 -0
- package/README.md +318 -362
- package/dist/error.cjs +21 -1
- package/dist/error.mjs +7 -1
- package/dist/index.cjs +88 -1
- package/dist/index.mjs +35 -1
- package/dist/packem_shared/AlreadyExistsError-DpxtwQot.cjs +34 -0
- package/dist/packem_shared/AlreadyExistsError-GK7J9fVA.mjs +32 -0
- package/dist/packem_shared/DirectoryError-D8FHcAqu.cjs +34 -0
- package/dist/packem_shared/DirectoryError-DByTWE7t.mjs +32 -0
- package/dist/packem_shared/F_OK-CWSqQIdF.cjs +17 -0
- package/dist/packem_shared/F_OK-JER1LjUr.mjs +8 -0
- package/dist/packem_shared/JSONError-BCIIHvzq.mjs +28 -0
- package/dist/packem_shared/JSONError-gkXvBSar.cjs +30 -0
- package/dist/packem_shared/LF-CU3KsvZC.mjs +20 -0
- package/dist/packem_shared/LF-bB2qO80j.cjs +28 -0
- package/dist/packem_shared/NotEmptyError-BCS_5pPt.cjs +34 -0
- package/dist/packem_shared/NotEmptyError-DCXooh5l.mjs +32 -0
- package/dist/packem_shared/NotFoundError-B_1nPl3K.cjs +34 -0
- package/dist/packem_shared/NotFoundError-CUdcC61I.mjs +32 -0
- package/dist/packem_shared/PermissionError-CqGMI9qC.mjs +32 -0
- package/dist/packem_shared/PermissionError-QFMKgk2l.cjs +34 -0
- package/dist/packem_shared/WalkError-B7_AVs7d.cjs +27 -0
- package/dist/packem_shared/WalkError-H9EuRv7O.mjs +25 -0
- package/dist/packem_shared/assertValidFileContents-CRVvyM6b.cjs +11 -0
- package/dist/packem_shared/assertValidFileContents-Ox-ScfeK.mjs +9 -0
- package/dist/packem_shared/assertValidFileOrDirectoryPath-BMbgA-eI.cjs +11 -0
- package/dist/packem_shared/assertValidFileOrDirectoryPath-BWWgA1wj.mjs +9 -0
- package/dist/packem_shared/collect-BtDVJEOm.mjs +16 -0
- package/dist/packem_shared/collect-DxUriHCH.cjs +18 -0
- package/dist/packem_shared/collectSync-BaA0s001.cjs +18 -0
- package/dist/packem_shared/collectSync-CGjdb50I.mjs +16 -0
- package/dist/packem_shared/emptyDir-DcCfiNcf.cjs +22 -0
- package/dist/packem_shared/emptyDir-Dw5xSBox.mjs +20 -0
- package/dist/packem_shared/emptyDirSync-BoknkGUe.cjs +21 -0
- package/dist/packem_shared/emptyDirSync-DTGPXQ3v.mjs +19 -0
- package/dist/packem_shared/ensureDir-XiBlkOLR.mjs +33 -0
- package/dist/packem_shared/ensureDir-iUK2ga5M.cjs +35 -0
- package/dist/packem_shared/ensureDirSync-2IFUHFK2.mjs +33 -0
- package/dist/packem_shared/ensureDirSync-CXdMkg0Y.cjs +35 -0
- package/dist/packem_shared/ensureFile-Br8tFUJ7.cjs +29 -0
- package/dist/packem_shared/ensureFile-C2bWlBEa.mjs +27 -0
- package/dist/packem_shared/ensureFileSync-CZzSkNGC.cjs +29 -0
- package/dist/packem_shared/ensureFileSync-DkFfhOEs.mjs +27 -0
- package/dist/packem_shared/ensureLink-CFiabAD3.mjs +34 -0
- package/dist/packem_shared/ensureLink-Dqw5GBDq.cjs +36 -0
- package/dist/packem_shared/ensureLinkSync-BVw3h6sK.cjs +36 -0
- package/dist/packem_shared/ensureLinkSync-Dk-YeRg6.mjs +34 -0
- package/dist/packem_shared/ensureSymlink-CFSfreco.cjs +54 -0
- package/dist/packem_shared/ensureSymlink-CSqngPoI.mjs +52 -0
- package/dist/packem_shared/ensureSymlinkSync-BCd9bzsx.cjs +58 -0
- package/dist/packem_shared/ensureSymlinkSync-QRaNZX2E.mjs +56 -0
- package/dist/packem_shared/findUp-C8_QpAtD.mjs +63 -0
- package/dist/packem_shared/findUp-DA511Swp.cjs +65 -0
- package/dist/packem_shared/findUpSync-DVOd3V-q.mjs +63 -0
- package/dist/packem_shared/findUpSync-u1rGibzw.cjs +65 -0
- package/dist/packem_shared/get-file-info-type-BpRzQHvd.cjs +18 -0
- package/dist/packem_shared/get-file-info-type-CeiZ6n6g.mjs +16 -0
- package/dist/packem_shared/index-ajT9ecry.mjs +108 -0
- package/dist/packem_shared/index-ngvEMjBI.cjs +110 -0
- package/dist/packem_shared/is-stats-identical-BfdEfO6i.cjs +7 -0
- package/dist/packem_shared/is-stats-identical-ByTYZ2Aw.mjs +5 -0
- package/dist/packem_shared/isAccessible-Bonsm1Ez.mjs +20 -0
- package/dist/packem_shared/isAccessible-ZNVGsSb7.cjs +22 -0
- package/dist/packem_shared/isAccessibleSync-3gnUWUwX.mjs +20 -0
- package/dist/packem_shared/isAccessibleSync-VWjQa-US.cjs +22 -0
- package/dist/packem_shared/move-DgF7Ul9L.mjs +114 -0
- package/dist/packem_shared/move-Dh925GL9.cjs +121 -0
- package/dist/packem_shared/parseJson-B_q4905N.mjs +160 -0
- package/dist/packem_shared/parseJson-P3C7DMaS.cjs +162 -0
- package/dist/packem_shared/readFile-DUM-xNoB.mjs +46 -0
- package/dist/packem_shared/readFile-iFUhZHnh.cjs +48 -0
- package/dist/packem_shared/readFileSync-B3NTOR-W.cjs +33 -0
- package/dist/packem_shared/readFileSync-Cck96_o0.mjs +31 -0
- package/dist/packem_shared/readJson-Bqr9Oi3I.mjs +25 -0
- package/dist/packem_shared/readJson-D7rMdkkq.cjs +27 -0
- package/dist/packem_shared/readJsonSync-D3s2y651.cjs +27 -0
- package/dist/packem_shared/readJsonSync-Don8Jw5D.mjs +25 -0
- package/dist/packem_shared/readYaml-sR4bqUel.cjs +15 -0
- package/dist/packem_shared/readYaml-vVKK8ZzY.mjs +13 -0
- package/dist/packem_shared/readYamlSync-C3oOzxiN.cjs +15 -0
- package/dist/packem_shared/readYamlSync-MOLH4gXB.mjs +13 -0
- package/dist/packem_shared/remove-B2nxUObP.mjs +18 -0
- package/dist/packem_shared/remove-BpDiVPns.cjs +20 -0
- package/dist/packem_shared/removeSync-BosXW624.cjs +20 -0
- package/dist/packem_shared/removeSync-C87yepDI.mjs +18 -0
- package/dist/packem_shared/resolve-symlink-target-BbpEHdU2.mjs +18 -0
- package/dist/packem_shared/resolve-symlink-target-DImIddt6.cjs +20 -0
- package/dist/packem_shared/stripJsonComments-B66nRaTZ.mjs +21 -0
- package/dist/packem_shared/stripJsonComments-eDrcJvBT.cjs +23 -0
- package/dist/packem_shared/to-uint-8-array-B4CjMOD3.mjs +21 -0
- package/dist/packem_shared/to-uint-8-array-BaTEyX3D.cjs +23 -0
- package/dist/packem_shared/walk-BW7b4GXI.cjs +106 -0
- package/dist/packem_shared/walk-CNcSYQVq.mjs +104 -0
- package/dist/packem_shared/walk-include-CMUSRa86.mjs +20 -0
- package/dist/packem_shared/walk-include-yUdRrF16.cjs +23 -0
- package/dist/packem_shared/walkSync-BzxdFWLU.mjs +103 -0
- package/dist/packem_shared/walkSync-DgPj93NL.cjs +105 -0
- package/dist/packem_shared/writeFile-B7dhfseN.mjs +58 -0
- package/dist/packem_shared/writeFile-DKu5-M8x.cjs +60 -0
- package/dist/packem_shared/writeFileSync-Db6pmY0q.cjs +60 -0
- package/dist/packem_shared/writeFileSync-mMGYqOc8.mjs +58 -0
- package/dist/packem_shared/writeJson-BSQE2uFN.mjs +31 -0
- package/dist/packem_shared/writeJson-DtnnjTix.cjs +33 -0
- package/dist/packem_shared/writeJsonSync-C_i6LsGT.mjs +31 -0
- package/dist/packem_shared/writeJsonSync-Dz5-B2PD.cjs +33 -0
- package/dist/packem_shared/writeYaml-B-KoZN0E.cjs +14 -0
- package/dist/packem_shared/writeYaml-DSTzKc0_.mjs +12 -0
- package/dist/packem_shared/writeYamlSync-D6borSP1.cjs +14 -0
- package/dist/packem_shared/writeYamlSync-agxYIea0.mjs +12 -0
- package/dist/utils.cjs +19 -1
- package/dist/utils.mjs +6 -1
- package/package.json +15 -16
- package/dist/packem_shared/AlreadyExistsError-CEu6_Tjb.mjs +0 -1
- package/dist/packem_shared/AlreadyExistsError-GC2XUgzJ.cjs +0 -1
- package/dist/packem_shared/DirectoryError-B8wqer68.cjs +0 -1
- package/dist/packem_shared/DirectoryError-ddlbUV8C.mjs +0 -1
- package/dist/packem_shared/F_OK-6WAweffB.cjs +0 -1
- package/dist/packem_shared/F_OK-B71i3mUa.mjs +0 -1
- package/dist/packem_shared/JSONError-CVkb3xZ3.mjs +0 -4
- package/dist/packem_shared/JSONError-CWuiGmNc.cjs +0 -4
- package/dist/packem_shared/LF-D4BqIfQm.cjs +0 -3
- package/dist/packem_shared/LF-Dbx0i6a7.mjs +0 -3
- package/dist/packem_shared/NotEmptyError-BWGfec5K.cjs +0 -1
- package/dist/packem_shared/NotEmptyError-DMh1o7UL.mjs +0 -1
- package/dist/packem_shared/NotFoundError-Diij7oqe.cjs +0 -1
- package/dist/packem_shared/NotFoundError-T95YsWYl.mjs +0 -1
- package/dist/packem_shared/PermissionError-B8oi38Bx.mjs +0 -1
- package/dist/packem_shared/PermissionError-Ck1Es7al.cjs +0 -1
- package/dist/packem_shared/WalkError-BsngoIKJ.mjs +0 -1
- package/dist/packem_shared/WalkError-gKgp0TWD.cjs +0 -1
- package/dist/packem_shared/assertValidFileContents-BLhwm7u2.mjs +0 -1
- package/dist/packem_shared/assertValidFileContents-CrbDz09d.cjs +0 -1
- package/dist/packem_shared/assertValidFileOrDirectoryPath-DgPIPmZT.mjs +0 -1
- package/dist/packem_shared/assertValidFileOrDirectoryPath-HOUs73Jk.cjs +0 -1
- package/dist/packem_shared/collect-4au76gDu.cjs +0 -1
- package/dist/packem_shared/collect-CRzGiRGg.mjs +0 -1
- package/dist/packem_shared/collectSync-BE8DAOke.mjs +0 -1
- package/dist/packem_shared/collectSync-CbKwt8rz.cjs +0 -1
- package/dist/packem_shared/emptyDir-D2m8OP8u.mjs +0 -1
- package/dist/packem_shared/emptyDir-DKxQHQQb.cjs +0 -1
- package/dist/packem_shared/emptyDirSync-CLM_zyIb.cjs +0 -1
- package/dist/packem_shared/emptyDirSync-CZNcW4wc.mjs +0 -1
- package/dist/packem_shared/ensureDir-BtvxsJiS.mjs +0 -1
- package/dist/packem_shared/ensureDir-DVHj-_yp.cjs +0 -1
- package/dist/packem_shared/ensureDirSync-CvjJ3bGq.cjs +0 -1
- package/dist/packem_shared/ensureDirSync-bGe0QB7d.mjs +0 -1
- package/dist/packem_shared/ensureFile-C46R6-4l.mjs +0 -1
- package/dist/packem_shared/ensureFile-CcJ5XIZm.cjs +0 -1
- package/dist/packem_shared/ensureFileSync-CwYTIP4G.mjs +0 -1
- package/dist/packem_shared/ensureFileSync-v-PhMLTr.cjs +0 -1
- package/dist/packem_shared/ensureLink-63XWiA3I.mjs +0 -1
- package/dist/packem_shared/ensureLink-C-v4AxzH.cjs +0 -1
- package/dist/packem_shared/ensureLinkSync-C4S-zdVb.cjs +0 -1
- package/dist/packem_shared/ensureLinkSync-D2LVObKd.mjs +0 -1
- package/dist/packem_shared/ensureSymlink-C5cy9585.cjs +0 -1
- package/dist/packem_shared/ensureSymlink-D36fS4KE.mjs +0 -1
- package/dist/packem_shared/ensureSymlinkSync-PvWVgeXc.mjs +0 -1
- package/dist/packem_shared/ensureSymlinkSync-YDRbg9hX.cjs +0 -1
- package/dist/packem_shared/findUp-CMGMYNty.mjs +0 -1
- package/dist/packem_shared/findUp-VKPTLmQQ.cjs +0 -1
- package/dist/packem_shared/findUpSync-BFwDGxkV.cjs +0 -1
- package/dist/packem_shared/findUpSync-QP_ZEsJN.mjs +0 -1
- package/dist/packem_shared/get-file-info-type-BXcpoWEM.cjs +0 -1
- package/dist/packem_shared/get-file-info-type-CaWGXRjY.mjs +0 -1
- package/dist/packem_shared/index-Cms6lU4T.cjs +0 -1
- package/dist/packem_shared/index-VcQXVcaq.mjs +0 -1
- package/dist/packem_shared/is-stats-identical-CPCumzsC.cjs +0 -1
- package/dist/packem_shared/is-stats-identical-CS5Y91zW.mjs +0 -1
- package/dist/packem_shared/isAccessible-Be3NKjOk.cjs +0 -1
- package/dist/packem_shared/isAccessible-cO53WedI.mjs +0 -1
- package/dist/packem_shared/isAccessibleSync-D5Vc2GTD.mjs +0 -1
- package/dist/packem_shared/isAccessibleSync-WOSgkAy2.cjs +0 -1
- package/dist/packem_shared/move-MZ9F6paN.mjs +0 -1
- package/dist/packem_shared/move-j3mzcWrG.cjs +0 -1
- package/dist/packem_shared/parseJson-BIYrZWHm.mjs +0 -6
- package/dist/packem_shared/parseJson-CXe73j5t.cjs +0 -6
- package/dist/packem_shared/readFile-CFus1Rym.mjs +0 -1
- package/dist/packem_shared/readFile-fzYtUKuW.cjs +0 -1
- package/dist/packem_shared/readFileSync-Dz4jLcWc.cjs +0 -1
- package/dist/packem_shared/readFileSync-Ulz6QzOz.mjs +0 -1
- package/dist/packem_shared/readJson-C6RN16Rf.mjs +0 -1
- package/dist/packem_shared/readJson-D7_CYUJX.cjs +0 -1
- package/dist/packem_shared/readJsonSync-QziPGqW_.cjs +0 -1
- package/dist/packem_shared/readJsonSync-ztZXpE8z.mjs +0 -1
- package/dist/packem_shared/readYaml-C-ui8qXw.cjs +0 -1
- package/dist/packem_shared/readYaml-aFHfT-4e.mjs +0 -1
- package/dist/packem_shared/readYamlSync-CeJ6RnoJ.mjs +0 -1
- package/dist/packem_shared/readYamlSync-DUYMSemC.cjs +0 -1
- package/dist/packem_shared/remove-B-9MI2l5.cjs +0 -1
- package/dist/packem_shared/remove-DzfvbZOm.mjs +0 -1
- package/dist/packem_shared/removeSync-CJPR6M7V.cjs +0 -1
- package/dist/packem_shared/removeSync-D165rXSn.mjs +0 -1
- package/dist/packem_shared/resolve-symlink-target-BofZSDIc.mjs +0 -1
- package/dist/packem_shared/resolve-symlink-target-HnbdXA1S.cjs +0 -1
- package/dist/packem_shared/stripJsonComments-CKgR4nW4.mjs +0 -1
- package/dist/packem_shared/stripJsonComments-Cw7UCxI3.cjs +0 -1
- package/dist/packem_shared/to-uint-8-array-2-3EvGd7.cjs +0 -1
- package/dist/packem_shared/to-uint-8-array-DwgaTasY.mjs +0 -1
- package/dist/packem_shared/walk-BJgnJy5d.cjs +0 -1
- package/dist/packem_shared/walk-DH-95i_B.mjs +0 -1
- package/dist/packem_shared/walk-include-B-MbUqMt.mjs +0 -1
- package/dist/packem_shared/walk-include-CFIYniQi.cjs +0 -1
- package/dist/packem_shared/walkSync-D4zvt_kM.mjs +0 -1
- package/dist/packem_shared/walkSync-DYawhxUA.cjs +0 -1
- package/dist/packem_shared/writeFile-DaHzc_FW.mjs +0 -1
- package/dist/packem_shared/writeFile-WCuWZNRy.cjs +0 -1
- package/dist/packem_shared/writeFileSync-D9HGh6J-.mjs +0 -1
- package/dist/packem_shared/writeFileSync-Ds49_ORi.cjs +0 -1
- package/dist/packem_shared/writeJson-BdjtBy1t.cjs +0 -4
- package/dist/packem_shared/writeJson-Bu7Dw4Uu.mjs +0 -4
- package/dist/packem_shared/writeJsonSync-7CjNn7oo.mjs +0 -4
- package/dist/packem_shared/writeJsonSync-CdC3ahaO.cjs +0 -4
- package/dist/packem_shared/writeYaml-COWffUNm.cjs +0 -1
- package/dist/packem_shared/writeYaml-bi1dx696.mjs +0 -1
- package/dist/packem_shared/writeYamlSync-BpIN1tTP.cjs +0 -1
- package/dist/packem_shared/writeYamlSync-D2VPlEws.mjs +0 -1
package/README.md
CHANGED
|
@@ -475,7 +475,7 @@ The error message.
|
|
|
475
475
|
|
|
476
476
|
###### Defined in
|
|
477
477
|
|
|
478
|
-
[packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
478
|
+
[packages/fs/src/error/already-exists-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/already-exists-error.ts#L9)
|
|
479
479
|
|
|
480
480
|
#### Accessors
|
|
481
481
|
|
|
@@ -499,7 +499,7 @@ set code(_name): void
|
|
|
499
499
|
|
|
500
500
|
###### Defined in
|
|
501
501
|
|
|
502
|
-
[packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
502
|
+
[packages/fs/src/error/already-exists-error.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/already-exists-error.ts#L14)
|
|
503
503
|
|
|
504
504
|
##### name
|
|
505
505
|
|
|
@@ -525,7 +525,7 @@ set name(_name): void
|
|
|
525
525
|
|
|
526
526
|
###### Defined in
|
|
527
527
|
|
|
528
|
-
[packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
528
|
+
[packages/fs/src/error/already-exists-error.ts:24](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/already-exists-error.ts#L24)
|
|
529
529
|
|
|
530
530
|
#### Methods
|
|
531
531
|
|
|
@@ -553,7 +553,7 @@ Create .stack property on a target object
|
|
|
553
553
|
|
|
554
554
|
###### Defined in
|
|
555
555
|
|
|
556
|
-
|
|
556
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
557
557
|
|
|
558
558
|
#### Properties
|
|
559
559
|
|
|
@@ -569,7 +569,7 @@ optional cause: unknown;
|
|
|
569
569
|
|
|
570
570
|
###### Defined in
|
|
571
571
|
|
|
572
|
-
|
|
572
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
573
573
|
|
|
574
574
|
##### message
|
|
575
575
|
|
|
@@ -583,7 +583,7 @@ message: string;
|
|
|
583
583
|
|
|
584
584
|
###### Defined in
|
|
585
585
|
|
|
586
|
-
|
|
586
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
587
587
|
|
|
588
588
|
##### stack?
|
|
589
589
|
|
|
@@ -597,7 +597,7 @@ optional stack: string;
|
|
|
597
597
|
|
|
598
598
|
###### Defined in
|
|
599
599
|
|
|
600
|
-
|
|
600
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
601
601
|
|
|
602
602
|
##### prepareStackTrace()?
|
|
603
603
|
|
|
@@ -627,7 +627,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
627
627
|
|
|
628
628
|
###### Defined in
|
|
629
629
|
|
|
630
|
-
|
|
630
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
631
631
|
|
|
632
632
|
##### stackTraceLimit
|
|
633
633
|
|
|
@@ -641,9 +641,9 @@ static stackTraceLimit: number;
|
|
|
641
641
|
|
|
642
642
|
###### Defined in
|
|
643
643
|
|
|
644
|
-
|
|
644
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
645
645
|
|
|
646
|
-
|
|
646
|
+
---
|
|
647
647
|
|
|
648
648
|
### DirectoryError
|
|
649
649
|
|
|
@@ -679,7 +679,7 @@ The error message.
|
|
|
679
679
|
|
|
680
680
|
###### Defined in
|
|
681
681
|
|
|
682
|
-
[packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
682
|
+
[packages/fs/src/error/directory-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/directory-error.ts#L9)
|
|
683
683
|
|
|
684
684
|
#### Accessors
|
|
685
685
|
|
|
@@ -703,7 +703,7 @@ set code(_name): void
|
|
|
703
703
|
|
|
704
704
|
###### Defined in
|
|
705
705
|
|
|
706
|
-
[packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
706
|
+
[packages/fs/src/error/directory-error.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/directory-error.ts#L14)
|
|
707
707
|
|
|
708
708
|
##### name
|
|
709
709
|
|
|
@@ -729,7 +729,7 @@ set name(_name): void
|
|
|
729
729
|
|
|
730
730
|
###### Defined in
|
|
731
731
|
|
|
732
|
-
[packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
732
|
+
[packages/fs/src/error/directory-error.ts:24](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/directory-error.ts#L24)
|
|
733
733
|
|
|
734
734
|
#### Methods
|
|
735
735
|
|
|
@@ -757,7 +757,7 @@ Create .stack property on a target object
|
|
|
757
757
|
|
|
758
758
|
###### Defined in
|
|
759
759
|
|
|
760
|
-
|
|
760
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
761
761
|
|
|
762
762
|
#### Properties
|
|
763
763
|
|
|
@@ -773,7 +773,7 @@ optional cause: unknown;
|
|
|
773
773
|
|
|
774
774
|
###### Defined in
|
|
775
775
|
|
|
776
|
-
|
|
776
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
777
777
|
|
|
778
778
|
##### message
|
|
779
779
|
|
|
@@ -787,7 +787,7 @@ message: string;
|
|
|
787
787
|
|
|
788
788
|
###### Defined in
|
|
789
789
|
|
|
790
|
-
|
|
790
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
791
791
|
|
|
792
792
|
##### stack?
|
|
793
793
|
|
|
@@ -801,7 +801,7 @@ optional stack: string;
|
|
|
801
801
|
|
|
802
802
|
###### Defined in
|
|
803
803
|
|
|
804
|
-
|
|
804
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
805
805
|
|
|
806
806
|
##### prepareStackTrace()?
|
|
807
807
|
|
|
@@ -831,7 +831,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
831
831
|
|
|
832
832
|
###### Defined in
|
|
833
833
|
|
|
834
|
-
|
|
834
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
835
835
|
|
|
836
836
|
##### stackTraceLimit
|
|
837
837
|
|
|
@@ -845,9 +845,9 @@ static stackTraceLimit: number;
|
|
|
845
845
|
|
|
846
846
|
###### Defined in
|
|
847
847
|
|
|
848
|
-
|
|
848
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
849
849
|
|
|
850
|
-
|
|
850
|
+
---
|
|
851
851
|
|
|
852
852
|
### NotEmptyError
|
|
853
853
|
|
|
@@ -883,7 +883,7 @@ The error message.
|
|
|
883
883
|
|
|
884
884
|
###### Defined in
|
|
885
885
|
|
|
886
|
-
[packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
886
|
+
[packages/fs/src/error/not-empty-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-empty-error.ts#L9)
|
|
887
887
|
|
|
888
888
|
#### Accessors
|
|
889
889
|
|
|
@@ -907,7 +907,7 @@ set code(_name): void
|
|
|
907
907
|
|
|
908
908
|
###### Defined in
|
|
909
909
|
|
|
910
|
-
[packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
910
|
+
[packages/fs/src/error/not-empty-error.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-empty-error.ts#L14)
|
|
911
911
|
|
|
912
912
|
##### name
|
|
913
913
|
|
|
@@ -933,7 +933,7 @@ set name(_name): void
|
|
|
933
933
|
|
|
934
934
|
###### Defined in
|
|
935
935
|
|
|
936
|
-
[packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
936
|
+
[packages/fs/src/error/not-empty-error.ts:24](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-empty-error.ts#L24)
|
|
937
937
|
|
|
938
938
|
#### Methods
|
|
939
939
|
|
|
@@ -961,7 +961,7 @@ Create .stack property on a target object
|
|
|
961
961
|
|
|
962
962
|
###### Defined in
|
|
963
963
|
|
|
964
|
-
|
|
964
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
965
965
|
|
|
966
966
|
#### Properties
|
|
967
967
|
|
|
@@ -977,7 +977,7 @@ optional cause: unknown;
|
|
|
977
977
|
|
|
978
978
|
###### Defined in
|
|
979
979
|
|
|
980
|
-
|
|
980
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
981
981
|
|
|
982
982
|
##### message
|
|
983
983
|
|
|
@@ -991,7 +991,7 @@ message: string;
|
|
|
991
991
|
|
|
992
992
|
###### Defined in
|
|
993
993
|
|
|
994
|
-
|
|
994
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
995
995
|
|
|
996
996
|
##### stack?
|
|
997
997
|
|
|
@@ -1005,7 +1005,7 @@ optional stack: string;
|
|
|
1005
1005
|
|
|
1006
1006
|
###### Defined in
|
|
1007
1007
|
|
|
1008
|
-
|
|
1008
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1009
1009
|
|
|
1010
1010
|
##### prepareStackTrace()?
|
|
1011
1011
|
|
|
@@ -1035,7 +1035,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1035
1035
|
|
|
1036
1036
|
###### Defined in
|
|
1037
1037
|
|
|
1038
|
-
|
|
1038
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1039
1039
|
|
|
1040
1040
|
##### stackTraceLimit
|
|
1041
1041
|
|
|
@@ -1049,9 +1049,9 @@ static stackTraceLimit: number;
|
|
|
1049
1049
|
|
|
1050
1050
|
###### Defined in
|
|
1051
1051
|
|
|
1052
|
-
|
|
1052
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
1053
1053
|
|
|
1054
|
-
|
|
1054
|
+
---
|
|
1055
1055
|
|
|
1056
1056
|
### NotFoundError
|
|
1057
1057
|
|
|
@@ -1087,7 +1087,7 @@ The error message.
|
|
|
1087
1087
|
|
|
1088
1088
|
###### Defined in
|
|
1089
1089
|
|
|
1090
|
-
[packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1090
|
+
[packages/fs/src/error/not-found-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-found-error.ts#L9)
|
|
1091
1091
|
|
|
1092
1092
|
#### Accessors
|
|
1093
1093
|
|
|
@@ -1111,7 +1111,7 @@ set code(_name): void
|
|
|
1111
1111
|
|
|
1112
1112
|
###### Defined in
|
|
1113
1113
|
|
|
1114
|
-
[packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
1114
|
+
[packages/fs/src/error/not-found-error.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-found-error.ts#L14)
|
|
1115
1115
|
|
|
1116
1116
|
##### name
|
|
1117
1117
|
|
|
@@ -1137,7 +1137,7 @@ set name(_name): void
|
|
|
1137
1137
|
|
|
1138
1138
|
###### Defined in
|
|
1139
1139
|
|
|
1140
|
-
[packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1140
|
+
[packages/fs/src/error/not-found-error.ts:24](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/not-found-error.ts#L24)
|
|
1141
1141
|
|
|
1142
1142
|
#### Methods
|
|
1143
1143
|
|
|
@@ -1165,7 +1165,7 @@ Create .stack property on a target object
|
|
|
1165
1165
|
|
|
1166
1166
|
###### Defined in
|
|
1167
1167
|
|
|
1168
|
-
|
|
1168
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1169
1169
|
|
|
1170
1170
|
#### Properties
|
|
1171
1171
|
|
|
@@ -1181,7 +1181,7 @@ optional cause: unknown;
|
|
|
1181
1181
|
|
|
1182
1182
|
###### Defined in
|
|
1183
1183
|
|
|
1184
|
-
|
|
1184
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
1185
1185
|
|
|
1186
1186
|
##### message
|
|
1187
1187
|
|
|
@@ -1195,7 +1195,7 @@ message: string;
|
|
|
1195
1195
|
|
|
1196
1196
|
###### Defined in
|
|
1197
1197
|
|
|
1198
|
-
|
|
1198
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1199
1199
|
|
|
1200
1200
|
##### stack?
|
|
1201
1201
|
|
|
@@ -1209,7 +1209,7 @@ optional stack: string;
|
|
|
1209
1209
|
|
|
1210
1210
|
###### Defined in
|
|
1211
1211
|
|
|
1212
|
-
|
|
1212
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1213
1213
|
|
|
1214
1214
|
##### prepareStackTrace()?
|
|
1215
1215
|
|
|
@@ -1239,7 +1239,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1239
1239
|
|
|
1240
1240
|
###### Defined in
|
|
1241
1241
|
|
|
1242
|
-
|
|
1242
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1243
1243
|
|
|
1244
1244
|
##### stackTraceLimit
|
|
1245
1245
|
|
|
@@ -1253,9 +1253,9 @@ static stackTraceLimit: number;
|
|
|
1253
1253
|
|
|
1254
1254
|
###### Defined in
|
|
1255
1255
|
|
|
1256
|
-
|
|
1256
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
1257
1257
|
|
|
1258
|
-
|
|
1258
|
+
---
|
|
1259
1259
|
|
|
1260
1260
|
### PermissionError
|
|
1261
1261
|
|
|
@@ -1291,7 +1291,7 @@ The error message.
|
|
|
1291
1291
|
|
|
1292
1292
|
###### Defined in
|
|
1293
1293
|
|
|
1294
|
-
[packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1294
|
+
[packages/fs/src/error/permission-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/permission-error.ts#L9)
|
|
1295
1295
|
|
|
1296
1296
|
#### Accessors
|
|
1297
1297
|
|
|
@@ -1315,7 +1315,7 @@ set code(_name): void
|
|
|
1315
1315
|
|
|
1316
1316
|
###### Defined in
|
|
1317
1317
|
|
|
1318
|
-
[packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/
|
|
1318
|
+
[packages/fs/src/error/permission-error.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/permission-error.ts#L14)
|
|
1319
1319
|
|
|
1320
1320
|
##### name
|
|
1321
1321
|
|
|
@@ -1341,7 +1341,7 @@ set name(_name): void
|
|
|
1341
1341
|
|
|
1342
1342
|
###### Defined in
|
|
1343
1343
|
|
|
1344
|
-
[packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/
|
|
1344
|
+
[packages/fs/src/error/permission-error.ts:24](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/permission-error.ts#L24)
|
|
1345
1345
|
|
|
1346
1346
|
#### Methods
|
|
1347
1347
|
|
|
@@ -1369,7 +1369,7 @@ Create .stack property on a target object
|
|
|
1369
1369
|
|
|
1370
1370
|
###### Defined in
|
|
1371
1371
|
|
|
1372
|
-
|
|
1372
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1373
1373
|
|
|
1374
1374
|
#### Properties
|
|
1375
1375
|
|
|
@@ -1385,7 +1385,7 @@ optional cause: unknown;
|
|
|
1385
1385
|
|
|
1386
1386
|
###### Defined in
|
|
1387
1387
|
|
|
1388
|
-
|
|
1388
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
1389
1389
|
|
|
1390
1390
|
##### message
|
|
1391
1391
|
|
|
@@ -1399,7 +1399,7 @@ message: string;
|
|
|
1399
1399
|
|
|
1400
1400
|
###### Defined in
|
|
1401
1401
|
|
|
1402
|
-
|
|
1402
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1403
1403
|
|
|
1404
1404
|
##### stack?
|
|
1405
1405
|
|
|
@@ -1413,7 +1413,7 @@ optional stack: string;
|
|
|
1413
1413
|
|
|
1414
1414
|
###### Defined in
|
|
1415
1415
|
|
|
1416
|
-
|
|
1416
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1417
1417
|
|
|
1418
1418
|
##### prepareStackTrace()?
|
|
1419
1419
|
|
|
@@ -1443,7 +1443,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1443
1443
|
|
|
1444
1444
|
###### Defined in
|
|
1445
1445
|
|
|
1446
|
-
|
|
1446
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1447
1447
|
|
|
1448
1448
|
##### stackTraceLimit
|
|
1449
1449
|
|
|
@@ -1457,9 +1457,9 @@ static stackTraceLimit: number;
|
|
|
1457
1457
|
|
|
1458
1458
|
###### Defined in
|
|
1459
1459
|
|
|
1460
|
-
|
|
1460
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
1461
1461
|
|
|
1462
|
-
|
|
1462
|
+
---
|
|
1463
1463
|
|
|
1464
1464
|
### WalkError
|
|
1465
1465
|
|
|
@@ -1495,7 +1495,7 @@ Constructs a new instance.
|
|
|
1495
1495
|
|
|
1496
1496
|
###### Defined in
|
|
1497
1497
|
|
|
1498
|
-
[packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/
|
|
1498
|
+
[packages/fs/src/error/walk-error.ts:12](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/walk-error.ts#L12)
|
|
1499
1499
|
|
|
1500
1500
|
#### Accessors
|
|
1501
1501
|
|
|
@@ -1523,7 +1523,7 @@ set name(_name): void
|
|
|
1523
1523
|
|
|
1524
1524
|
###### Defined in
|
|
1525
1525
|
|
|
1526
|
-
[packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
1526
|
+
[packages/fs/src/error/walk-error.ts:21](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/walk-error.ts#L21)
|
|
1527
1527
|
|
|
1528
1528
|
#### Methods
|
|
1529
1529
|
|
|
@@ -1551,7 +1551,7 @@ Create .stack property on a target object
|
|
|
1551
1551
|
|
|
1552
1552
|
###### Defined in
|
|
1553
1553
|
|
|
1554
|
-
|
|
1554
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
1555
1555
|
|
|
1556
1556
|
#### Properties
|
|
1557
1557
|
|
|
@@ -1567,7 +1567,7 @@ optional cause: unknown;
|
|
|
1567
1567
|
|
|
1568
1568
|
###### Defined in
|
|
1569
1569
|
|
|
1570
|
-
|
|
1570
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
1571
1571
|
|
|
1572
1572
|
##### message
|
|
1573
1573
|
|
|
@@ -1581,7 +1581,7 @@ message: string;
|
|
|
1581
1581
|
|
|
1582
1582
|
###### Defined in
|
|
1583
1583
|
|
|
1584
|
-
|
|
1584
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1077
|
|
1585
1585
|
|
|
1586
1586
|
##### root
|
|
1587
1587
|
|
|
@@ -1593,7 +1593,7 @@ File path of the root that's being walked.
|
|
|
1593
1593
|
|
|
1594
1594
|
###### Defined in
|
|
1595
1595
|
|
|
1596
|
-
[packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/
|
|
1596
|
+
[packages/fs/src/error/walk-error.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/walk-error.ts#L9)
|
|
1597
1597
|
|
|
1598
1598
|
##### stack?
|
|
1599
1599
|
|
|
@@ -1607,7 +1607,7 @@ optional stack: string;
|
|
|
1607
1607
|
|
|
1608
1608
|
###### Defined in
|
|
1609
1609
|
|
|
1610
|
-
|
|
1610
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
1611
1611
|
|
|
1612
1612
|
##### prepareStackTrace()?
|
|
1613
1613
|
|
|
@@ -1637,7 +1637,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
1637
1637
|
|
|
1638
1638
|
###### Defined in
|
|
1639
1639
|
|
|
1640
|
-
|
|
1640
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
1641
1641
|
|
|
1642
1642
|
##### stackTraceLimit
|
|
1643
1643
|
|
|
@@ -1651,13 +1651,14 @@ static stackTraceLimit: number;
|
|
|
1651
1651
|
|
|
1652
1652
|
###### Defined in
|
|
1653
1653
|
|
|
1654
|
-
|
|
1654
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
1655
1655
|
|
|
1656
1656
|
## References
|
|
1657
1657
|
|
|
1658
1658
|
### JSONError
|
|
1659
1659
|
|
|
1660
1660
|
Re-exports [JSONError](utils.md#jsonerror)
|
|
1661
|
+
|
|
1661
1662
|
# index
|
|
1662
1663
|
|
|
1663
1664
|
## Functions
|
|
@@ -1665,7 +1666,7 @@ Re-exports [JSONError](utils.md#jsonerror)
|
|
|
1665
1666
|
### collect()
|
|
1666
1667
|
|
|
1667
1668
|
```ts
|
|
1668
|
-
function collect(directory, options): Promise<string[]
|
|
1669
|
+
function collect(directory, options): Promise<string[]>;
|
|
1669
1670
|
```
|
|
1670
1671
|
|
|
1671
1672
|
#### Parameters
|
|
@@ -1680,14 +1681,14 @@ function collect(directory, options): Promise<string[]>
|
|
|
1680
1681
|
|
|
1681
1682
|
#### Defined in
|
|
1682
1683
|
|
|
1683
|
-
[packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/
|
|
1684
|
+
[packages/fs/src/find/collect.ts:4](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/find/collect.ts#L4)
|
|
1684
1685
|
|
|
1685
|
-
|
|
1686
|
+
---
|
|
1686
1687
|
|
|
1687
1688
|
### collectSync()
|
|
1688
1689
|
|
|
1689
1690
|
```ts
|
|
1690
|
-
function collectSync(directory, options): string[]
|
|
1691
|
+
function collectSync(directory, options): string[];
|
|
1691
1692
|
```
|
|
1692
1693
|
|
|
1693
1694
|
#### Parameters
|
|
@@ -1702,14 +1703,14 @@ function collectSync(directory, options): string[]
|
|
|
1702
1703
|
|
|
1703
1704
|
#### Defined in
|
|
1704
1705
|
|
|
1705
|
-
[packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/
|
|
1706
|
+
[packages/fs/src/find/collect-sync.ts:4](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/find/collect-sync.ts#L4)
|
|
1706
1707
|
|
|
1707
|
-
|
|
1708
|
+
---
|
|
1708
1709
|
|
|
1709
1710
|
### detect()
|
|
1710
1711
|
|
|
1711
1712
|
```ts
|
|
1712
|
-
function detect(content): "\n" | "\r\n"
|
|
1713
|
+
function detect(content): "\n" | "\r\n";
|
|
1713
1714
|
```
|
|
1714
1715
|
|
|
1715
1716
|
Detect the EOL character for string input.
|
|
@@ -1725,14 +1726,14 @@ Returns null if no newline.
|
|
|
1725
1726
|
|
|
1726
1727
|
#### Defined in
|
|
1727
1728
|
|
|
1728
|
-
[packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/
|
|
1729
|
+
[packages/fs/src/eol.ts:20](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L20)
|
|
1729
1730
|
|
|
1730
|
-
|
|
1731
|
+
---
|
|
1731
1732
|
|
|
1732
1733
|
### emptyDir()
|
|
1733
1734
|
|
|
1734
1735
|
```ts
|
|
1735
|
-
function emptyDir(dir, options?): Promise<void
|
|
1736
|
+
function emptyDir(dir, options?): Promise<void>;
|
|
1736
1737
|
```
|
|
1737
1738
|
|
|
1738
1739
|
Ensures that a directory is empty.
|
|
@@ -1752,14 +1753,14 @@ The directory itself is not deleted.
|
|
|
1752
1753
|
|
|
1753
1754
|
#### Defined in
|
|
1754
1755
|
|
|
1755
|
-
[packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/
|
|
1756
|
+
[packages/fs/src/remove/empty-dir.ts:19](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/remove/empty-dir.ts#L19)
|
|
1756
1757
|
|
|
1757
|
-
|
|
1758
|
+
---
|
|
1758
1759
|
|
|
1759
1760
|
### emptyDirSync()
|
|
1760
1761
|
|
|
1761
1762
|
```ts
|
|
1762
|
-
function emptyDirSync(dir, options?): void
|
|
1763
|
+
function emptyDirSync(dir, options?): void;
|
|
1763
1764
|
```
|
|
1764
1765
|
|
|
1765
1766
|
Ensures that a directory is empty.
|
|
@@ -1779,14 +1780,14 @@ The directory itself is not deleted.
|
|
|
1779
1780
|
|
|
1780
1781
|
#### Defined in
|
|
1781
1782
|
|
|
1782
|
-
[packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
1783
|
+
[packages/fs/src/remove/empty-dir-sync.ts:18](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/remove/empty-dir-sync.ts#L18)
|
|
1783
1784
|
|
|
1784
|
-
|
|
1785
|
+
---
|
|
1785
1786
|
|
|
1786
1787
|
### ensureDir()
|
|
1787
1788
|
|
|
1788
1789
|
```ts
|
|
1789
|
-
function ensureDir(directory): Promise<void
|
|
1790
|
+
function ensureDir(directory): Promise<void>;
|
|
1790
1791
|
```
|
|
1791
1792
|
|
|
1792
1793
|
Ensures that the directory exists.
|
|
@@ -1802,14 +1803,14 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
1802
1803
|
|
|
1803
1804
|
#### Defined in
|
|
1804
1805
|
|
|
1805
|
-
[packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/
|
|
1806
|
+
[packages/fs/src/ensure/ensure-dir.ts:12](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-dir.ts#L12)
|
|
1806
1807
|
|
|
1807
|
-
|
|
1808
|
+
---
|
|
1808
1809
|
|
|
1809
1810
|
### ensureDirSync()
|
|
1810
1811
|
|
|
1811
1812
|
```ts
|
|
1812
|
-
function ensureDirSync(directory): void
|
|
1813
|
+
function ensureDirSync(directory): void;
|
|
1813
1814
|
```
|
|
1814
1815
|
|
|
1815
1816
|
Ensures that the directory exists.
|
|
@@ -1825,14 +1826,14 @@ If the directory structure does not exist, it is created. Like mkdir -p.
|
|
|
1825
1826
|
|
|
1826
1827
|
#### Defined in
|
|
1827
1828
|
|
|
1828
|
-
[packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/
|
|
1829
|
+
[packages/fs/src/ensure/ensure-dir-sync.ts:12](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-dir-sync.ts#L12)
|
|
1829
1830
|
|
|
1830
|
-
|
|
1831
|
+
---
|
|
1831
1832
|
|
|
1832
1833
|
### ensureFile()
|
|
1833
1834
|
|
|
1834
1835
|
```ts
|
|
1835
|
-
function ensureFile(filePath): Promise<void
|
|
1836
|
+
function ensureFile(filePath): Promise<void>;
|
|
1836
1837
|
```
|
|
1837
1838
|
|
|
1838
1839
|
Ensures that the file exists.
|
|
@@ -1849,14 +1850,14 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
1849
1850
|
|
|
1850
1851
|
#### Defined in
|
|
1851
1852
|
|
|
1852
|
-
[packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/
|
|
1853
|
+
[packages/fs/src/ensure/ensure-file.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-file.ts#L16)
|
|
1853
1854
|
|
|
1854
|
-
|
|
1855
|
+
---
|
|
1855
1856
|
|
|
1856
1857
|
### ensureFileSync()
|
|
1857
1858
|
|
|
1858
1859
|
```ts
|
|
1859
|
-
function ensureFileSync(filePath): void
|
|
1860
|
+
function ensureFileSync(filePath): void;
|
|
1860
1861
|
```
|
|
1861
1862
|
|
|
1862
1863
|
Ensures that the file exists.
|
|
@@ -1873,14 +1874,14 @@ these directories are created. If the file already exists, it is NOTMODIFIED.
|
|
|
1873
1874
|
|
|
1874
1875
|
#### Defined in
|
|
1875
1876
|
|
|
1876
|
-
[packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
1877
|
+
[packages/fs/src/ensure/ensure-file-sync.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-file-sync.ts#L16)
|
|
1877
1878
|
|
|
1878
|
-
|
|
1879
|
+
---
|
|
1879
1880
|
|
|
1880
1881
|
### ensureLink()
|
|
1881
1882
|
|
|
1882
1883
|
```ts
|
|
1883
|
-
function ensureLink(source, destination): Promise<void
|
|
1884
|
+
function ensureLink(source, destination): Promise<void>;
|
|
1884
1885
|
```
|
|
1885
1886
|
|
|
1886
1887
|
Ensures that the hard link exists.
|
|
@@ -1898,14 +1899,14 @@ If the directory structure does not exist, it is created.
|
|
|
1898
1899
|
|
|
1899
1900
|
#### Defined in
|
|
1900
1901
|
|
|
1901
|
-
[packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/
|
|
1902
|
+
[packages/fs/src/ensure/ensure-link.ts:15](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-link.ts#L15)
|
|
1902
1903
|
|
|
1903
|
-
|
|
1904
|
+
---
|
|
1904
1905
|
|
|
1905
1906
|
### ensureLinkSync()
|
|
1906
1907
|
|
|
1907
1908
|
```ts
|
|
1908
|
-
function ensureLinkSync(source, destination): void
|
|
1909
|
+
function ensureLinkSync(source, destination): void;
|
|
1909
1910
|
```
|
|
1910
1911
|
|
|
1911
1912
|
Ensures that the hard link exists.
|
|
@@ -1923,17 +1924,14 @@ If the directory structure does not exist, it is created.
|
|
|
1923
1924
|
|
|
1924
1925
|
#### Defined in
|
|
1925
1926
|
|
|
1926
|
-
[packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
1927
|
+
[packages/fs/src/ensure/ensure-link-sync.ts:15](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-link-sync.ts#L15)
|
|
1927
1928
|
|
|
1928
|
-
|
|
1929
|
+
---
|
|
1929
1930
|
|
|
1930
1931
|
### ensureSymlink()
|
|
1931
1932
|
|
|
1932
1933
|
```ts
|
|
1933
|
-
function ensureSymlink(
|
|
1934
|
-
target,
|
|
1935
|
-
linkName,
|
|
1936
|
-
type?): Promise<void>
|
|
1934
|
+
function ensureSymlink(target, linkName, type?): Promise<void>;
|
|
1937
1935
|
```
|
|
1938
1936
|
|
|
1939
1937
|
Ensures that the link exists, and points to a valid file.
|
|
@@ -1962,17 +1960,14 @@ A void promise that resolves once the link exists.
|
|
|
1962
1960
|
|
|
1963
1961
|
#### Defined in
|
|
1964
1962
|
|
|
1965
|
-
[packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/
|
|
1963
|
+
[packages/fs/src/ensure/ensure-symlink.ts:28](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-symlink.ts#L28)
|
|
1966
1964
|
|
|
1967
|
-
|
|
1965
|
+
---
|
|
1968
1966
|
|
|
1969
1967
|
### ensureSymlinkSync()
|
|
1970
1968
|
|
|
1971
1969
|
```ts
|
|
1972
|
-
function ensureSymlinkSync(
|
|
1973
|
-
target,
|
|
1974
|
-
linkName,
|
|
1975
|
-
type?): void
|
|
1970
|
+
function ensureSymlinkSync(target, linkName, type?): void;
|
|
1976
1971
|
```
|
|
1977
1972
|
|
|
1978
1973
|
Ensures that the link exists, and points to a valid file.
|
|
@@ -2001,14 +1996,14 @@ A void.
|
|
|
2001
1996
|
|
|
2002
1997
|
#### Defined in
|
|
2003
1998
|
|
|
2004
|
-
[packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/
|
|
1999
|
+
[packages/fs/src/ensure/ensure-symlink-sync.ts:28](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/ensure/ensure-symlink-sync.ts#L28)
|
|
2005
2000
|
|
|
2006
|
-
|
|
2001
|
+
---
|
|
2007
2002
|
|
|
2008
2003
|
### findUp()
|
|
2009
2004
|
|
|
2010
2005
|
```ts
|
|
2011
|
-
function findUp(name, options): Promise<string
|
|
2006
|
+
function findUp(name, options): Promise<string>;
|
|
2012
2007
|
```
|
|
2013
2008
|
|
|
2014
2009
|
#### Parameters
|
|
@@ -2023,14 +2018,14 @@ function findUp(name, options): Promise<string>
|
|
|
2023
2018
|
|
|
2024
2019
|
#### Defined in
|
|
2025
2020
|
|
|
2026
|
-
[packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/
|
|
2021
|
+
[packages/fs/src/find/find-up.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/find/find-up.ts#L11)
|
|
2027
2022
|
|
|
2028
|
-
|
|
2023
|
+
---
|
|
2029
2024
|
|
|
2030
2025
|
### findUpSync()
|
|
2031
2026
|
|
|
2032
2027
|
```ts
|
|
2033
|
-
function findUpSync(name, options): string
|
|
2028
|
+
function findUpSync(name, options): string;
|
|
2034
2029
|
```
|
|
2035
2030
|
|
|
2036
2031
|
#### Parameters
|
|
@@ -2045,14 +2040,14 @@ function findUpSync(name, options): string
|
|
|
2045
2040
|
|
|
2046
2041
|
#### Defined in
|
|
2047
2042
|
|
|
2048
|
-
[packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
2043
|
+
[packages/fs/src/find/find-up-sync.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/find/find-up-sync.ts#L11)
|
|
2049
2044
|
|
|
2050
|
-
|
|
2045
|
+
---
|
|
2051
2046
|
|
|
2052
2047
|
### format()
|
|
2053
2048
|
|
|
2054
2049
|
```ts
|
|
2055
|
-
function format(content, eol): string
|
|
2050
|
+
function format(content, eol): string;
|
|
2056
2051
|
```
|
|
2057
2052
|
|
|
2058
2053
|
Format the file to the targeted EOL.
|
|
@@ -2069,14 +2064,14 @@ Format the file to the targeted EOL.
|
|
|
2069
2064
|
|
|
2070
2065
|
#### Defined in
|
|
2071
2066
|
|
|
2072
|
-
[packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/
|
|
2067
|
+
[packages/fs/src/eol.ts:36](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L36)
|
|
2073
2068
|
|
|
2074
|
-
|
|
2069
|
+
---
|
|
2075
2070
|
|
|
2076
2071
|
### isAccessible()
|
|
2077
2072
|
|
|
2078
2073
|
```ts
|
|
2079
|
-
function isAccessible(path, mode?): Promise<boolean
|
|
2074
|
+
function isAccessible(path, mode?): Promise<boolean>;
|
|
2080
2075
|
```
|
|
2081
2076
|
|
|
2082
2077
|
Returns a Promise that resolves to a boolean indicating if the path is accessible or not.
|
|
@@ -2093,14 +2088,14 @@ Returns a Promise that resolves to a boolean indicating if the path is accessibl
|
|
|
2093
2088
|
|
|
2094
2089
|
#### Defined in
|
|
2095
2090
|
|
|
2096
|
-
[packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/
|
|
2091
|
+
[packages/fs/src/is-accessible.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/is-accessible.ts#L9)
|
|
2097
2092
|
|
|
2098
|
-
|
|
2093
|
+
---
|
|
2099
2094
|
|
|
2100
2095
|
### isAccessibleSync()
|
|
2101
2096
|
|
|
2102
2097
|
```ts
|
|
2103
|
-
function isAccessibleSync(path, mode?): boolean
|
|
2098
|
+
function isAccessibleSync(path, mode?): boolean;
|
|
2104
2099
|
```
|
|
2105
2100
|
|
|
2106
2101
|
Returns a boolean indicating if the path is accessible or not.
|
|
@@ -2117,17 +2112,14 @@ Returns a boolean indicating if the path is accessible or not.
|
|
|
2117
2112
|
|
|
2118
2113
|
#### Defined in
|
|
2119
2114
|
|
|
2120
|
-
[packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/
|
|
2115
|
+
[packages/fs/src/is-accessible-sync.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/is-accessible-sync.ts#L9)
|
|
2121
2116
|
|
|
2122
|
-
|
|
2117
|
+
---
|
|
2123
2118
|
|
|
2124
2119
|
### move()
|
|
2125
2120
|
|
|
2126
2121
|
```ts
|
|
2127
|
-
function move(
|
|
2128
|
-
sourcePath,
|
|
2129
|
-
destinationPath,
|
|
2130
|
-
options): Promise<void>
|
|
2122
|
+
function move(sourcePath, destinationPath, options): Promise<void>;
|
|
2131
2123
|
```
|
|
2132
2124
|
|
|
2133
2125
|
Move a file asynchronously.
|
|
@@ -2163,17 +2155,14 @@ console.log('The file has been moved');
|
|
|
2163
2155
|
|
|
2164
2156
|
#### Defined in
|
|
2165
2157
|
|
|
2166
|
-
[packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/
|
|
2158
|
+
[packages/fs/src/move/index.ts:35](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L35)
|
|
2167
2159
|
|
|
2168
|
-
|
|
2160
|
+
---
|
|
2169
2161
|
|
|
2170
2162
|
### moveSync()
|
|
2171
2163
|
|
|
2172
2164
|
```ts
|
|
2173
|
-
function moveSync(
|
|
2174
|
-
sourcePath,
|
|
2175
|
-
destinationPath,
|
|
2176
|
-
options?): void
|
|
2165
|
+
function moveSync(sourcePath, destinationPath, options?): void;
|
|
2177
2166
|
```
|
|
2178
2167
|
|
|
2179
2168
|
Move a file synchronously.
|
|
@@ -2209,19 +2198,19 @@ console.log('The file has been moved');
|
|
|
2209
2198
|
|
|
2210
2199
|
#### Defined in
|
|
2211
2200
|
|
|
2212
|
-
[packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/
|
|
2201
|
+
[packages/fs/src/move/index.ts:61](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L61)
|
|
2213
2202
|
|
|
2214
|
-
|
|
2203
|
+
---
|
|
2215
2204
|
|
|
2216
2205
|
### readFile()
|
|
2217
2206
|
|
|
2218
2207
|
```ts
|
|
2219
|
-
function readFile<O>(path, options?): Promise<ContentType<O
|
|
2208
|
+
function readFile<O>(path, options?): Promise<ContentType<O>>;
|
|
2220
2209
|
```
|
|
2221
2210
|
|
|
2222
2211
|
#### Type Parameters
|
|
2223
2212
|
|
|
2224
|
-
• **O**
|
|
2213
|
+
• **O** _extends_ [`ReadFileOptions`](index.md#readfileoptionsc)\<`"brotli"` \| `"gzip"` \| `"none"`\> = `undefined`
|
|
2225
2214
|
|
|
2226
2215
|
#### Parameters
|
|
2227
2216
|
|
|
@@ -2235,19 +2224,19 @@ function readFile<O>(path, options?): Promise<ContentType<O>>
|
|
|
2235
2224
|
|
|
2236
2225
|
#### Defined in
|
|
2237
2226
|
|
|
2238
|
-
[packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/
|
|
2227
|
+
[packages/fs/src/read/read-file.ts:20](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-file.ts#L20)
|
|
2239
2228
|
|
|
2240
|
-
|
|
2229
|
+
---
|
|
2241
2230
|
|
|
2242
2231
|
### readFileSync()
|
|
2243
2232
|
|
|
2244
2233
|
```ts
|
|
2245
|
-
function readFileSync<O>(path, options?): ContentType<O
|
|
2234
|
+
function readFileSync<O>(path, options?): ContentType<O>;
|
|
2246
2235
|
```
|
|
2247
2236
|
|
|
2248
2237
|
#### Type Parameters
|
|
2249
2238
|
|
|
2250
|
-
• **O**
|
|
2239
|
+
• **O** _extends_ [`ReadFileOptions`](index.md#readfileoptionsc)\<`"brotli"` \| `"gzip"` \| `"none"`\> = `undefined`
|
|
2251
2240
|
|
|
2252
2241
|
#### Parameters
|
|
2253
2242
|
|
|
@@ -2261,21 +2250,21 @@ function readFileSync<O>(path, options?): ContentType<O>
|
|
|
2261
2250
|
|
|
2262
2251
|
#### Defined in
|
|
2263
2252
|
|
|
2264
|
-
[packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/
|
|
2253
|
+
[packages/fs/src/read/read-file-sync.ts:18](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-file-sync.ts#L18)
|
|
2265
2254
|
|
|
2266
|
-
|
|
2255
|
+
---
|
|
2267
2256
|
|
|
2268
2257
|
### readJson()
|
|
2269
2258
|
|
|
2270
2259
|
#### readJson(path, options)
|
|
2271
2260
|
|
|
2272
2261
|
```ts
|
|
2273
|
-
function readJson<T>(path, options?): Promise<T
|
|
2262
|
+
function readJson<T>(path, options?): Promise<T>;
|
|
2274
2263
|
```
|
|
2275
2264
|
|
|
2276
2265
|
##### Type Parameters
|
|
2277
2266
|
|
|
2278
|
-
• **T**
|
|
2267
|
+
• **T** _extends_ `JsonValue`
|
|
2279
2268
|
|
|
2280
2269
|
##### Parameters
|
|
2281
2270
|
|
|
@@ -2289,20 +2278,17 @@ function readJson<T>(path, options?): Promise<T>
|
|
|
2289
2278
|
|
|
2290
2279
|
##### Defined in
|
|
2291
2280
|
|
|
2292
|
-
[packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/
|
|
2281
|
+
[packages/fs/src/read/read-json.ts:8](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json.ts#L8)
|
|
2293
2282
|
|
|
2294
2283
|
#### readJson(path, reviver, options)
|
|
2295
2284
|
|
|
2296
2285
|
```ts
|
|
2297
|
-
function readJson<T>(
|
|
2298
|
-
path,
|
|
2299
|
-
reviver,
|
|
2300
|
-
options?): Promise<T>
|
|
2286
|
+
function readJson<T>(path, reviver, options?): Promise<T>;
|
|
2301
2287
|
```
|
|
2302
2288
|
|
|
2303
2289
|
##### Type Parameters
|
|
2304
2290
|
|
|
2305
|
-
• **T**
|
|
2291
|
+
• **T** _extends_ `JsonValue`
|
|
2306
2292
|
|
|
2307
2293
|
##### Parameters
|
|
2308
2294
|
|
|
@@ -2318,21 +2304,21 @@ options?): Promise<T>
|
|
|
2318
2304
|
|
|
2319
2305
|
##### Defined in
|
|
2320
2306
|
|
|
2321
|
-
[packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/
|
|
2307
|
+
[packages/fs/src/read/read-json.ts:10](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json.ts#L10)
|
|
2322
2308
|
|
|
2323
|
-
|
|
2309
|
+
---
|
|
2324
2310
|
|
|
2325
2311
|
### readJsonSync()
|
|
2326
2312
|
|
|
2327
2313
|
#### readJsonSync(path, options)
|
|
2328
2314
|
|
|
2329
2315
|
```ts
|
|
2330
|
-
function readJsonSync<T>(path, options?): T
|
|
2316
|
+
function readJsonSync<T>(path, options?): T;
|
|
2331
2317
|
```
|
|
2332
2318
|
|
|
2333
2319
|
##### Type Parameters
|
|
2334
2320
|
|
|
2335
|
-
• **T**
|
|
2321
|
+
• **T** _extends_ `JsonValue`
|
|
2336
2322
|
|
|
2337
2323
|
##### Parameters
|
|
2338
2324
|
|
|
@@ -2346,20 +2332,17 @@ function readJsonSync<T>(path, options?): T
|
|
|
2346
2332
|
|
|
2347
2333
|
##### Defined in
|
|
2348
2334
|
|
|
2349
|
-
[packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/
|
|
2335
|
+
[packages/fs/src/read/read-json-sync.ts:8](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json-sync.ts#L8)
|
|
2350
2336
|
|
|
2351
2337
|
#### readJsonSync(path, reviver, options)
|
|
2352
2338
|
|
|
2353
2339
|
```ts
|
|
2354
|
-
function readJsonSync<T>(
|
|
2355
|
-
path,
|
|
2356
|
-
reviver,
|
|
2357
|
-
options?): T
|
|
2340
|
+
function readJsonSync<T>(path, reviver, options?): T;
|
|
2358
2341
|
```
|
|
2359
2342
|
|
|
2360
2343
|
##### Type Parameters
|
|
2361
2344
|
|
|
2362
|
-
• **T**
|
|
2345
|
+
• **T** _extends_ `JsonValue`
|
|
2363
2346
|
|
|
2364
2347
|
##### Parameters
|
|
2365
2348
|
|
|
@@ -2375,16 +2358,16 @@ function readJsonSync<T>(
|
|
|
2375
2358
|
|
|
2376
2359
|
##### Defined in
|
|
2377
2360
|
|
|
2378
|
-
[packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
2361
|
+
[packages/fs/src/read/read-json-sync.ts:10](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-json-sync.ts#L10)
|
|
2379
2362
|
|
|
2380
|
-
|
|
2363
|
+
---
|
|
2381
2364
|
|
|
2382
2365
|
### readYaml()
|
|
2383
2366
|
|
|
2384
2367
|
#### readYaml(path, options)
|
|
2385
2368
|
|
|
2386
2369
|
```ts
|
|
2387
|
-
function readYaml<R>(path, options?): Promise<R
|
|
2370
|
+
function readYaml<R>(path, options?): Promise<R>;
|
|
2388
2371
|
```
|
|
2389
2372
|
|
|
2390
2373
|
##### Type Parameters
|
|
@@ -2403,15 +2386,12 @@ function readYaml<R>(path, options?): Promise<R>
|
|
|
2403
2386
|
|
|
2404
2387
|
##### Defined in
|
|
2405
2388
|
|
|
2406
|
-
[packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/
|
|
2389
|
+
[packages/fs/src/read/read-yaml.ts:6](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-yaml.ts#L6)
|
|
2407
2390
|
|
|
2408
2391
|
#### readYaml(path, reviver, options)
|
|
2409
2392
|
|
|
2410
2393
|
```ts
|
|
2411
|
-
function readYaml<R>(
|
|
2412
|
-
path,
|
|
2413
|
-
reviver?,
|
|
2414
|
-
options?): Promise<R>
|
|
2394
|
+
function readYaml<R>(path, reviver?, options?): Promise<R>;
|
|
2415
2395
|
```
|
|
2416
2396
|
|
|
2417
2397
|
##### Type Parameters
|
|
@@ -2432,16 +2412,16 @@ options?): Promise<R>
|
|
|
2432
2412
|
|
|
2433
2413
|
##### Defined in
|
|
2434
2414
|
|
|
2435
|
-
[packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/
|
|
2415
|
+
[packages/fs/src/read/read-yaml.ts:7](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-yaml.ts#L7)
|
|
2436
2416
|
|
|
2437
|
-
|
|
2417
|
+
---
|
|
2438
2418
|
|
|
2439
2419
|
### readYamlSync()
|
|
2440
2420
|
|
|
2441
2421
|
#### readYamlSync(path, options)
|
|
2442
2422
|
|
|
2443
2423
|
```ts
|
|
2444
|
-
function readYamlSync<R>(path, options?): R
|
|
2424
|
+
function readYamlSync<R>(path, options?): R;
|
|
2445
2425
|
```
|
|
2446
2426
|
|
|
2447
2427
|
##### Type Parameters
|
|
@@ -2460,15 +2440,12 @@ function readYamlSync<R>(path, options?): R
|
|
|
2460
2440
|
|
|
2461
2441
|
##### Defined in
|
|
2462
2442
|
|
|
2463
|
-
[packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/
|
|
2443
|
+
[packages/fs/src/read/read-yaml-sync.ts:6](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-yaml-sync.ts#L6)
|
|
2464
2444
|
|
|
2465
2445
|
#### readYamlSync(path, reviver, options)
|
|
2466
2446
|
|
|
2467
2447
|
```ts
|
|
2468
|
-
function readYamlSync<R>(
|
|
2469
|
-
path,
|
|
2470
|
-
reviver?,
|
|
2471
|
-
options?): R
|
|
2448
|
+
function readYamlSync<R>(path, reviver?, options?): R;
|
|
2472
2449
|
```
|
|
2473
2450
|
|
|
2474
2451
|
##### Type Parameters
|
|
@@ -2489,14 +2466,14 @@ function readYamlSync<R>(
|
|
|
2489
2466
|
|
|
2490
2467
|
##### Defined in
|
|
2491
2468
|
|
|
2492
|
-
[packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/
|
|
2469
|
+
[packages/fs/src/read/read-yaml-sync.ts:7](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/read/read-yaml-sync.ts#L7)
|
|
2493
2470
|
|
|
2494
|
-
|
|
2471
|
+
---
|
|
2495
2472
|
|
|
2496
2473
|
### remove()
|
|
2497
2474
|
|
|
2498
2475
|
```ts
|
|
2499
|
-
function remove(path, options): Promise<void
|
|
2476
|
+
function remove(path, options): Promise<void>;
|
|
2500
2477
|
```
|
|
2501
2478
|
|
|
2502
2479
|
#### Parameters
|
|
@@ -2516,7 +2493,7 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
2516
2493
|
**Default**
|
|
2517
2494
|
|
|
2518
2495
|
```ts
|
|
2519
|
-
0
|
|
2496
|
+
0;
|
|
2520
2497
|
```
|
|
2521
2498
|
|
|
2522
2499
|
• **options.retryDelay?**: `number`
|
|
@@ -2527,7 +2504,7 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2527
2504
|
**Default**
|
|
2528
2505
|
|
|
2529
2506
|
```ts
|
|
2530
|
-
100
|
|
2507
|
+
100;
|
|
2531
2508
|
```
|
|
2532
2509
|
|
|
2533
2510
|
#### Returns
|
|
@@ -2536,14 +2513,14 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2536
2513
|
|
|
2537
2514
|
#### Defined in
|
|
2538
2515
|
|
|
2539
|
-
[packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/
|
|
2516
|
+
[packages/fs/src/remove/remove.ts:5](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/remove/remove.ts#L5)
|
|
2540
2517
|
|
|
2541
|
-
|
|
2518
|
+
---
|
|
2542
2519
|
|
|
2543
2520
|
### removeSync()
|
|
2544
2521
|
|
|
2545
2522
|
```ts
|
|
2546
|
-
function removeSync(path, options): void
|
|
2523
|
+
function removeSync(path, options): void;
|
|
2547
2524
|
```
|
|
2548
2525
|
|
|
2549
2526
|
#### Parameters
|
|
@@ -2563,7 +2540,7 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
2563
2540
|
**Default**
|
|
2564
2541
|
|
|
2565
2542
|
```ts
|
|
2566
|
-
0
|
|
2543
|
+
0;
|
|
2567
2544
|
```
|
|
2568
2545
|
|
|
2569
2546
|
• **options.retryDelay?**: `number`
|
|
@@ -2574,7 +2551,7 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2574
2551
|
**Default**
|
|
2575
2552
|
|
|
2576
2553
|
```ts
|
|
2577
|
-
100
|
|
2554
|
+
100;
|
|
2578
2555
|
```
|
|
2579
2556
|
|
|
2580
2557
|
#### Returns
|
|
@@ -2583,17 +2560,14 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
2583
2560
|
|
|
2584
2561
|
#### Defined in
|
|
2585
2562
|
|
|
2586
|
-
[packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/
|
|
2563
|
+
[packages/fs/src/remove/remove-sync.ts:5](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/remove/remove-sync.ts#L5)
|
|
2587
2564
|
|
|
2588
|
-
|
|
2565
|
+
---
|
|
2589
2566
|
|
|
2590
2567
|
### rename()
|
|
2591
2568
|
|
|
2592
2569
|
```ts
|
|
2593
|
-
function rename(
|
|
2594
|
-
source,
|
|
2595
|
-
destination,
|
|
2596
|
-
options?): Promise<void>
|
|
2570
|
+
function rename(source, destination, options?): Promise<void>;
|
|
2597
2571
|
```
|
|
2598
2572
|
|
|
2599
2573
|
Rename a file asynchronously.
|
|
@@ -2629,17 +2603,14 @@ console.log('The file has been renamed');
|
|
|
2629
2603
|
|
|
2630
2604
|
#### Defined in
|
|
2631
2605
|
|
|
2632
|
-
[packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/
|
|
2606
|
+
[packages/fs/src/move/index.ts:85](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L85)
|
|
2633
2607
|
|
|
2634
|
-
|
|
2608
|
+
---
|
|
2635
2609
|
|
|
2636
2610
|
### renameSync()
|
|
2637
2611
|
|
|
2638
2612
|
```ts
|
|
2639
|
-
function renameSync(
|
|
2640
|
-
source,
|
|
2641
|
-
destination,
|
|
2642
|
-
options?): void
|
|
2613
|
+
function renameSync(source, destination, options?): void;
|
|
2643
2614
|
```
|
|
2644
2615
|
|
|
2645
2616
|
Rename a file synchronously.
|
|
@@ -2675,19 +2646,20 @@ console.log('The file has been renamed');
|
|
|
2675
2646
|
|
|
2676
2647
|
#### Defined in
|
|
2677
2648
|
|
|
2678
|
-
[packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/
|
|
2649
|
+
[packages/fs/src/move/index.ts:109](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/index.ts#L109)
|
|
2679
2650
|
|
|
2680
|
-
|
|
2651
|
+
---
|
|
2681
2652
|
|
|
2682
2653
|
### walk()
|
|
2683
2654
|
|
|
2684
2655
|
```ts
|
|
2685
|
-
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry
|
|
2656
|
+
function walk(directory, __namedParameters): AsyncIterableIterator<WalkEntry>;
|
|
2686
2657
|
```
|
|
2687
2658
|
|
|
2688
2659
|
Walks the file tree rooted at root, yielding each file or directory in the
|
|
2689
2660
|
tree filtered according to the given options.
|
|
2690
2661
|
Options:
|
|
2662
|
+
|
|
2691
2663
|
- maxDepth?: number = Infinity;
|
|
2692
2664
|
- includeFiles?: boolean = true;
|
|
2693
2665
|
- includeDirs?: boolean = true;
|
|
@@ -2709,14 +2681,14 @@ Options:
|
|
|
2709
2681
|
|
|
2710
2682
|
#### Defined in
|
|
2711
2683
|
|
|
2712
|
-
[packages/fs/src/find/walk.ts:52](https://github.com/visulima/visulima/blob/
|
|
2684
|
+
[packages/fs/src/find/walk.ts:52](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/find/walk.ts#L52)
|
|
2713
2685
|
|
|
2714
|
-
|
|
2686
|
+
---
|
|
2715
2687
|
|
|
2716
2688
|
### walkSync()
|
|
2717
2689
|
|
|
2718
2690
|
```ts
|
|
2719
|
-
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry
|
|
2691
|
+
function walkSync(directory, __namedParameters): IterableIterator<WalkEntry>;
|
|
2720
2692
|
```
|
|
2721
2693
|
|
|
2722
2694
|
Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
@@ -2733,17 +2705,14 @@ Same as [`walk`](index.md#walk) but uses synchronous ops
|
|
|
2733
2705
|
|
|
2734
2706
|
#### Defined in
|
|
2735
2707
|
|
|
2736
|
-
[packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/
|
|
2708
|
+
[packages/fs/src/find/walk-sync.ts:40](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/find/walk-sync.ts#L40)
|
|
2737
2709
|
|
|
2738
|
-
|
|
2710
|
+
---
|
|
2739
2711
|
|
|
2740
2712
|
### writeFile()
|
|
2741
2713
|
|
|
2742
2714
|
```ts
|
|
2743
|
-
function writeFile(
|
|
2744
|
-
path,
|
|
2745
|
-
content,
|
|
2746
|
-
options?): Promise<void>
|
|
2715
|
+
function writeFile(path, content, options?): Promise<void>;
|
|
2747
2716
|
```
|
|
2748
2717
|
|
|
2749
2718
|
#### Parameters
|
|
@@ -2760,17 +2729,14 @@ options?): Promise<void>
|
|
|
2760
2729
|
|
|
2761
2730
|
#### Defined in
|
|
2762
2731
|
|
|
2763
|
-
[packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/
|
|
2732
|
+
[packages/fs/src/write/write-file.ts:15](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-file.ts#L15)
|
|
2764
2733
|
|
|
2765
|
-
|
|
2734
|
+
---
|
|
2766
2735
|
|
|
2767
2736
|
### writeFileSync()
|
|
2768
2737
|
|
|
2769
2738
|
```ts
|
|
2770
|
-
function writeFileSync(
|
|
2771
|
-
path,
|
|
2772
|
-
content,
|
|
2773
|
-
options?): void
|
|
2739
|
+
function writeFileSync(path, content, options?): void;
|
|
2774
2740
|
```
|
|
2775
2741
|
|
|
2776
2742
|
#### Parameters
|
|
@@ -2787,17 +2753,14 @@ function writeFileSync(
|
|
|
2787
2753
|
|
|
2788
2754
|
#### Defined in
|
|
2789
2755
|
|
|
2790
|
-
[packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/
|
|
2756
|
+
[packages/fs/src/write/write-file-sync.ts:15](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-file-sync.ts#L15)
|
|
2791
2757
|
|
|
2792
|
-
|
|
2758
|
+
---
|
|
2793
2759
|
|
|
2794
2760
|
### writeJson()
|
|
2795
2761
|
|
|
2796
2762
|
```ts
|
|
2797
|
-
function writeJson(
|
|
2798
|
-
path,
|
|
2799
|
-
data,
|
|
2800
|
-
options): Promise<void>
|
|
2763
|
+
function writeJson(path, data, options): Promise<void>;
|
|
2801
2764
|
```
|
|
2802
2765
|
|
|
2803
2766
|
#### Parameters
|
|
@@ -2814,17 +2777,14 @@ options): Promise<void>
|
|
|
2814
2777
|
|
|
2815
2778
|
#### Defined in
|
|
2816
2779
|
|
|
2817
|
-
[packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/
|
|
2780
|
+
[packages/fs/src/write/write-json.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-json.ts#L11)
|
|
2818
2781
|
|
|
2819
|
-
|
|
2782
|
+
---
|
|
2820
2783
|
|
|
2821
2784
|
### writeJsonSync()
|
|
2822
2785
|
|
|
2823
2786
|
```ts
|
|
2824
|
-
function writeJsonSync(
|
|
2825
|
-
path,
|
|
2826
|
-
data,
|
|
2827
|
-
options): void
|
|
2787
|
+
function writeJsonSync(path, data, options): void;
|
|
2828
2788
|
```
|
|
2829
2789
|
|
|
2830
2790
|
#### Parameters
|
|
@@ -2841,19 +2801,16 @@ function writeJsonSync(
|
|
|
2841
2801
|
|
|
2842
2802
|
#### Defined in
|
|
2843
2803
|
|
|
2844
|
-
[packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/
|
|
2804
|
+
[packages/fs/src/write/write-json-sync.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-json-sync.ts#L11)
|
|
2845
2805
|
|
|
2846
|
-
|
|
2806
|
+
---
|
|
2847
2807
|
|
|
2848
2808
|
### writeYaml()
|
|
2849
2809
|
|
|
2850
2810
|
#### writeYaml(path, data, options)
|
|
2851
2811
|
|
|
2852
2812
|
```ts
|
|
2853
|
-
function writeYaml(
|
|
2854
|
-
path,
|
|
2855
|
-
data,
|
|
2856
|
-
options?): Promise<void>
|
|
2813
|
+
function writeYaml(path, data, options?): Promise<void>;
|
|
2857
2814
|
```
|
|
2858
2815
|
|
|
2859
2816
|
##### Parameters
|
|
@@ -2870,16 +2827,12 @@ options?): Promise<void>
|
|
|
2870
2827
|
|
|
2871
2828
|
##### Defined in
|
|
2872
2829
|
|
|
2873
|
-
[packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/
|
|
2830
|
+
[packages/fs/src/write/write-yaml.ts:10](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml.ts#L10)
|
|
2874
2831
|
|
|
2875
2832
|
#### writeYaml(path, data, replacer, options)
|
|
2876
2833
|
|
|
2877
2834
|
```ts
|
|
2878
|
-
function writeYaml(
|
|
2879
|
-
path,
|
|
2880
|
-
data,
|
|
2881
|
-
replacer?,
|
|
2882
|
-
options?): Promise<void>
|
|
2835
|
+
function writeYaml(path, data, replacer?, options?): Promise<void>;
|
|
2883
2836
|
```
|
|
2884
2837
|
|
|
2885
2838
|
##### Parameters
|
|
@@ -2898,19 +2851,16 @@ options?): Promise<void>
|
|
|
2898
2851
|
|
|
2899
2852
|
##### Defined in
|
|
2900
2853
|
|
|
2901
|
-
[packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/
|
|
2854
|
+
[packages/fs/src/write/write-yaml.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml.ts#L16)
|
|
2902
2855
|
|
|
2903
|
-
|
|
2856
|
+
---
|
|
2904
2857
|
|
|
2905
2858
|
### writeYamlSync()
|
|
2906
2859
|
|
|
2907
2860
|
#### writeYamlSync(path, data, options)
|
|
2908
2861
|
|
|
2909
2862
|
```ts
|
|
2910
|
-
function writeYamlSync(
|
|
2911
|
-
path,
|
|
2912
|
-
data,
|
|
2913
|
-
options?): void
|
|
2863
|
+
function writeYamlSync(path, data, options?): void;
|
|
2914
2864
|
```
|
|
2915
2865
|
|
|
2916
2866
|
##### Parameters
|
|
@@ -2927,16 +2877,12 @@ function writeYamlSync(
|
|
|
2927
2877
|
|
|
2928
2878
|
##### Defined in
|
|
2929
2879
|
|
|
2930
|
-
[packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/
|
|
2880
|
+
[packages/fs/src/write/write-yaml-sync.ts:10](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml-sync.ts#L10)
|
|
2931
2881
|
|
|
2932
2882
|
#### writeYamlSync(path, data, replacer, options)
|
|
2933
2883
|
|
|
2934
2884
|
```ts
|
|
2935
|
-
function writeYamlSync(
|
|
2936
|
-
path,
|
|
2937
|
-
data,
|
|
2938
|
-
replacer?,
|
|
2939
|
-
options?): void
|
|
2885
|
+
function writeYamlSync(path, data, replacer?, options?): void;
|
|
2940
2886
|
```
|
|
2941
2887
|
|
|
2942
2888
|
##### Parameters
|
|
@@ -2955,7 +2901,7 @@ function writeYamlSync(
|
|
|
2955
2901
|
|
|
2956
2902
|
##### Defined in
|
|
2957
2903
|
|
|
2958
|
-
[packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/
|
|
2904
|
+
[packages/fs/src/write/write-yaml-sync.ts:16](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/write/write-yaml-sync.ts#L16)
|
|
2959
2905
|
|
|
2960
2906
|
## Variables
|
|
2961
2907
|
|
|
@@ -2969,9 +2915,9 @@ End-of-line character for Windows platforms.
|
|
|
2969
2915
|
|
|
2970
2916
|
#### Defined in
|
|
2971
2917
|
|
|
2972
|
-
[packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/
|
|
2918
|
+
[packages/fs/src/eol.ts:9](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L9)
|
|
2973
2919
|
|
|
2974
|
-
|
|
2920
|
+
---
|
|
2975
2921
|
|
|
2976
2922
|
### EOL
|
|
2977
2923
|
|
|
@@ -2983,11 +2929,11 @@ End-of-line character evaluated for the current platform.
|
|
|
2983
2929
|
|
|
2984
2930
|
#### Defined in
|
|
2985
2931
|
|
|
2986
|
-
[packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/
|
|
2932
|
+
[packages/fs/src/eol.ts:14](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L14)
|
|
2987
2933
|
|
|
2988
|
-
|
|
2934
|
+
---
|
|
2989
2935
|
|
|
2990
|
-
###
|
|
2936
|
+
### F_OK
|
|
2991
2937
|
|
|
2992
2938
|
```ts
|
|
2993
2939
|
const F_OK: 0 = 0;
|
|
@@ -2997,11 +2943,11 @@ Is the path visible to the calling process?
|
|
|
2997
2943
|
|
|
2998
2944
|
#### Defined in
|
|
2999
2945
|
|
|
3000
|
-
[packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/
|
|
2946
|
+
[packages/fs/src/constants.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/constants.ts#L2)
|
|
3001
2947
|
|
|
3002
|
-
|
|
2948
|
+
---
|
|
3003
2949
|
|
|
3004
|
-
###
|
|
2950
|
+
### FIND_UP_STOP
|
|
3005
2951
|
|
|
3006
2952
|
```ts
|
|
3007
2953
|
const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
@@ -3009,9 +2955,9 @@ const FIND_UP_STOP: typeof FIND_UP_STOP;
|
|
|
3009
2955
|
|
|
3010
2956
|
#### Defined in
|
|
3011
2957
|
|
|
3012
|
-
[packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/
|
|
2958
|
+
[packages/fs/src/constants.ts:13](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/constants.ts#L13)
|
|
3013
2959
|
|
|
3014
|
-
|
|
2960
|
+
---
|
|
3015
2961
|
|
|
3016
2962
|
### LF
|
|
3017
2963
|
|
|
@@ -3023,11 +2969,11 @@ End-of-line character for POSIX platforms such as macOS and Linux.
|
|
|
3023
2969
|
|
|
3024
2970
|
#### Defined in
|
|
3025
2971
|
|
|
3026
|
-
[packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/
|
|
2972
|
+
[packages/fs/src/eol.ts:6](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/eol.ts#L6)
|
|
3027
2973
|
|
|
3028
|
-
|
|
2974
|
+
---
|
|
3029
2975
|
|
|
3030
|
-
###
|
|
2976
|
+
### R_OK
|
|
3031
2977
|
|
|
3032
2978
|
```ts
|
|
3033
2979
|
const R_OK: 4 = 4;
|
|
@@ -3037,11 +2983,11 @@ Is the path readable to the calling process?
|
|
|
3037
2983
|
|
|
3038
2984
|
#### Defined in
|
|
3039
2985
|
|
|
3040
|
-
[packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/
|
|
2986
|
+
[packages/fs/src/constants.ts:5](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/constants.ts#L5)
|
|
3041
2987
|
|
|
3042
|
-
|
|
2988
|
+
---
|
|
3043
2989
|
|
|
3044
|
-
###
|
|
2990
|
+
### W_OK
|
|
3045
2991
|
|
|
3046
2992
|
```ts
|
|
3047
2993
|
const W_OK: 2 = 2;
|
|
@@ -3051,11 +2997,11 @@ Is the path writable to the calling process?
|
|
|
3051
2997
|
|
|
3052
2998
|
#### Defined in
|
|
3053
2999
|
|
|
3054
|
-
[packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/
|
|
3000
|
+
[packages/fs/src/constants.ts:8](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/constants.ts#L8)
|
|
3055
3001
|
|
|
3056
|
-
|
|
3002
|
+
---
|
|
3057
3003
|
|
|
3058
|
-
###
|
|
3004
|
+
### X_OK
|
|
3059
3005
|
|
|
3060
3006
|
```ts
|
|
3061
3007
|
const X_OK: 1 = 1;
|
|
@@ -3065,7 +3011,7 @@ Is the path executable to the calling process?
|
|
|
3065
3011
|
|
|
3066
3012
|
#### Defined in
|
|
3067
3013
|
|
|
3068
|
-
[packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/
|
|
3014
|
+
[packages/fs/src/constants.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/constants.ts#L11)
|
|
3069
3015
|
|
|
3070
3016
|
## Interfaces
|
|
3071
3017
|
|
|
@@ -3100,7 +3046,7 @@ v10.10.0
|
|
|
3100
3046
|
|
|
3101
3047
|
###### Defined in
|
|
3102
3048
|
|
|
3103
|
-
|
|
3049
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:190
|
|
3104
3050
|
|
|
3105
3051
|
##### isFile()
|
|
3106
3052
|
|
|
@@ -3124,7 +3070,7 @@ v10.10.0
|
|
|
3124
3070
|
|
|
3125
3071
|
###### Defined in
|
|
3126
3072
|
|
|
3127
|
-
|
|
3073
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:184
|
|
3128
3074
|
|
|
3129
3075
|
##### isSymbolicLink()
|
|
3130
3076
|
|
|
@@ -3148,7 +3094,7 @@ v10.10.0
|
|
|
3148
3094
|
|
|
3149
3095
|
###### Defined in
|
|
3150
3096
|
|
|
3151
|
-
|
|
3097
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:205
|
|
3152
3098
|
|
|
3153
3099
|
#### Properties
|
|
3154
3100
|
|
|
@@ -3171,7 +3117,7 @@ v10.10.0
|
|
|
3171
3117
|
|
|
3172
3118
|
###### Defined in
|
|
3173
3119
|
|
|
3174
|
-
|
|
3120
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/fs.d.ts:222
|
|
3175
3121
|
|
|
3176
3122
|
##### path
|
|
3177
3123
|
|
|
@@ -3181,9 +3127,9 @@ path: string;
|
|
|
3181
3127
|
|
|
3182
3128
|
###### Defined in
|
|
3183
3129
|
|
|
3184
|
-
[packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/
|
|
3130
|
+
[packages/fs/src/types.ts:57](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L57)
|
|
3185
3131
|
|
|
3186
|
-
|
|
3132
|
+
---
|
|
3187
3133
|
|
|
3188
3134
|
### WalkOptions
|
|
3189
3135
|
|
|
@@ -3201,12 +3147,14 @@ If specified, entries without the file extension specified by this option are ex
|
|
|
3201
3147
|
###### Default
|
|
3202
3148
|
|
|
3203
3149
|
```ts
|
|
3204
|
-
{
|
|
3150
|
+
{
|
|
3151
|
+
undefined;
|
|
3152
|
+
}
|
|
3205
3153
|
```
|
|
3206
3154
|
|
|
3207
3155
|
###### Defined in
|
|
3208
3156
|
|
|
3209
|
-
[packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/
|
|
3157
|
+
[packages/fs/src/types.ts:15](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L15)
|
|
3210
3158
|
|
|
3211
3159
|
##### followSymlinks?
|
|
3212
3160
|
|
|
@@ -3219,12 +3167,14 @@ Indicates whether symlinks should be resolved or not.
|
|
|
3219
3167
|
###### Default
|
|
3220
3168
|
|
|
3221
3169
|
```ts
|
|
3222
|
-
{
|
|
3170
|
+
{
|
|
3171
|
+
false;
|
|
3172
|
+
}
|
|
3223
3173
|
```
|
|
3224
3174
|
|
|
3225
3175
|
###### Defined in
|
|
3226
3176
|
|
|
3227
|
-
[packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/
|
|
3177
|
+
[packages/fs/src/types.ts:20](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L20)
|
|
3228
3178
|
|
|
3229
3179
|
##### includeDirs?
|
|
3230
3180
|
|
|
@@ -3237,12 +3187,14 @@ Indicates whether directory entries should be included or not.
|
|
|
3237
3187
|
###### Default
|
|
3238
3188
|
|
|
3239
3189
|
```ts
|
|
3240
|
-
{
|
|
3190
|
+
{
|
|
3191
|
+
true;
|
|
3192
|
+
}
|
|
3241
3193
|
```
|
|
3242
3194
|
|
|
3243
3195
|
###### Defined in
|
|
3244
3196
|
|
|
3245
|
-
[packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/
|
|
3197
|
+
[packages/fs/src/types.ts:25](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L25)
|
|
3246
3198
|
|
|
3247
3199
|
##### includeFiles?
|
|
3248
3200
|
|
|
@@ -3255,12 +3207,14 @@ Indicates whether file entries should be included or not.
|
|
|
3255
3207
|
###### Default
|
|
3256
3208
|
|
|
3257
3209
|
```ts
|
|
3258
|
-
{
|
|
3210
|
+
{
|
|
3211
|
+
true;
|
|
3212
|
+
}
|
|
3259
3213
|
```
|
|
3260
3214
|
|
|
3261
3215
|
###### Defined in
|
|
3262
3216
|
|
|
3263
|
-
[packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/
|
|
3217
|
+
[packages/fs/src/types.ts:30](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L30)
|
|
3264
3218
|
|
|
3265
3219
|
##### includeSymlinks?
|
|
3266
3220
|
|
|
@@ -3274,12 +3228,14 @@ This option is meaningful only if `followSymlinks` is set to `false`.
|
|
|
3274
3228
|
###### Default
|
|
3275
3229
|
|
|
3276
3230
|
```ts
|
|
3277
|
-
{
|
|
3231
|
+
{
|
|
3232
|
+
true;
|
|
3233
|
+
}
|
|
3278
3234
|
```
|
|
3279
3235
|
|
|
3280
3236
|
###### Defined in
|
|
3281
3237
|
|
|
3282
|
-
[packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/
|
|
3238
|
+
[packages/fs/src/types.ts:36](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L36)
|
|
3283
3239
|
|
|
3284
3240
|
##### match?
|
|
3285
3241
|
|
|
@@ -3293,12 +3249,14 @@ If specified, entries that do not match the patterns specified by this option ar
|
|
|
3293
3249
|
###### Default
|
|
3294
3250
|
|
|
3295
3251
|
```ts
|
|
3296
|
-
{
|
|
3252
|
+
{
|
|
3253
|
+
undefined;
|
|
3254
|
+
}
|
|
3297
3255
|
```
|
|
3298
3256
|
|
|
3299
3257
|
###### Defined in
|
|
3300
3258
|
|
|
3301
|
-
[packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/
|
|
3259
|
+
[packages/fs/src/types.ts:42](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L42)
|
|
3302
3260
|
|
|
3303
3261
|
##### maxDepth?
|
|
3304
3262
|
|
|
@@ -3311,12 +3269,14 @@ The maximum depth of the file tree to be walked recursively.
|
|
|
3311
3269
|
###### Default
|
|
3312
3270
|
|
|
3313
3271
|
```ts
|
|
3314
|
-
{
|
|
3272
|
+
{
|
|
3273
|
+
Infinity;
|
|
3274
|
+
}
|
|
3315
3275
|
```
|
|
3316
3276
|
|
|
3317
3277
|
###### Defined in
|
|
3318
3278
|
|
|
3319
|
-
[packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/
|
|
3279
|
+
[packages/fs/src/types.ts:47](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L47)
|
|
3320
3280
|
|
|
3321
3281
|
##### skip?
|
|
3322
3282
|
|
|
@@ -3330,12 +3290,14 @@ If specified, entries matching the patterns specified by this option are exclude
|
|
|
3330
3290
|
###### Default
|
|
3331
3291
|
|
|
3332
3292
|
```ts
|
|
3333
|
-
{
|
|
3293
|
+
{
|
|
3294
|
+
undefined;
|
|
3295
|
+
}
|
|
3334
3296
|
```
|
|
3335
3297
|
|
|
3336
3298
|
###### Defined in
|
|
3337
3299
|
|
|
3338
|
-
[packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/
|
|
3300
|
+
[packages/fs/src/types.ts:53](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L53)
|
|
3339
3301
|
|
|
3340
3302
|
## Type Aliases
|
|
3341
3303
|
|
|
@@ -3361,9 +3323,9 @@ line: number;
|
|
|
3361
3323
|
|
|
3362
3324
|
#### Defined in
|
|
3363
3325
|
|
|
3364
|
-
[packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/
|
|
3326
|
+
[packages/fs/src/types.ts:91](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L91)
|
|
3365
3327
|
|
|
3366
|
-
|
|
3328
|
+
---
|
|
3367
3329
|
|
|
3368
3330
|
### EmptyDirOptions
|
|
3369
3331
|
|
|
@@ -3388,7 +3350,7 @@ number of retries. This option is ignored if the `recursive` option is not
|
|
|
3388
3350
|
###### Default
|
|
3389
3351
|
|
|
3390
3352
|
```ts
|
|
3391
|
-
0
|
|
3353
|
+
0;
|
|
3392
3354
|
```
|
|
3393
3355
|
|
|
3394
3356
|
##### retryDelay?
|
|
@@ -3403,14 +3365,14 @@ This option is ignored if the `recursive` option is not `true`.
|
|
|
3403
3365
|
###### Default
|
|
3404
3366
|
|
|
3405
3367
|
```ts
|
|
3406
|
-
100
|
|
3368
|
+
100;
|
|
3407
3369
|
```
|
|
3408
3370
|
|
|
3409
3371
|
#### Defined in
|
|
3410
3372
|
|
|
3411
|
-
[packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/
|
|
3373
|
+
[packages/fs/src/types.ts:188](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L188)
|
|
3412
3374
|
|
|
3413
|
-
|
|
3375
|
+
---
|
|
3414
3376
|
|
|
3415
3377
|
### FindUpName
|
|
3416
3378
|
|
|
@@ -3420,9 +3382,9 @@ type FindUpName: string[] | string | (directory) => FindUpNameFnResult;
|
|
|
3420
3382
|
|
|
3421
3383
|
#### Defined in
|
|
3422
3384
|
|
|
3423
|
-
[packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/
|
|
3385
|
+
[packages/fs/src/types.ts:180](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L180)
|
|
3424
3386
|
|
|
3425
|
-
|
|
3387
|
+
---
|
|
3426
3388
|
|
|
3427
3389
|
### FindUpNameFnResult
|
|
3428
3390
|
|
|
@@ -3432,9 +3394,9 @@ type FindUpNameFnResult: PathLike | Promise<PathLike | typeof FIND_UP_STOP> | ty
|
|
|
3432
3394
|
|
|
3433
3395
|
#### Defined in
|
|
3434
3396
|
|
|
3435
|
-
[packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/
|
|
3397
|
+
[packages/fs/src/types.ts:178](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L178)
|
|
3436
3398
|
|
|
3437
|
-
|
|
3399
|
+
---
|
|
3438
3400
|
|
|
3439
3401
|
### FindUpNameSync
|
|
3440
3402
|
|
|
@@ -3444,9 +3406,9 @@ type FindUpNameSync: string[] | string | (directory) => FindUpNameSyncFnResult;
|
|
|
3444
3406
|
|
|
3445
3407
|
#### Defined in
|
|
3446
3408
|
|
|
3447
|
-
[packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/
|
|
3409
|
+
[packages/fs/src/types.ts:185](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L185)
|
|
3448
3410
|
|
|
3449
|
-
|
|
3411
|
+
---
|
|
3450
3412
|
|
|
3451
3413
|
### FindUpNameSyncFnResult
|
|
3452
3414
|
|
|
@@ -3456,9 +3418,9 @@ type FindUpNameSyncFnResult: PathLike | typeof FIND_UP_STOP | undefined;
|
|
|
3456
3418
|
|
|
3457
3419
|
#### Defined in
|
|
3458
3420
|
|
|
3459
|
-
[packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/
|
|
3421
|
+
[packages/fs/src/types.ts:183](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L183)
|
|
3460
3422
|
|
|
3461
|
-
|
|
3423
|
+
---
|
|
3462
3424
|
|
|
3463
3425
|
### FindUpOptions
|
|
3464
3426
|
|
|
@@ -3494,9 +3456,9 @@ optional type: "directory" | "file";
|
|
|
3494
3456
|
|
|
3495
3457
|
#### Defined in
|
|
3496
3458
|
|
|
3497
|
-
[packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/
|
|
3459
|
+
[packages/fs/src/types.ts:170](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L170)
|
|
3498
3460
|
|
|
3499
|
-
|
|
3461
|
+
---
|
|
3500
3462
|
|
|
3501
3463
|
### JsonReplacer
|
|
3502
3464
|
|
|
@@ -3506,9 +3468,9 @@ type JsonReplacer: (number | string)[] | (this, key, value) => unknown | null;
|
|
|
3506
3468
|
|
|
3507
3469
|
#### Defined in
|
|
3508
3470
|
|
|
3509
|
-
[packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/
|
|
3471
|
+
[packages/fs/src/types.ts:143](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L143)
|
|
3510
3472
|
|
|
3511
|
-
|
|
3473
|
+
---
|
|
3512
3474
|
|
|
3513
3475
|
### JsonReviver
|
|
3514
3476
|
|
|
@@ -3518,9 +3480,9 @@ type JsonReviver: Parameters<typeof JSON["parse"]>["1"];
|
|
|
3518
3480
|
|
|
3519
3481
|
#### Defined in
|
|
3520
3482
|
|
|
3521
|
-
[packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/
|
|
3483
|
+
[packages/fs/src/types.ts:89](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L89)
|
|
3522
3484
|
|
|
3523
|
-
|
|
3485
|
+
---
|
|
3524
3486
|
|
|
3525
3487
|
### MoveOptions
|
|
3526
3488
|
|
|
@@ -3542,7 +3504,7 @@ The source and destination path are relative to this.
|
|
|
3542
3504
|
###### Default
|
|
3543
3505
|
|
|
3544
3506
|
```ts
|
|
3545
|
-
process.cwd()
|
|
3507
|
+
process.cwd();
|
|
3546
3508
|
```
|
|
3547
3509
|
|
|
3548
3510
|
##### directoryMode?
|
|
@@ -3558,7 +3520,7 @@ It has no effect on Windows.
|
|
|
3558
3520
|
###### Default
|
|
3559
3521
|
|
|
3560
3522
|
```ts
|
|
3561
|
-
0o777
|
|
3523
|
+
0o777;
|
|
3562
3524
|
```
|
|
3563
3525
|
|
|
3564
3526
|
##### overwrite?
|
|
@@ -3572,19 +3534,19 @@ Overwrite existing destination file.
|
|
|
3572
3534
|
###### Default
|
|
3573
3535
|
|
|
3574
3536
|
```ts
|
|
3575
|
-
true
|
|
3537
|
+
true;
|
|
3576
3538
|
```
|
|
3577
3539
|
|
|
3578
3540
|
#### Defined in
|
|
3579
3541
|
|
|
3580
|
-
[packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/
|
|
3542
|
+
[packages/fs/src/move/types.ts:3](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/move/types.ts#L3)
|
|
3581
3543
|
|
|
3582
|
-
|
|
3544
|
+
---
|
|
3583
3545
|
|
|
3584
3546
|
### ReadFileEncoding
|
|
3585
3547
|
|
|
3586
3548
|
```ts
|
|
3587
|
-
type ReadFileEncoding:
|
|
3549
|
+
type ReadFileEncoding:
|
|
3588
3550
|
| "ascii"
|
|
3589
3551
|
| "base64"
|
|
3590
3552
|
| "base64url"
|
|
@@ -3600,9 +3562,9 @@ type ReadFileEncoding:
|
|
|
3600
3562
|
|
|
3601
3563
|
#### Defined in
|
|
3602
3564
|
|
|
3603
|
-
[packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/
|
|
3565
|
+
[packages/fs/src/types.ts:61](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L61)
|
|
3604
3566
|
|
|
3605
|
-
|
|
3567
|
+
---
|
|
3606
3568
|
|
|
3607
3569
|
### ReadFileOptions\<C\>
|
|
3608
3570
|
|
|
@@ -3654,9 +3616,9 @@ The flag used to open the file. Default: `r`
|
|
|
3654
3616
|
|
|
3655
3617
|
#### Defined in
|
|
3656
3618
|
|
|
3657
|
-
[packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/
|
|
3619
|
+
[packages/fs/src/types.ts:63](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L63)
|
|
3658
3620
|
|
|
3659
|
-
|
|
3621
|
+
---
|
|
3660
3622
|
|
|
3661
3623
|
### ReadJsonOptions
|
|
3662
3624
|
|
|
@@ -3682,9 +3644,9 @@ optional beforeParse: (source) => string;
|
|
|
3682
3644
|
|
|
3683
3645
|
#### Defined in
|
|
3684
3646
|
|
|
3685
|
-
[packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/
|
|
3647
|
+
[packages/fs/src/types.ts:104](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L104)
|
|
3686
3648
|
|
|
3687
|
-
|
|
3649
|
+
---
|
|
3688
3650
|
|
|
3689
3651
|
### WriteFileOptions
|
|
3690
3652
|
|
|
@@ -3756,9 +3718,9 @@ Recursively create parent directories if needed. Default: `true`
|
|
|
3756
3718
|
|
|
3757
3719
|
#### Defined in
|
|
3758
3720
|
|
|
3759
|
-
[packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/
|
|
3721
|
+
[packages/fs/src/types.ts:108](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L108)
|
|
3760
3722
|
|
|
3761
|
-
|
|
3723
|
+
---
|
|
3762
3724
|
|
|
3763
3725
|
### WriteJsonOptions
|
|
3764
3726
|
|
|
@@ -3816,9 +3778,9 @@ Override the default `JSON.stringify` method.
|
|
|
3816
3778
|
|
|
3817
3779
|
#### Defined in
|
|
3818
3780
|
|
|
3819
|
-
[packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/
|
|
3781
|
+
[packages/fs/src/types.ts:146](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L146)
|
|
3820
3782
|
|
|
3821
|
-
|
|
3783
|
+
---
|
|
3822
3784
|
|
|
3823
3785
|
### YamlReplacer
|
|
3824
3786
|
|
|
@@ -3828,7 +3790,8 @@ type YamlReplacer: JsonReplacer;
|
|
|
3828
3790
|
|
|
3829
3791
|
#### Defined in
|
|
3830
3792
|
|
|
3831
|
-
[packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/
|
|
3793
|
+
[packages/fs/src/types.ts:144](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/types.ts#L144)
|
|
3794
|
+
|
|
3832
3795
|
# utils
|
|
3833
3796
|
|
|
3834
3797
|
## Classes
|
|
@@ -3861,7 +3824,7 @@ new JSONError(message): JSONError
|
|
|
3861
3824
|
|
|
3862
3825
|
###### Defined in
|
|
3863
3826
|
|
|
3864
|
-
[packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/
|
|
3827
|
+
[packages/fs/src/error/json-error.ts:11](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L11)
|
|
3865
3828
|
|
|
3866
3829
|
#### Accessors
|
|
3867
3830
|
|
|
@@ -3889,7 +3852,7 @@ set message(message): void
|
|
|
3889
3852
|
|
|
3890
3853
|
###### Defined in
|
|
3891
3854
|
|
|
3892
|
-
[packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/
|
|
3855
|
+
[packages/fs/src/error/json-error.ts:21](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L21)
|
|
3893
3856
|
|
|
3894
3857
|
#### Methods
|
|
3895
3858
|
|
|
@@ -3917,7 +3880,7 @@ Create .stack property on a target object
|
|
|
3917
3880
|
|
|
3918
3881
|
###### Defined in
|
|
3919
3882
|
|
|
3920
|
-
|
|
3883
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:20
|
|
3921
3884
|
|
|
3922
3885
|
#### Properties
|
|
3923
3886
|
|
|
@@ -3933,7 +3896,7 @@ optional cause: unknown;
|
|
|
3933
3896
|
|
|
3934
3897
|
###### Defined in
|
|
3935
3898
|
|
|
3936
|
-
|
|
3899
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es2022.error.d.ts:24
|
|
3937
3900
|
|
|
3938
3901
|
##### codeFrame
|
|
3939
3902
|
|
|
@@ -3943,7 +3906,7 @@ codeFrame: string;
|
|
|
3943
3906
|
|
|
3944
3907
|
###### Defined in
|
|
3945
3908
|
|
|
3946
|
-
[packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/
|
|
3909
|
+
[packages/fs/src/error/json-error.ts:4](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L4)
|
|
3947
3910
|
|
|
3948
3911
|
##### fileName
|
|
3949
3912
|
|
|
@@ -3953,7 +3916,7 @@ fileName: string;
|
|
|
3953
3916
|
|
|
3954
3917
|
###### Defined in
|
|
3955
3918
|
|
|
3956
|
-
[packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/
|
|
3919
|
+
[packages/fs/src/error/json-error.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L2)
|
|
3957
3920
|
|
|
3958
3921
|
##### name
|
|
3959
3922
|
|
|
@@ -3967,7 +3930,7 @@ readonly name: "JSONError" = "JSONError";
|
|
|
3967
3930
|
|
|
3968
3931
|
###### Defined in
|
|
3969
3932
|
|
|
3970
|
-
[packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/
|
|
3933
|
+
[packages/fs/src/error/json-error.ts:7](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/error/json-error.ts#L7)
|
|
3971
3934
|
|
|
3972
3935
|
##### stack?
|
|
3973
3936
|
|
|
@@ -3981,7 +3944,7 @@ optional stack: string;
|
|
|
3981
3944
|
|
|
3982
3945
|
###### Defined in
|
|
3983
3946
|
|
|
3984
|
-
|
|
3947
|
+
node_modules/.pnpm/typescript@5.6.3/node_modules/typescript/lib/lib.es5.d.ts:1078
|
|
3985
3948
|
|
|
3986
3949
|
##### prepareStackTrace()?
|
|
3987
3950
|
|
|
@@ -4011,7 +3974,7 @@ https://v8.dev/docs/stack-trace-api#customizing-stack-traces
|
|
|
4011
3974
|
|
|
4012
3975
|
###### Defined in
|
|
4013
3976
|
|
|
4014
|
-
|
|
3977
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:27
|
|
4015
3978
|
|
|
4016
3979
|
##### stackTraceLimit
|
|
4017
3980
|
|
|
@@ -4025,14 +3988,14 @@ static stackTraceLimit: number;
|
|
|
4025
3988
|
|
|
4026
3989
|
###### Defined in
|
|
4027
3990
|
|
|
4028
|
-
|
|
3991
|
+
node_modules/.pnpm/@types+node@18.19.15/node_modules/@types/node/globals.d.ts:29
|
|
4029
3992
|
|
|
4030
3993
|
## Functions
|
|
4031
3994
|
|
|
4032
3995
|
### assertValidFileContents()
|
|
4033
3996
|
|
|
4034
3997
|
```ts
|
|
4035
|
-
function assertValidFileContents(contents): void
|
|
3998
|
+
function assertValidFileContents(contents): void;
|
|
4036
3999
|
```
|
|
4037
4000
|
|
|
4038
4001
|
#### Parameters
|
|
@@ -4045,14 +4008,14 @@ function assertValidFileContents(contents): void
|
|
|
4045
4008
|
|
|
4046
4009
|
#### Defined in
|
|
4047
4010
|
|
|
4048
|
-
[packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/
|
|
4011
|
+
[packages/fs/src/utils/assert-valid-file-contents.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/assert-valid-file-contents.ts#L2)
|
|
4049
4012
|
|
|
4050
|
-
|
|
4013
|
+
---
|
|
4051
4014
|
|
|
4052
4015
|
### assertValidFileOrDirectoryPath()
|
|
4053
4016
|
|
|
4054
4017
|
```ts
|
|
4055
|
-
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
4018
|
+
function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void;
|
|
4056
4019
|
```
|
|
4057
4020
|
|
|
4058
4021
|
#### Parameters
|
|
@@ -4065,19 +4028,16 @@ function assertValidFileOrDirectoryPath(fileOrDirectoryPath): void
|
|
|
4065
4028
|
|
|
4066
4029
|
#### Defined in
|
|
4067
4030
|
|
|
4068
|
-
[packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/
|
|
4031
|
+
[packages/fs/src/utils/assert-valid-file-or-directory-path.ts:2](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/assert-valid-file-or-directory-path.ts#L2)
|
|
4069
4032
|
|
|
4070
|
-
|
|
4033
|
+
---
|
|
4071
4034
|
|
|
4072
4035
|
### parseJson()
|
|
4073
4036
|
|
|
4074
4037
|
#### parseJson(string, filename, options)
|
|
4075
4038
|
|
|
4076
4039
|
```ts
|
|
4077
|
-
function parseJson<T>(
|
|
4078
|
-
string,
|
|
4079
|
-
filename?,
|
|
4080
|
-
options?): T
|
|
4040
|
+
function parseJson<T>(string, filename?, options?): T;
|
|
4081
4041
|
```
|
|
4082
4042
|
|
|
4083
4043
|
##### Type Parameters
|
|
@@ -4098,16 +4058,12 @@ function parseJson<T>(
|
|
|
4098
4058
|
|
|
4099
4059
|
##### Defined in
|
|
4100
4060
|
|
|
4101
|
-
[packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/
|
|
4061
|
+
[packages/fs/src/utils/parse-json.ts:60](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/parse-json.ts#L60)
|
|
4102
4062
|
|
|
4103
4063
|
#### parseJson(string, reviver, fileName, options)
|
|
4104
4064
|
|
|
4105
4065
|
```ts
|
|
4106
|
-
function parseJson<T>(
|
|
4107
|
-
string,
|
|
4108
|
-
reviver,
|
|
4109
|
-
fileName?,
|
|
4110
|
-
options?): T
|
|
4066
|
+
function parseJson<T>(string, reviver, fileName?, options?): T;
|
|
4111
4067
|
```
|
|
4112
4068
|
|
|
4113
4069
|
##### Type Parameters
|
|
@@ -4130,14 +4086,14 @@ function parseJson<T>(
|
|
|
4130
4086
|
|
|
4131
4087
|
##### Defined in
|
|
4132
4088
|
|
|
4133
|
-
[packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/
|
|
4089
|
+
[packages/fs/src/utils/parse-json.ts:61](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/parse-json.ts#L61)
|
|
4134
4090
|
|
|
4135
|
-
|
|
4091
|
+
---
|
|
4136
4092
|
|
|
4137
4093
|
### stripJsonComments()
|
|
4138
4094
|
|
|
4139
4095
|
```ts
|
|
4140
|
-
function stripJsonComments(jsonString, __namedParameters): string
|
|
4096
|
+
function stripJsonComments(jsonString, __namedParameters): string;
|
|
4141
4097
|
```
|
|
4142
4098
|
|
|
4143
4099
|
#### Parameters
|
|
@@ -4154,14 +4110,14 @@ function stripJsonComments(jsonString, __namedParameters): string
|
|
|
4154
4110
|
|
|
4155
4111
|
#### Defined in
|
|
4156
4112
|
|
|
4157
|
-
[packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/
|
|
4113
|
+
[packages/fs/src/utils/strip-json-comments.ts:5](https://github.com/visulima/visulima/blob/78872bace21a0cb329dd2a18a673d0b630371107/packages/fs/src/utils/strip-json-comments.ts#L5)
|
|
4158
4114
|
|
|
4159
|
-
|
|
4115
|
+
---
|
|
4160
4116
|
|
|
4161
4117
|
### toPath()
|
|
4162
4118
|
|
|
4163
4119
|
```ts
|
|
4164
|
-
function toPath(urlOrPath): string
|
|
4120
|
+
function toPath(urlOrPath): string;
|
|
4165
4121
|
```
|
|
4166
4122
|
|
|
4167
4123
|
#### Parameters
|
|
@@ -4174,7 +4130,7 @@ function toPath(urlOrPath): string
|
|
|
4174
4130
|
|
|
4175
4131
|
#### Defined in
|
|
4176
4132
|
|
|
4177
|
-
|
|
4133
|
+
node_modules/.pnpm/@visulima+path@1.1.1/node_modules/@visulima/path/dist/utils.d.mts:7
|
|
4178
4134
|
|
|
4179
4135
|
<!-- /TYPEDOC -->
|
|
4180
4136
|
|