update docs

JiangJie · Aug 13, 2024 · d3d7eb3 · d3d7eb3
1 parent 41bfb92
commit d3d7eb3
Show file tree

Hide file tree

Showing 83 changed files with 177 additions and 107 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -86,6 +86,8 @@
 | [readDirSync](functions/readDirSync.md) | Sync version of `readDir`. |
 | [readFile](functions/readFile.md) | Reads the content of a file at the specified path as a File. |
 | [readFileSync](functions/readFileSync.md) | Sync version of `readFile`. |
+| [readJsonFile](functions/readJsonFile.md) | Reads the content of a file at the specified path as a string and returns it as a JSON object. |
+| [readJsonFileSync](functions/readJsonFileSync.md) | Sync version of `readJsonFile`. |
 | [readTextFile](functions/readTextFile.md) | Reads the content of a file at the specified path as a string. |
 | [readTextFileSync](functions/readTextFileSync.md) | Sync version of `readTextFile`. |
 | [remove](functions/remove.md) | Removes a file or directory at the specified path same as `rm -rf`. |

diff --git a/docs/functions/appendFile.md b/docs/functions/appendFile.md
@@ -27,4 +27,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the content was
 
 ## Defined in
 
-[fs/opfs\_ext.ts:120](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L120)
+[fs/opfs\_ext.ts:120](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L120)
diff --git a/docs/functions/appendFileSync.md b/docs/functions/appendFileSync.md
@@ -25,4 +25,4 @@ Sync version of `appendFile`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:186](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L186)
+[worker/opfs\_worker\_adapter.ts:186](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L186)
diff --git a/docs/functions/assertAbsolutePath.md b/docs/functions/assertAbsolutePath.md
@@ -28,4 +28,4 @@ Will throw an error if the path is not an absolute path.
 
 ## Defined in
 
