@themartiancompany/opfs 1.8.11

package/docs/functions/createFile.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / createFile
+
+# Function: createFile()
+
+```ts
+function createFile(filePath): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_core.ts:56
+
+Creates a new file at the specified path same as `touch`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to create. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult` indicating whether the file was successfully created.

package/docs/functions/createFileSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / createFileSync
+
+# Function: createFileSync()
+
+```ts
+function createFileSync(filePath): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:230
+
+Sync version of `createFile`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/deleteTemp.md

@@ -0,0 +1,23 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / deleteTemp
+
+# Function: deleteTemp()
+
+```ts
+function deleteTemp(): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_tmp.ts:81
+
+Delete the temporary directory and all its contents.
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncVoidIOResult`
+         indicating whether the temporary directory was
+         successfully deleted.

package/docs/functions/deleteTempSync.md

@@ -0,0 +1,19 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / deleteTempSync
+
+# Function: deleteTempSync()
+
+```ts
+function deleteTempSync(): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:508
+
+Sync version of `deleteTemp`.
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/downloadFile.md

@@ -0,0 +1,58 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / downloadFile
+
+# Function: downloadFile()
+
+## Call Signature
+
+```ts
+function downloadFile(fileUrl, requestInit?): FetchTask<DownloadFileTempResponse>
+```
+
+Defined in: fs/opfs\_download.ts:50
+
+Downloads a file from a URL and saves it to a temporary file.
+The returned response will contain the temporary file path.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `fileUrl` | `string` | The URL of the file to download. |
+| `requestInit`? | [`FsRequestInit`](../type-aliases/FsRequestInit.md) | Optional request initialization parameters. |
+
+### Returns
+
+`FetchTask`\<[`DownloadFileTempResponse`](../interfaces/DownloadFileTempResponse.md)\>
+
+A task that can be aborted and contains the result of the download.
+
+## Call Signature
+
+```ts
+function downloadFile(
+   fileUrl, 
+   filePath, 
+requestInit?): FetchTask<Response>
+```
+
+Defined in: fs/opfs\_download.ts:66
+
+Downloads a file from a URL and saves it to the specified path.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `fileUrl` | `string` | The URL of the file to download. |
+| `filePath` | `string` | The path where the downloaded file will be saved. |
+| `requestInit`? | [`FsRequestInit`](../type-aliases/FsRequestInit.md) | Optional request initialization parameters. |
+
+### Returns
+
+`FetchTask`\<`Response`\>
+
+A task that can be aborted and contains the result of the download.

package/docs/functions/emptyDir.md

@@ -0,0 +1,28 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / emptyDir
+
+# Function: emptyDir()
+
+```ts
+function emptyDir(dirPath): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_ext.ts:315
+
+Empties the contents of a directory at the specified path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `dirPath` | `string` | The path of the directory to empty. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the directory was successfully emptied.

package/docs/functions/emptyDirSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / emptyDirSync
+
+# Function: emptyDirSync()
+
+```ts
+function emptyDirSync(dirPath): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:477
+
+Sync version of `emptyDir`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `dirPath` | `string` |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/exists.md

@@ -0,0 +1,29 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / exists
+
+# Function: exists()
+
+```ts
+function exists(path, options?): AsyncIOResult<boolean>
+```
+
+Defined in: fs/opfs\_ext.ts:357
+
+Checks whether a file or directory exists at the specified path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | The path of the file or directory to check for existence. |
+| `options`? | [`ExistsOptions`](../interfaces/ExistsOptions.md) | Optional existence options. |
+
+## Returns
+
+`AsyncIOResult`\<`boolean`\>
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the file or directory exists.

package/docs/functions/existsSync.md

@@ -0,0 +1,26 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / existsSync
+
+# Function: existsSync()
+
+```ts
+function existsSync(path, options?): IOResult<boolean>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:491
+
+Sync version of `exists`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `options`? | [`ExistsOptions`](../interfaces/ExistsOptions.md) |
+
+## Returns
+
+`IOResult`\<`boolean`\>

package/docs/functions/generateTempPath.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / generateTempPath
+
+# Function: generateTempPath()
+
+```ts
+function generateTempPath(options?): string
+```
+
+Defined in: fs/utils.ts:41
+
+Generate a temporary path but not create it.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options`? | [`TempOptions`](../interfaces/TempOptions.md) | Options and flags. |
+
+## Returns
+
+`string`
+
+The temporary path.

package/docs/functions/getFileDataByHandle.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / getFileDataByHandle
+
+# Function: getFileDataByHandle()
+
+```ts
+function getFileDataByHandle(handle): Promise<Uint8Array<ArrayBufferLike>>
+```
+
+Defined in: fs/utils.ts:164
+
+Gets the data of a file handle.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `handle` | `FileSystemFileHandle` | The file handle. |
+
+## Returns
+
+`Promise`\<`Uint8Array`\<`ArrayBufferLike`\>\>
+
+A promise that resolves to the data of the file.

package/docs/functions/getSyncMessenger.md

