Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jarvisjiang committed Aug 5, 2024
1 parent 6253d25 commit fbbb862
Show file tree
Hide file tree
Showing 51 changed files with 96 additions and 96 deletions.
6 changes: 3 additions & 3 deletions docs/functions/appendFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: appendFile()

```ts
function appendFile(filePath, contents): AsyncIOResult<boolean>
function appendFile(filePath, contents): AsyncVoidIOResult
```

Appends content to a file at the specified path.
Expand All @@ -21,10 +21,10 @@ Appends content to a file at the specified path.

## Returns

`AsyncIOResult`\<`boolean`\>
`AsyncVoidIOResult`

A promise that resolves to an `AsyncIOResult` indicating whether the content was successfully appended.

## Defined in

[fs/opfs\_ext.ts:18](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L18)
[fs/opfs\_ext.ts:18](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L18)
6 changes: 3 additions & 3 deletions docs/functions/appendFileSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: appendFileSync()

```ts
function appendFileSync(filePath, contents): IOResult<boolean>
function appendFileSync(filePath, contents): VoidIOResult
```

Sync version of `appendFile`.
Expand All @@ -21,8 +21,8 @@ Sync version of `appendFile`.

## Returns

`IOResult`\<`boolean`\>
`VoidIOResult`

## Defined in