-[fs/assertions.ts:10](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/assertions.ts#L10)
+[fs/assertions.ts:10](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/assertions.ts#L10)
diff --git a/docs/functions/assertFileUrl.md b/docs/functions/assertFileUrl.md
@@ -28,4 +28,4 @@ Will throw an error if the URL is not a valid file URL.
 
 ## Defined in
 
-[fs/assertions.ts:21](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/assertions.ts#L21)
+[fs/assertions.ts:21](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/assertions.ts#L21)
diff --git a/docs/functions/connectSyncAgent.md b/docs/functions/connectSyncAgent.md
@@ -24,4 +24,4 @@ Communicate with worker.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:17](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L17)
+[worker/opfs\_worker\_adapter.ts:17](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L17)
diff --git a/docs/functions/copy.md b/docs/functions/copy.md
@@ -33,4 +33,4 @@ A promise that resolves to an `AsyncVoidIOResult` indicating whether the file wa
 
 ## Defined in
 
-[fs/opfs\_ext.ts:136](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L136)
+[fs/opfs\_ext.ts:136](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L136)
diff --git a/docs/functions/copySync.md b/docs/functions/copySync.md
@@ -29,4 +29,4 @@ Sync version of `copy`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:193](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L193)
+[worker/opfs\_worker\_adapter.ts:193](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L193)
diff --git a/docs/functions/createFile.md b/docs/functions/createFile.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file was su
 
 ## Defined in
 
-[fs/opfs\_core.ts:15](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L15)
+[fs/opfs\_core.ts:15](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L15)
diff --git a/docs/functions/createFileSync.md b/docs/functions/createFileSync.md
@@ -24,4 +24,4 @@ Sync version of `createFile`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:90](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L90)
+[worker/opfs\_worker\_adapter.ts:90](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L90)
diff --git a/docs/functions/deleteTemp.md b/docs/functions/deleteTemp.md
@@ -20,4 +20,4 @@ A promise that resolves to an `AsyncVoidIOResult` indicating whether the tempora
 
 ## Defined in
 
-[fs/opfs\_tmp.ts:29](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_tmp.ts#L29)
+[fs/opfs\_tmp.ts:29](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_tmp.ts#L29)
diff --git a/docs/functions/deleteTempSync.md b/docs/functions/deleteTempSync.md
@@ -18,4 +18,4 @@ Sync version of `deleteTemp`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:214](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L214)
+[worker/opfs\_worker\_adapter.ts:214](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L214)
diff --git a/docs/functions/downloadFile.md b/docs/functions/downloadFile.md
@@ -30,7 +30,7 @@ A task that can be aborted and contains the result of the download.
 
 ### Defined in
 
-[fs/opfs\_download.ts:18](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_download.ts#L18)
+[fs/opfs\_download.ts:18](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_download.ts#L18)
 
 ## downloadFile(fileUrl, filePath, requestInit)
 
@@ -59,4 +59,4 @@ A task that can be aborted and contains the result of the download.
 
 ### Defined in
 
-[fs/opfs\_download.ts:27](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_download.ts#L27)
+[fs/opfs\_download.ts:27](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_download.ts#L27)
diff --git a/docs/functions/emptyDir.md b/docs/functions/emptyDir.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the directory w
 
 ## Defined in
 
-[fs/opfs\_ext.ts:152](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L152)
+[fs/opfs\_ext.ts:152](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L152)
diff --git a/docs/functions/emptyDirSync.md b/docs/functions/emptyDirSync.md
@@ -24,4 +24,4 @@ Sync version of `emptyDir`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:200](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L200)
+[worker/opfs\_worker\_adapter.ts:200](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L200)
diff --git a/docs/functions/exists.md b/docs/functions/exists.md
@@ -27,4 +27,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file or dir
 
 ## Defined in
 
-[fs/opfs\_ext.ts:176](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L176)
+[fs/opfs\_ext.ts:176](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L176)
diff --git a/docs/functions/existsSync.md b/docs/functions/existsSync.md
@@ -25,4 +25,4 @@ Sync version of `exists`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:207](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L207)
+[worker/opfs\_worker\_adapter.ts:207](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L207)
diff --git a/docs/functions/generateTempPath.md b/docs/functions/generateTempPath.md
@@ -26,4 +26,4 @@ The temporary path.
 
 ## Defined in
 
-[fs/utils.ts:11](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/utils.ts#L11)
+[fs/utils.ts:11](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/utils.ts#L11)
diff --git a/docs/functions/getFileDataByHandle.md b/docs/functions/getFileDataByHandle.md
@@ -26,4 +26,4 @@ A promise that resolves to the data of the file.
 
 ## Defined in
 
-[fs/utils.ts:97](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/utils.ts#L97)
+[fs/utils.ts:97](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/utils.ts#L97)
diff --git a/docs/functions/isDirectoryHandle.md b/docs/functions/isDirectoryHandle.md
@@ -26,4 +26,4 @@ Whether the handle is a directory.
 
 ## Defined in
 
-[fs/utils.ts:79](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/utils.ts#L79)
+[fs/utils.ts:79](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/utils.ts#L79)
diff --git a/docs/functions/isFileHandle.md b/docs/functions/isFileHandle.md
@@ -26,4 +26,4 @@ Whether the handle is a file.
 
 ## Defined in
 
-[fs/utils.ts:70](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/utils.ts#L70)
+[fs/utils.ts:70](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/utils.ts#L70)
diff --git a/docs/functions/isFileHandleLike.md b/docs/functions/isFileHandleLike.md
@@ -26,4 +26,4 @@ Whether the handle is a file-like.
 
 ## Defined in
 
-[fs/utils.ts:88](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/utils.ts#L88)
+[fs/utils.ts:88](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/utils.ts#L88)
diff --git a/docs/functions/isOPFSSupported.md b/docs/functions/isOPFSSupported.md
@@ -20,4 +20,4 @@ A boolean indicating whether OPFS is supported.
 
 ## Defined in
 
-[fs/support.ts:6](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/support.ts#L6)
+[fs/support.ts:6](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/support.ts#L6)
diff --git a/docs/functions/isTempPath.md b/docs/functions/isTempPath.md
@@ -26,4 +26,4 @@ Check whether the path is a temporary path.
 
 ## Defined in
 
-[fs/utils.ts:30](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/utils.ts#L30)
+[fs/utils.ts:30](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/utils.ts#L30)
diff --git a/docs/functions/mkTemp.md b/docs/functions/mkTemp.md
@@ -26,4 +26,4 @@ A promise that resolves the result of the temporary file or directory path.
 
 ## Defined in
 
-[fs/opfs\_tmp.ts:14](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_tmp.ts#L14)
+[fs/opfs\_tmp.ts:14](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_tmp.ts#L14)
diff --git a/docs/functions/mkTempSync.md b/docs/functions/mkTempSync.md
@@ -24,4 +24,4 @@ Sync version of `mkTemp`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:221](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L221)
+[worker/opfs\_worker\_adapter.ts:221](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L221)
diff --git a/docs/functions/mkdir.md b/docs/functions/mkdir.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the directory w
 
 ## Defined in
 
-[fs/opfs\_core.ts:31](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L31)
+[fs/opfs\_core.ts:31](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L31)
diff --git a/docs/functions/mkdirSync.md b/docs/functions/mkdirSync.md
@@ -24,4 +24,4 @@ Sync version of `mkdir`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:97](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L97)
+[worker/opfs\_worker\_adapter.ts:97](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L97)
diff --git a/docs/functions/move.md b/docs/functions/move.md
@@ -31,4 +31,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file or dir
 
 ## Defined in
 
-[fs/opfs\_ext.ts:202](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L202)
+[fs/opfs\_ext.ts:202](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L202)
diff --git a/docs/functions/moveSync.md b/docs/functions/moveSync.md
@@ -29,4 +29,4 @@ Sync version of `move`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:104](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L104)
+[worker/opfs\_worker\_adapter.ts:104](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L104)
diff --git a/docs/functions/pruneTemp.md b/docs/functions/pruneTemp.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncVoidIOResult` indicating whether the tempora
 
 ## Defined in
 
-[fs/opfs\_tmp.ts:38](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_tmp.ts#L38)
+[fs/opfs\_tmp.ts:38](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_tmp.ts#L38)
diff --git a/docs/functions/pruneTempSync.md b/docs/functions/pruneTempSync.md
@@ -24,4 +24,4 @@ Sync version of `pruneTemp`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:228](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L228)
+[worker/opfs\_worker\_adapter.ts:228](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L228)
diff --git a/docs/functions/readBlobFile.md b/docs/functions/readBlobFile.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` containing the file content as a F
 
 ## Defined in
 
-[fs/opfs\_ext.ts:219](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L219)
+[fs/opfs\_ext.ts:219](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L219)
diff --git a/docs/functions/readBlobFileSync.md b/docs/functions/readBlobFileSync.md
@@ -24,4 +24,4 @@ Sync version of `readBlobFile`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:235](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L235)
+[worker/opfs\_worker\_adapter.ts:235](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L235)
diff --git a/docs/functions/readDir.md b/docs/functions/readDir.md
@@ -27,4 +27,4 @@ A promise that resolves to an `AsyncIOResult` containing an async iterable itera
 
 ## Defined in
 
-[fs/opfs\_core.ts:48](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L48)
+[fs/opfs\_core.ts:48](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L48)
diff --git a/docs/functions/readDirSync.md b/docs/functions/readDirSync.md
@@ -25,4 +25,4 @@ Sync version of `readDir`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:111](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L111)
+[worker/opfs\_worker\_adapter.ts:111](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L111)
diff --git a/docs/functions/readFile.md b/docs/functions/readFile.md
@@ -57,7 +57,7 @@ Optional read options.
 
 ### Defined in
 
-[fs/opfs\_core.ts:80](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L80)
+[fs/opfs\_core.ts:80](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L80)
 
 ## readFile(filePath, options)
 
@@ -96,7 +96,7 @@ Optional read options.
 
 ### Defined in
 
-[fs/opfs\_core.ts:91](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L91)
+[fs/opfs\_core.ts:91](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L91)
 
 ## readFile(filePath, options)
 
@@ -135,4 +135,4 @@ Optional read options.
 
 ### Defined in
 
-[fs/opfs\_core.ts:102](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L102)
+[fs/opfs\_core.ts:102](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L102)
diff --git a/docs/functions/readFileSync.md b/docs/functions/readFileSync.md
@@ -27,7 +27,7 @@ Sync version of `readFile`.
 
 ### Defined in
 
-[worker/opfs\_worker\_adapter.ts:118](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L118)
+[worker/opfs\_worker\_adapter.ts:118](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L118)
 
 ## readFileSync(filePath, options)
 
@@ -48,7 +48,7 @@ function readFileSync(filePath, options): IOResult<string>
 
 ### Defined in
 
-[worker/opfs\_worker\_adapter.ts:121](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L121)
+[worker/opfs\_worker\_adapter.ts:121](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L121)
 
 ## readFileSync(filePath, options)
 
@@ -69,4 +69,4 @@ function readFileSync(filePath, options?): IOResult<ArrayBuffer>
 
 ### Defined in
 
-[worker/opfs\_worker\_adapter.ts:124](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L124)
+[worker/opfs\_worker\_adapter.ts:124](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L124)
diff --git a/docs/functions/readJsonFile.md b/docs/functions/readJsonFile.md
@@ -0,0 +1,35 @@
+[**happy-opfs**](../README.md) • **Docs**
+
+***
+
+[happy-opfs](../README.md) / readJsonFile
+
+# Function: readJsonFile()
+
+```ts
+function readJsonFile<T>(filePath): AsyncIOResult<T>
+```
+
+Reads the content of a file at the specified path as a string and returns it as a JSON object.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to read. |
+
+## Returns
+
+`AsyncIOResult`\<`T`\>
+
+A promise that resolves to an `AsyncIOResult` containing the file content as a JSON object.
+
+## Defined in
+
+[fs/opfs\_ext.ts:231](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L231)
diff --git a/docs/functions/readJsonFileSync.md b/docs/functions/readJsonFileSync.md
@@ -0,0 +1,33 @@
+[**happy-opfs**](../README.md) • **Docs**
+
+***
+
+[happy-opfs](../README.md) / readJsonFileSync
+
+# Function: readJsonFileSync()
+
+```ts
+function readJsonFileSync<T>(filePath): IOResult<T>
+```
+
+Sync version of `readJsonFile`.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+
+## Returns
+
+`IOResult`\<`T`\>
+
+## Defined in
+
+[worker/opfs\_worker\_adapter.ts:244](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L244)
diff --git a/docs/functions/readTextFile.md b/docs/functions/readTextFile.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` containing the file content as a s
 
 ## Defined in
 
-[fs/opfs\_ext.ts:231](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L231)
+[fs/opfs\_ext.ts:247](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L247)
diff --git a/docs/functions/readTextFileSync.md b/docs/functions/readTextFileSync.md
@@ -24,4 +24,4 @@ Sync version of `readTextFile`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:244](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L244)
+[worker/opfs\_worker\_adapter.ts:257](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L257)
diff --git a/docs/functions/remove.md b/docs/functions/remove.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file or dir
 
 ## Defined in
 
-[fs/opfs\_core.ts:143](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L143)
+[fs/opfs\_core.ts:143](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L143)
diff --git a/docs/functions/removeSync.md b/docs/functions/removeSync.md
@@ -24,4 +24,4 @@ Sync version of `remove`.
 
 ## Defined in
 
-[worker/opfs\_worker\_adapter.ts:152](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L152)
+[worker/opfs\_worker\_adapter.ts:152](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L152)
diff --git a/docs/functions/startSyncAgent.md b/docs/functions/startSyncAgent.md
@@ -20,4 +20,4 @@ Start runner loop.
 
 ## Defined in
 
-[worker/opfs\_worker.ts:45](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker.ts#L45)
+[worker/opfs\_worker.ts:45](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker.ts#L45)
diff --git a/docs/functions/stat.md b/docs/functions/stat.md
@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` containing the `FileSystemHandle`.
 
 ## Defined in
 
-[fs/opfs\_core.ts:182](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L182)
+[fs/opfs\_core.ts:182](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L182)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -27,4 +27,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the content was

		## Defined in

		[fs/opfs\_ext.ts:120](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L120)
		[fs/opfs\_ext.ts:120](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L120)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,4 +25,4 @@ Sync version of `appendFile`.

		## Defined in

		[worker/opfs\_worker\_adapter.ts:186](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L186)
		[worker/opfs\_worker\_adapter.ts:186](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L186)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,4 +28,4 @@ Will throw an error if the path is not an absolute path.

		## Defined in

		[fs/assertions.ts:10](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/assertions.ts#L10)
		[fs/assertions.ts:10](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/assertions.ts#L10)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,4 @@ Communicate with worker.

		## Defined in

		[worker/opfs\_worker\_adapter.ts:17](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L17)
		[worker/opfs\_worker\_adapter.ts:17](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L17)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -33,4 +33,4 @@ A promise that resolves to an `AsyncVoidIOResult` indicating whether the file wa

		## Defined in

		[fs/opfs\_ext.ts:136](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_ext.ts#L136)
		[fs/opfs\_ext.ts:136](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_ext.ts#L136)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -29,4 +29,4 @@ Sync version of `copy`.

		## Defined in

		[worker/opfs\_worker\_adapter.ts:193](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L193)
		[worker/opfs\_worker\_adapter.ts:193](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L193)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file was su

		## Defined in

		[fs/opfs\_core.ts:15](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_core.ts#L15)
		[fs/opfs\_core.ts:15](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_core.ts#L15)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -24,4 +24,4 @@ Sync version of `createFile`.

		## Defined in

		[worker/opfs\_worker\_adapter.ts:90](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L90)
		[worker/opfs\_worker\_adapter.ts:90](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L90)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -20,4 +20,4 @@ A promise that resolves to an `AsyncVoidIOResult` indicating whether the tempora

		## Defined in

		[fs/opfs\_tmp.ts:29](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/fs/opfs_tmp.ts#L29)
		[fs/opfs\_tmp.ts:29](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/fs/opfs_tmp.ts#L29)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,4 +18,4 @@ Sync version of `deleteTemp`.

		## Defined in

		[worker/opfs\_worker\_adapter.ts:214](https://github.com/JiangJie/happy-opfs/blob/1fc39add615fcd3c1ee38b13edeb0d38cd3481c4/src/worker/opfs_worker_adapter.ts#L214)
		[worker/opfs\_worker\_adapter.ts:214](https://github.com/JiangJie/happy-opfs/blob/41bfb9280ee562c4a8708809308f96d116edb112/src/worker/opfs_worker_adapter.ts#L214)