@@ -0,0 +1,22 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / getSyncMessenger
+
+# Function: getSyncMessenger()
+
+```ts
+function getSyncMessenger(): SyncMessenger
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:140
+
+Get messenger instance.
+Use `setSyncMessenger` to pass the messenger to other environments for sharing.
+
+## Returns
+
+[`SyncMessenger`](../classes/SyncMessenger.md)
+
+SyncMessenger instance.

package/docs/functions/isDirectoryHandle.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / isDirectoryHandle
+
+# Function: isDirectoryHandle()
+
+```ts
+function isDirectoryHandle(handle): handle is FileSystemDirectoryHandle
+```
+
+Defined in: fs/utils.ts:138
+
+Whether the handle is a directory.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `handle` | `FileSystemHandle` | The handle which is a FileSystemHandle. |
+
+## Returns
+
+`handle is FileSystemDirectoryHandle`
+
+`true` if the handle is a directory, otherwise `false`.

package/docs/functions/isFileHandle.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / isFileHandle
+
+# Function: isFileHandle()
+
+```ts
+function isFileHandle(handle): handle is FileSystemFileHandle
+```
+
+Defined in: fs/utils.ts:125
+
+Whether the handle is a file.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `handle` | `FileSystemHandle` | The handle which is a FileSystemHandle. |
+
+## Returns
+
+`handle is FileSystemFileHandle`
+
+`true` if the handle is a file, otherwise `false`.

package/docs/functions/isFileHandleLike.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / isFileHandleLike
+
+# Function: isFileHandleLike()
+
+```ts
+function isFileHandleLike(handle): handle is FileSystemFileHandleLike
+```
+
+Defined in: fs/utils.ts:151
+
+Whether the handle is a file-like.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `handle` | [`FileSystemHandleLike`](../interfaces/FileSystemHandleLike.md) | The handle which is a FileSystemHandleLike. |
+
+## Returns
+
+`handle is FileSystemFileHandleLike`
+
+`true` if the handle is a file, otherwise `false`.

package/docs/functions/isOPFSSupported.md

@@ -0,0 +1,21 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / isOPFSSupported
+
+# Function: isOPFSSupported()
+
+```ts
+function isOPFSSupported(): boolean
+```
+
+Defined in: fs/support.ts:33
+
+Checks if the Origin Private File System (OPFS) is supported in the current environment.
+
+## Returns
+
+`boolean`
+
+A boolean indicating whether OPFS is supported.

package/docs/functions/isTempPath.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / isTempPath
+
+# Function: isTempPath()
+
+```ts
+function isTempPath(path): boolean
+```
+
+Defined in: fs/utils.ts:67
+
+Check whether the path is a temporary path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | The path to check. |
+
+## Returns
+
+`boolean`
+
+`true` if the path is a temporary path otherwise `false`.

package/docs/functions/mkTemp.md

@@ -0,0 +1,28 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / mkTemp
+
+# Function: mkTemp()
+
+```ts
+function mkTemp(options?): AsyncIOResult<string>
+```
+
+Defined in: fs/opfs\_tmp.ts:51
+
+Create a temporary file or directory.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `options`? | [`TempOptions`](../interfaces/TempOptions.md) | Options and flags. |
+
+## Returns
+
+`AsyncIOResult`\<`string`\>
+
+A promise that resolves the result of
+         the temporary file or directory path.

package/docs/functions/mkTempSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / mkTempSync
+
+# Function: mkTempSync()
+
+```ts
+function mkTempSync(options?): IOResult<string>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:519
+
+Sync version of `mkTemp`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options`? | [`TempOptions`](../interfaces/TempOptions.md) |
+
+## Returns
+
+`IOResult`\<`string`\>

package/docs/functions/mkdir.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / mkdir
+
+# Function: mkdir()
+
+```ts
+function mkdir(dirPath): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_core.ts:79
+
+Creates a new directory at the specified path same as `mkdir -p`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `dirPath` | `string` | The path where the new directory will be created. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult` indicating whether the directory was successfully created.

package/docs/functions/mkdirSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / mkdirSync
+
+# Function: mkdirSync()
+
+```ts
+function mkdirSync(dirPath): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:244
+
+Sync version of `mkdir`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `dirPath` | `string` |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/move.md

@@ -0,0 +1,34 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / move
+
+# Function: move()
+
+```ts
+function move(
+   srcPath, 
+   destPath, 
+   options?): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_ext.ts:412
+
+Move a file or directory from an old path to a new path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `srcPath` | `string` | The current path of the file or directory. |
+| `destPath` | `string` | The new path of the file or directory. |
+| `options`? | [`MoveOptions`](../interfaces/MoveOptions.md) | Options of move. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the file or directory was
+         successfully moved.

package/docs/functions/moveSync.md

@@ -0,0 +1,30 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / moveSync
+
+# Function: moveSync()
+
+```ts
+function moveSync(
+   srcPath, 
+   destPath, 
+   options?): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:258
+
+Sync version of `move`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `srcPath` | `string` |
+| `destPath` | `string` |
+| `options`? | [`MoveOptions`](../interfaces/MoveOptions.md) |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/pruneTemp.md

@@ -0,0 +1,28 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / pruneTemp
+
+# Function: pruneTemp()
+
+```ts
+function pruneTemp(expired): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_tmp.ts:95
+
+Prune the temporary directory and delete all expired files.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `expired` | `Date` | The date to determine whether a file is expired. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncVoidIOResult`
+         indicating whether the temporary directory was successfully pruned.