@themartiancompany/opfs 1.8.11

package/docs/functions/unzipFromUrl.md

@@ -0,0 +1,36 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / unzipFromUrl
+
+# Function: unzipFromUrl()
+
+```ts
+function unzipFromUrl(
+   zipFileUrl, 
+   targetPath, 
+   requestInit?): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_unzip.ts:139
+
+Unzip a remote zip file to a directory.
+Equivalent to `unzip -o <zipFilePath> -d <targetPath>
+
+Use [fflate](https://github.com/101arrowz/fflate) as the unzip backend.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `zipFileUrl` | `string` | Zip file url. |
+| `targetPath` | `string` | The directory to unzip to. |
+| `requestInit`? | [`FsRequestInit`](../type-aliases/FsRequestInit.md) | Optional request initialization parameters. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the zip file was successfully unzipped.

package/docs/functions/unzipSync.md

@@ -0,0 +1,26 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / unzipSync
+
+# Function: unzipSync()
+
+```ts
+function unzipSync(zipFilePath, targetPath): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:602
+
+Sync version of `unzip`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `zipFilePath` | `string` |
+| `targetPath` | `string` |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/uploadFile.md

@@ -0,0 +1,33 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / uploadFile
+
+# Function: uploadFile()
+
+```ts
+function uploadFile(
+   filePath, 
+   fileUrl, 
+requestInit?): FetchTask<Response>
+```
+
+Defined in: fs/opfs\_upload.ts:47
+
+Uploads a file from the specified path to a URL.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to upload. |
+| `fileUrl` | `string` | The URL where the file will be uploaded. |
+| `requestInit`? | [`UploadRequestInit`](../interfaces/UploadRequestInit.md) | Optional request initialization parameters. |
+
+## Returns
+
+`FetchTask`\<`Response`\>
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the file was successfully uploaded.

package/docs/functions/writeFile.md

@@ -0,0 +1,32 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / writeFile
+
+# Function: writeFile()
+
+```ts
+function writeFile(
+   filePath, 
+   contents, 
+   options?): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_core.ts:369
+
+Writes content to a file at the specified path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to write to. |
+| `contents` | [`WriteFileContent`](../type-aliases/WriteFileContent.md) | The content to write to the file. |
+| `options`? | [`WriteOptions`](../interfaces/WriteOptions.md) | Optional write options. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult` indicating whether the file was successfully written.

package/docs/functions/writeFileSync.md

@@ -0,0 +1,30 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / writeFileSync
+
+# Function: writeFileSync()
+
+```ts
+function writeFileSync(
+   filePath, 
+   contents, 
+   options?): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:418
+
+Sync version of `writeFile`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+| `contents` | [`WriteSyncFileContent`](../type-aliases/WriteSyncFileContent.md) |
+| `options`? | [`WriteOptions`](../interfaces/WriteOptions.md) |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/zip.md

@@ -0,0 +1,65 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / zip
+
+# Function: zip()
+
+## Call Signature
+
+```ts
+function zip(
+   sourcePath, 
+   zipFilePath, 
+   options?): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_zip.ts:105
+
+Zip a file or directory and write to a zip file.
+Equivalent to `zip -r <zipFilePath> <targetPath>`.
+
+Use [fflate](https://github.com/101arrowz/fflate) as the zip backend.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sourcePath` | `string` | The path to be zipped. |
+| `zipFilePath` | `string` | The path to the zip file. |
+| `options`? | [`ZipOptions`](../interfaces/ZipOptions.md) | Options of zip. |
+
+### Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the source was successfully zipped.
+
+## Call Signature
+
+```ts
+function zip(sourcePath, options?): AsyncIOResult<Uint8Array<ArrayBufferLike>>
+```
+
+Defined in: fs/opfs\_zip.ts:126
+
+Zip a file or directory and return the zip file data.
+Equivalent to `zip -r <zipFilePath> <targetPath>`.
+
+Use [fflate](https://github.com/101arrowz/fflate) as the zip backend.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sourcePath` | `string` | The path to be zipped. |
+| `options`? | [`ZipOptions`](../interfaces/ZipOptions.md) | Options of zip. |
+
+### Returns
+
+`AsyncIOResult`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+A promise that resolves to an `AsyncIOResult` indicating
+         whether the source was successfully zipped.

package/docs/functions/zipFromUrl.md

@@ -0,0 +1,63 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / zipFromUrl
+
+# Function: zipFromUrl()
+
+## Call Signature
+
+```ts
+function zipFromUrl(
+   sourceUrl, 
+   zipFilePath, 
+   requestInit?): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_zip.ts:234
+
+Zip a remote file and write to a zip file.
+
+Use [fflate](https://github.com/101arrowz/fflate) as the zip backend.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sourceUrl` | `string` | The url to be zipped. |
+| `zipFilePath` | `string` | The path to the zip file. |
+| `requestInit`? | [`FsRequestInit`](../type-aliases/FsRequestInit.md) | Optional request initialization parameters. |
+
+### Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the source was successfully zipped.
+
+## Call Signature
+
+```ts
+function zipFromUrl(sourceUrl, requestInit?): AsyncIOResult<Uint8Array<ArrayBufferLike>>
+```
+
+Defined in: fs/opfs\_zip.ts:254
+
+Zip a remote file and return the zip file data.
+
+Use [fflate](https://github.com/101arrowz/fflate) as the zip backend.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `sourceUrl` | `string` | The url to be zipped. |
+| `requestInit`? | [`FsRequestInit`](../type-aliases/FsRequestInit.md) | Optional request initialization parameters. |
+
+### Returns
+
+`AsyncIOResult`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+A promise that resolves to an `AsyncIOResult` indicating
+         whether the source was successfully zipped.

package/docs/functions/zipSync.md

@@ -0,0 +1,55 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / zipSync
+
+# Function: zipSync()
+
+Sync version of `zip`.
+
+## Call Signature
+
+```ts
+function zipSync(
+   sourcePath, 
+   zipFilePath, 
+   options?): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:619
+
+Sync version of `zip`.
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `sourcePath` | `string` |
+| `zipFilePath` | `string` |
+| `options`? | [`ZipOptions`](../interfaces/ZipOptions.md) |
+
+### Returns
+
+`VoidIOResult`
+
+## Call Signature
+
+```ts
+function zipSync(sourcePath, options?): IOResult<Uint8Array<ArrayBufferLike>>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:633
+
+Sync version of `zip`.
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `sourcePath` | `string` |
+| `options`? | [`ZipOptions`](../interfaces/ZipOptions.md) |
+
+### Returns
+
+`IOResult`\<`Uint8Array`\<`ArrayBufferLike`\>\>

package/docs/interfaces/CopyOptions.md

@@ -0,0 +1,17 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / CopyOptions
+
+# Interface: CopyOptions
+
+Defined in: fs/defines.ts:317
+
+Options for `copy`.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="overwrite"></a> `overwrite?` | `boolean` | `true` | Whether to overwrite the destination file if it already exists. | fs/defines.ts:322 |

package/docs/interfaces/DownloadFileTempResponse.md

@@ -0,0 +1,18 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / DownloadFileTempResponse
+
+# Interface: DownloadFileTempResponse
+
+Defined in: fs/defines.ts:329
+
+Result of `downloadFile` when the file is saved to a temporary path.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="rawresponse"></a> `rawResponse` | `Response` | The raw response. | fs/defines.ts:338 |
+| <a id="tempfilepath"></a> `tempFilePath` | `string` | The temporary path of the downloaded file to be saved. | fs/defines.ts:333 |

package/docs/interfaces/ErrorLike.md

@@ -0,0 +1,18 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ErrorLike
+
+# Interface: ErrorLike
+
+Defined in: fs/defines.ts:209
+
+Serializable version of Error.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="message"></a> `message` | `string` | The message of the error. | fs/defines.ts:218 |
+| <a id="name"></a> `name` | `string` | The name of the error. | fs/defines.ts:213 |

package/docs/interfaces/ExistsOptions.md

@@ -0,0 +1,18 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ExistsOptions
+
+# Interface: ExistsOptions
+
+Defined in: fs/defines.ts:87
+
+Options to determine the existence of a file or directory.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="isdirectory"></a> `isDirectory?` | `boolean` | `false` | Whether to check for the existence of a directory. | fs/defines.ts:92 |
+| <a id="isfile"></a> `isFile?` | `boolean` | `false` | Whether to check for the existence of a file. | fs/defines.ts:98 |

package/docs/interfaces/FileLike.md

@@ -0,0 +1,21 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / FileLike
+
+# Interface: FileLike
+
+Defined in: fs/defines.ts:225
+
+Serializable version of File.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="data"></a> `data` | `ArrayBuffer` | The binary data of the file. | fs/defines.ts:249 |
+| <a id="lastmodified"></a> `lastModified` | `number` | The last modified time of the file. | fs/defines.ts:239 |
+| <a id="name"></a> `name` | `string` | The name of the file. | fs/defines.ts:229 |
+| <a id="size"></a> `size` | `number` | The size of the file. | fs/defines.ts:244 |
+| <a id="type"></a> `type` | `string` | The type of the file. | fs/defines.ts:234 |

package/docs/interfaces/FileSystemFileHandleLike.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / FileSystemFileHandleLike
+
+# Interface: FileSystemFileHandleLike
+
+Defined in: fs/defines.ts:188
+
+A handle to a file or directory returned by `statSync`.
+
+## Extends
+
+- [`FileSystemHandleLike`](FileSystemHandleLike.md)
+
+## Properties
+
+| Property | Type | Description | Inherited from | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="kind"></a> `kind` | `FileSystemHandleKind` | The kind of the entry. | [`FileSystemHandleLike`](FileSystemHandleLike.md).[`kind`](FileSystemHandleLike.md#kind) | fs/defines.ts:184 |
+| <a id="lastmodified"></a> `lastModified` | `number` | The last modified time of the file. | - | fs/defines.ts:202 |
+| <a id="name"></a> `name` | `string` | The name of the entry. | [`FileSystemHandleLike`](FileSystemHandleLike.md).[`name`](FileSystemHandleLike.md#name) | fs/defines.ts:179 |
+| <a id="size"></a> `size` | `number` | The size of the file. | - | fs/defines.ts:197 |
+| <a id="type"></a> `type` | `string` | The type of the file. | - | fs/defines.ts:192 |

package/docs/interfaces/FileSystemHandleLike.md

@@ -0,0 +1,22 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / FileSystemHandleLike
+
+# Interface: FileSystemHandleLike
+
+Defined in: fs/defines.ts:175
+
+A handle to a file or directory returned by `statSync`.
+
+## Extended by
+
+- [`FileSystemFileHandleLike`](FileSystemFileHandleLike.md)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="kind"></a> `kind` | `FileSystemHandleKind` | The kind of the entry. | fs/defines.ts:184 |
+| <a id="name"></a> `name` | `string` | The name of the entry. | fs/defines.ts:179 |

package/docs/interfaces/MoveOptions.md

@@ -0,0 +1,17 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / MoveOptions
+
+# Interface: MoveOptions
+
+Defined in: fs/defines.ts:345
+
+Options for `move`.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="overwrite"></a> `overwrite?` | `boolean` | `true` | Whether to overwrite the destination file if it already exists. | fs/defines.ts:350 |

package/docs/interfaces/ReadDirEntry.md

@@ -0,0 +1,18 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ReadDirEntry
+
+# Interface: ReadDirEntry
+
+Defined in: fs/defines.ts:143
+
+An entry returned by `readDir`.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="handle"></a> `handle` | `FileSystemHandle` | The handle of the entry. | fs/defines.ts:152 |
+| <a id="path"></a> `path` | `string` | The relative path of the entry from readDir the path parameter. | fs/defines.ts:147 |

package/docs/interfaces/ReadDirEntrySync.md

@@ -0,0 +1,18 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ReadDirEntrySync
+
+# Interface: ReadDirEntrySync
+
+Defined in: fs/defines.ts:159
+
+An entry returned by `readDirSync`.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="handle"></a> `handle` | [`FileSystemHandleLike`](FileSystemHandleLike.md) | The handle of the entry. | fs/defines.ts:168 |
+| <a id="path"></a> `path` | `string` | The relative path of the entry from readDir the path parameter. | fs/defines.ts:163 |

package/docs/interfaces/ReadDirOptions.md

@@ -0,0 +1,17 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ReadDirOptions
+
+# Interface: ReadDirOptions
+
+Defined in: fs/defines.ts:132
+
+Options for reading directories.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="recursive"></a> `recursive` | `boolean` | Whether to recursively read the contents of directories. | fs/defines.ts:136 |

package/docs/interfaces/ReadOptions.md

@@ -0,0 +1,17 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / ReadOptions
+
+# Interface: ReadOptions
+
+Defined in: fs/defines.ts:56
+
+Options for reading files with specified encoding.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="encoding"></a> `encoding?` | [`FileEncoding`](../type-aliases/FileEncoding.md) | `'binary'` | The encoding to use for reading the file's content. | fs/defines.ts:61 |

package/docs/interfaces/SyncAgentOptions.md

@@ -0,0 +1,19 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / SyncAgentOptions
+
+# Interface: SyncAgentOptions
+
+Defined in: fs/defines.ts:256
+
+Setup options of `connectSyncAgent`.
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="bufferlength"></a> `bufferLength?` | `number` | The length of the buffer to use for communication. | fs/defines.ts:267 |
+| <a id="optimeout"></a> `opTimeout?` | `number` | The timeout for operations. | fs/defines.ts:272 |
+| <a id="worker"></a> `worker` | `string` \| `Worker` \| `URL` | The worker to communicate with. | fs/defines.ts:260 |

package/docs/interfaces/TempOptions.md

@@ -0,0 +1,19 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / TempOptions
+
+# Interface: TempOptions
+
+Defined in: fs/defines.ts:291
+
+Options for `mkTemp`.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="basename"></a> `basename?` | `string` | `tmp` | The basename of the file or directory. eg: `mktemp -t basename.XXX` | fs/defines.ts:304 |
+| <a id="extname"></a> `extname?` | `string` | `undefined` | The extension of the file. eg: `mktemp --suffix .txt` | fs/defines.ts:310 |
+| <a id="isdirectory"></a> `isDirectory?` | `boolean` | `false` | Whether to create a directory. eg: `mktemp -d` | fs/defines.ts:297 |

package/docs/interfaces/UploadRequestInit.md

@@ -0,0 +1,21 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / UploadRequestInit
+
+# Interface: UploadRequestInit
+
+Defined in: fs/defines.ts:121
+
+fetch-t request options for uploading files.
+
+## Extends
+
+- [`FsRequestInit`](../type-aliases/FsRequestInit.md)
+
+## Properties
+
+| Property | Type | Description | Defined in |
+| ------ | ------ | ------ | ------ |
+| <a id="filename"></a> `filename?` | `string` | The filename to use when uploading the file. | fs/defines.ts:125 |

package/docs/interfaces/WriteOptions.md

@@ -0,0 +1,19 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / WriteOptions
+
+# Interface: WriteOptions
+
+Defined in: fs/defines.ts:69
+
+Options for writing files, including flags for creation
+and appending.
+
+## Properties
+
+| Property | Type | Default value | Description | Defined in |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="append"></a> `append?` | `boolean` | `false` | Whether to append to the file if it already exists. | fs/defines.ts:80 |
+| <a id="create"></a> `create?` | `boolean` | `true` | Whether to create the file if it does not exist. | fs/defines.ts:74 |