[worker/opfs\_worker\_adapter.ts:165](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L165)
[worker/opfs\_worker\_adapter.ts:166](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L166)
2 changes: 1 addition & 1 deletion docs/functions/assertAbsolutePath.md
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/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/assertions.ts#L10)
[fs/assertions.ts:10](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/assertions.ts#L10)
2 changes: 1 addition & 1 deletion docs/functions/assertFileUrl.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/assertions.ts#L21)
[fs/assertions.ts:21](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/assertions.ts#L21)
2 changes: 1 addition & 1 deletion docs/functions/connectSyncAgent.md
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/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L17)
[worker/opfs\_worker\_adapter.ts:17](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L17)
2 changes: 1 addition & 1 deletion docs/functions/downloadFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file was su

## Defined in

[fs/opfs\_ext.ts:109](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L109)
[fs/opfs\_ext.ts:109](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L109)
6 changes: 3 additions & 3 deletions docs/functions/emptyDir.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: emptyDir()

```ts
function emptyDir(dirPath): AsyncIOResult<boolean>
function emptyDir(dirPath): AsyncVoidIOResult
```

Empties the contents of a directory at the specified path.
Expand All @@ -20,10 +20,10 @@ Empties the contents of a directory at the specified path.

## Returns

`AsyncIOResult`\<`boolean`\>
`AsyncVoidIOResult`

A promise that resolves to an `AsyncIOResult` indicating whether the directory was successfully emptied.

## Defined in

[fs/opfs\_ext.ts:30](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L30)
[fs/opfs\_ext.ts:30](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L30)
6 changes: 3 additions & 3 deletions docs/functions/emptyDirSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: emptyDirSync()

```ts
function emptyDirSync(dirPath): IOResult<boolean>
function emptyDirSync(dirPath): VoidIOResult
```

Sync version of `emptyDir`.
Expand All @@ -20,8 +20,8 @@ Sync version of `emptyDir`.

## Returns

`IOResult`\<`boolean`\>
`VoidIOResult`

## Defined in

[worker/opfs\_worker\_adapter.ts:172](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L172)
[worker/opfs\_worker\_adapter.ts:173](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L173)
2 changes: 1 addition & 1 deletion docs/functions/exists.md
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 file or dir

## Defined in

[fs/opfs\_ext.ts:58](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L58)
[fs/opfs\_ext.ts:58](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L58)
2 changes: 1 addition & 1 deletion docs/functions/existsSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Sync version of `exists`.

## Defined in

[worker/opfs\_worker\_adapter.ts:179](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L179)
[worker/opfs\_worker\_adapter.ts:180](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L180)
2 changes: 1 addition & 1 deletion docs/functions/isOPFSSupported.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ A boolean indicating whether OPFS is supported.

## Defined in

[fs/support.ts:6](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/support.ts#L6)
[fs/support.ts:6](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/support.ts#L6)
6 changes: 3 additions & 3 deletions docs/functions/mkdir.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: mkdir()

```ts
function mkdir(dirPath): AsyncIOResult<boolean>
function mkdir(dirPath): AsyncVoidIOResult
```

Creates a new directory at the specified path same as `mkdir -p`.
Expand All @@ -20,10 +20,10 @@ Creates a new directory at the specified path same as `mkdir -p`.

## Returns

`AsyncIOResult`\<`boolean`\>
`AsyncVoidIOResult`

A promise that resolves to an `AsyncIOResult` indicating whether the directory was successfully created.

## Defined in

[fs/opfs\_core.ts:14](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L14)
[fs/opfs\_core.ts:14](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L14)
6 changes: 3 additions & 3 deletions docs/functions/mkdirSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: mkdirSync()

```ts
function mkdirSync(dirPath): IOResult<boolean>
function mkdirSync(dirPath): VoidIOResult
```

Sync version of `mkdir`.
Expand All @@ -20,8 +20,8 @@ Sync version of `mkdir`.

## Returns

`IOResult`\<`boolean`\>
`VoidIOResult`

## Defined in

[worker/opfs\_worker\_adapter.ts:89](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L89)
[worker/opfs\_worker\_adapter.ts:90](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L90)
2 changes: 1 addition & 1 deletion docs/functions/readBlobFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` containing the file content as a F

## Defined in

[fs/opfs\_ext.ts:83](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L83)
[fs/opfs\_ext.ts:83](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L83)
2 changes: 1 addition & 1 deletion docs/functions/readBlobFileSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Sync version of `readBlobFile`.

## Defined in

[worker/opfs\_worker\_adapter.ts:186](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L186)
[worker/opfs\_worker\_adapter.ts:187](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L187)
2 changes: 1 addition & 1 deletion docs/functions/readDir.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,4 @@ A promise that resolves to an `AsyncIOResult` containing an async iterable itera

## Defined in

[fs/opfs\_core.ts:31](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L31)
[fs/opfs\_core.ts:31](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L31)
2 changes: 1 addition & 1 deletion docs/functions/readDirSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ Sync version of `readDir`.

## Defined in

[worker/opfs\_worker\_adapter.ts:96](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L96)
[worker/opfs\_worker\_adapter.ts:97](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L97)
6 changes: 3 additions & 3 deletions docs/functions/readFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Optional read options.

### Defined in

[fs/opfs\_core.ts:63](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L63)
[fs/opfs\_core.ts:63](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L63)

## readFile(filePath, options)

Expand Down Expand Up @@ -96,7 +96,7 @@ Optional read options.

### Defined in

[fs/opfs\_core.ts:74](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L74)
[fs/opfs\_core.ts:74](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L74)

## readFile(filePath, options)

Expand Down Expand Up @@ -135,4 +135,4 @@ Optional read options.

### Defined in

[fs/opfs\_core.ts:85](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L85)
[fs/opfs\_core.ts:85](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L85)
6 changes: 3 additions & 3 deletions docs/functions/readFileSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Sync version of `readFile`.

### Defined in

[worker/opfs\_worker\_adapter.ts:103](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L103)
[worker/opfs\_worker\_adapter.ts:104](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L104)

## readFileSync(filePath, options)

Expand All @@ -48,7 +48,7 @@ function readFileSync(filePath, options): IOResult<string>

### Defined in

[worker/opfs\_worker\_adapter.ts:106](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L106)
[worker/opfs\_worker\_adapter.ts:107](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L107)

## readFileSync(filePath, options)

Expand All @@ -69,4 +69,4 @@ function readFileSync(filePath, options?): IOResult<ArrayBuffer>

### Defined in

[worker/opfs\_worker\_adapter.ts:109](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L109)
[worker/opfs\_worker\_adapter.ts:110](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L110)
2 changes: 1 addition & 1 deletion docs/functions/readTextFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` containing the file content as a s

## Defined in

[fs/opfs\_ext.ts:95](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L95)
[fs/opfs\_ext.ts:95](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L95)
2 changes: 1 addition & 1 deletion docs/functions/readTextFileSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Sync version of `readTextFile`.

## Defined in

[worker/opfs\_worker\_adapter.ts:195](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L195)
[worker/opfs\_worker\_adapter.ts:196](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L196)
6 changes: 3 additions & 3 deletions docs/functions/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: remove()

```ts
function remove(path): AsyncIOResult<boolean>
function remove(path): AsyncVoidIOResult
```

Removes a file or directory at the specified path same as `rm -rf`.
Expand All @@ -20,10 +20,10 @@ Removes a file or directory at the specified path same as `rm -rf`.

## Returns

`AsyncIOResult`\<`boolean`\>
`AsyncVoidIOResult`

A promise that resolves to an `AsyncIOResult` indicating whether the file or directory was successfully removed.

## Defined in

[fs/opfs\_core.ts:127](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L127)
[fs/opfs\_core.ts:127](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L127)
6 changes: 3 additions & 3 deletions docs/functions/removeSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: removeSync()

```ts
function removeSync(path): IOResult<boolean>
function removeSync(path): VoidIOResult
```

Sync version of `remove`.
Expand All @@ -20,8 +20,8 @@ Sync version of `remove`.

## Returns

`IOResult`\<`boolean`\>
`VoidIOResult`

## Defined in

[worker/opfs\_worker\_adapter.ts:137](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L137)
[worker/opfs\_worker\_adapter.ts:138](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L138)
6 changes: 3 additions & 3 deletions docs/functions/rename.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: rename()

```ts
function rename(oldPath, newPath): AsyncIOResult<boolean>
function rename(oldPath, newPath): AsyncVoidIOResult
```

Renames a file or directory from an old path to a new path.
Expand All @@ -21,10 +21,10 @@ Renames a file or directory from an old path to a new path.

## Returns

`AsyncIOResult`\<`boolean`\>
`AsyncVoidIOResult`

A promise that resolves to an `AsyncIOResult` indicating whether the file or directory was successfully renamed.

## Defined in

[fs/opfs\_core.ts:162](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L162)
[fs/opfs\_core.ts:162](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L162)
6 changes: 3 additions & 3 deletions docs/functions/renameSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Function: renameSync()

```ts
function renameSync(oldPath, newPath): IOResult<boolean>
function renameSync(oldPath, newPath): VoidIOResult
```

Sync version of `rename`.
Expand All @@ -21,8 +21,8 @@ Sync version of `rename`.

## Returns

`IOResult`\<`boolean`\>
`VoidIOResult`

## Defined in

[worker/opfs\_worker\_adapter.ts:144](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L144)
[worker/opfs\_worker\_adapter.ts:145](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L145)
2 changes: 1 addition & 1 deletion docs/functions/startSyncAgent.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ Start runner loop.

## Defined in

[worker/opfs\_worker.ts:34](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker.ts#L34)
[worker/opfs\_worker.ts:34](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker.ts#L34)
2 changes: 1 addition & 1 deletion docs/functions/stat.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ A promise that resolves to an `AsyncIOResult` containing the `FileSystemHandle`.

## Defined in

[fs/opfs\_core.ts:199](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L199)
[fs/opfs\_core.ts:199](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L199)
2 changes: 1 addition & 1 deletion docs/functions/statSync.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Sync version of `stat`.

## Defined in

[worker/opfs\_worker\_adapter.ts:151](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/worker/opfs_worker_adapter.ts#L151)
[worker/opfs\_worker\_adapter.ts:152](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/worker/opfs_worker_adapter.ts#L152)
2 changes: 1 addition & 1 deletion docs/functions/toFileSystemHandleLike.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ Serializable version of FileSystemHandle that is FileSystemHandleLike.

## Defined in

[fs/utils.ts:8](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/utils.ts#L8)
[fs/utils.ts:8](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/utils.ts#L8)
2 changes: 1 addition & 1 deletion docs/functions/uploadFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ A promise that resolves to an `AsyncIOResult` indicating whether the file was su

## Defined in

[fs/opfs\_ext.ts:173](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_ext.ts#L173)
[fs/opfs\_ext.ts:173](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_ext.ts#L173)
6 changes: 3 additions & 3 deletions docs/functions/writeFile.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
function writeFile(
filePath,
contents,
options?): AsyncIOResult<boolean>
options?): AsyncVoidIOResult
```

Writes content to a file at the specified path.
Expand All @@ -25,10 +25,10 @@ Writes content to a file at the specified path.

## Returns

`AsyncIOResult`\<`boolean`\>
`AsyncVoidIOResult`

A promise that resolves to an `AsyncIOResult` indicating whether the file was successfully written.

## Defined in

[fs/opfs\_core.ts:235](https://github.com/JiangJie/happy-opfs/blob/ff451a853f34b3dedd716c1414a17eb57f239434/src/fs/opfs_core.ts#L235)
[fs/opfs\_core.ts:235](https://github.com/JiangJie/happy-opfs/blob/6253d25d45ee43710777316ce4d92b062d8744f7/src/fs/opfs_core.ts#L235)
Loading

0 comments on commit fbbb862

Please sign in to comment.