@themartiancompany/opfs 1.8.11

package/docs/functions/pruneTempSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / pruneTempSync
+
+# Function: pruneTempSync()
+
+```ts
+function pruneTempSync(expired): VoidIOResult
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:533
+
+Sync version of `pruneTemp`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `expired` | `Date` |
+
+## Returns
+
+`VoidIOResult`

package/docs/functions/readBlobFile.md

@@ -0,0 +1,28 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readBlobFile
+
+# Function: readBlobFile()
+
+```ts
+function readBlobFile(filePath): AsyncIOResult<File>
+```
+
+Defined in: fs/opfs\_ext.ts:446
+
+Reads the content of a file at the specified path as a File.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to read. |
+
+## Returns
+
+`AsyncIOResult`\<`File`\>
+
+A promise that resolves to an `AsyncIOResult`
+         containing the file content as a File.

package/docs/functions/readBlobFileSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readBlobFileSync
+
+# Function: readBlobFileSync()
+
+```ts
+function readBlobFileSync(filePath): IOResult<FileLike>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:547
+
+Sync version of `readBlobFile`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+
+## Returns
+
+`IOResult`\<[`FileLike`](../interfaces/FileLike.md)\>

package/docs/functions/readDir.md

@@ -0,0 +1,28 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readDir
+
+# Function: readDir()
+
+```ts
+function readDir(dirPath, options?): AsyncIOResult<AsyncIterableIterator<ReadDirEntry, any, any>>
+```
+
+Defined in: fs/opfs\_core.ts:104
+
+Reads the contents of a directory at the specified path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `dirPath` | `string` | The path of the directory to read. |
+| `options`? | [`ReadDirOptions`](../interfaces/ReadDirOptions.md) | Options of readdir. |
+
+## Returns
+
+`AsyncIOResult`\<`AsyncIterableIterator`\<[`ReadDirEntry`](../interfaces/ReadDirEntry.md), `any`, `any`\>\>
+
+A promise that resolves to an `AsyncIOResult` containing an async iterable iterator over the entries of the directory.

package/docs/functions/readDirSync.md

@@ -0,0 +1,26 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readDirSync
+
+# Function: readDirSync()
+
+```ts
+function readDirSync(dirPath, options?): IOResult<ReadDirEntrySync[]>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:278
+
+Sync version of `readDir`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `dirPath` | `string` |
+| `options`? | [`ReadDirOptions`](../interfaces/ReadDirOptions.md) |
+
+## Returns
+
+`IOResult`\<[`ReadDirEntrySync`](../interfaces/ReadDirEntrySync.md)[]\>

package/docs/functions/readFile.md

@@ -0,0 +1,132 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readFile
+
+# Function: readFile()
+
+Reads the content of a file at the specified path with the specified options.
+
+## Template
+
+The type of the content to read from the file.
+
+## Param
+
+The path of the file to read.
+
+## Param
+
+Optional read options.
+
+## Call Signature
+
+```ts
+function readFile(filePath, options): AsyncIOResult<File>
+```
+
+Defined in: fs/opfs\_core.ts:162
+
+Reads the content of a file at the specified path as a File.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to read. |
+| `options` | [`ReadOptions`](../interfaces/ReadOptions.md) & \{ `encoding`: `"blob"`; \} | Read options specifying the 'blob' encoding. |
+
+### Returns
+
+`AsyncIOResult`\<`File`\>
+
+A promise that resolves to an `AsyncIOResult` containing the file content.
+
+A promise that resolves to an `AsyncIOResult` containing the file content as a File.
+
+### Template
+
+The type of the content to read from the file.
+
+### Param
+
+The path of the file to read.
+
+### Param
+
+Optional read options.
+
+## Call Signature
+
+```ts
+function readFile(filePath, options): AsyncIOResult<string>
+```
+
+Defined in: fs/opfs\_core.ts:178
+
+Reads the content of a file at the specified path as a string.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to read. |
+| `options` | [`ReadOptions`](../interfaces/ReadOptions.md) & \{ `encoding`: `"utf8"`; \} | Read options specifying the 'utf8' encoding. |
+
+### Returns
+
+`AsyncIOResult`\<`string`\>
+
+A promise that resolves to an `AsyncIOResult` containing the file content.
+
+A promise that resolves to an `AsyncIOResult` containing the file content as a string.
+
+### Template
+
+The type of the content to read from the file.
+
+### Param
+
+The path of the file to read.
+
+### Param
+
+Optional read options.
+
+## Call Signature
+
+```ts
+function readFile(filePath, options?): AsyncIOResult<ArrayBuffer>
+```
+
+Defined in: fs/opfs\_core.ts:194
+
+Reads the content of a file at the specified path as an ArrayBuffer by default.
+
+### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to read. |
+| `options`? | [`ReadOptions`](../interfaces/ReadOptions.md) & \{ `encoding`: `"binary"`; \} | Read options specifying the 'binary' encoding. |
+
+### Returns
+
+`AsyncIOResult`\<`ArrayBuffer`\>
+
+A promise that resolves to an `AsyncIOResult` containing the file content.
+
+A promise that resolves to an `AsyncIOResult` containing the file content as an ArrayBuffer.
+
+### Template
+
+The type of the content to read from the file.
+
+### Param
+
+The path of the file to read.
+
+### Param
+
+Optional read options.

package/docs/functions/readFileSync.md

@@ -0,0 +1,70 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readFileSync
+
+# Function: readFileSync()
+
+## Call Signature
+
+```ts
+function readFileSync(filePath, options): IOResult<FileLike>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:295
+
+Sync version of `readFile`.
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+| `options` | [`ReadOptions`](../interfaces/ReadOptions.md) & \{ `encoding`: `"blob"`; \} |
+
+### Returns
+
+`IOResult`\<[`FileLike`](../interfaces/FileLike.md)\>
+
+## Call Signature
+
+```ts
+function readFileSync(filePath, options): IOResult<string>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:305
+
+Sync version of `readFile`.
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+| `options` | [`ReadOptions`](../interfaces/ReadOptions.md) & \{ `encoding`: `"utf8"`; \} |
+
+### Returns
+
+`IOResult`\<`string`\>
+
+## Call Signature
+
+```ts
+function readFileSync(filePath, options?): IOResult<ArrayBuffer>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:315
+
+Sync version of `readFile`.
+
+### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+| `options`? | [`ReadOptions`](../interfaces/ReadOptions.md) & \{ `encoding`: `"binary"`; \} |
+
+### Returns
+
+`IOResult`\<`ArrayBuffer`\>

package/docs/functions/readJsonFile.md

@@ -0,0 +1,35 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readJsonFile
+
+# Function: readJsonFile()
+
+```ts
+function readJsonFile<T>(filePath): AsyncIOResult<T>
+```
+
+Defined in: fs/opfs\_ext.ts:466
+
+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.

package/docs/functions/readJsonFileSync.md

@@ -0,0 +1,31 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readJsonFileSync
+
+# Function: readJsonFileSync()
+
+```ts
+function readJsonFileSync<T>(filePath): IOResult<T>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:562
+
+Sync version of `readJsonFile`.
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `T` |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `filePath` | `string` |
+
+## Returns
+
+`IOResult`\<`T`\>

package/docs/functions/readTextFile.md

@@ -0,0 +1,28 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / readTextFile
+
+# Function: readTextFile()
+
+```ts
+function readTextFile(filePath): AsyncIOResult<string>
+```
+
+Defined in: fs/opfs\_ext.ts:496
+
+Reads the content of a file at the specified path as a string.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `filePath` | `string` | The path of the file to read. |
+
+## Returns
+
+`AsyncIOResult`\<`string`\>
+
+A promise that resolves to an `AsyncIOResult`
+         containing the file content as a string.

package/docs/functions/readTextFileSync.md

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

package/docs/functions/remove.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / remove
+
+# Function: remove()
+
+```ts
+function remove(path): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_core.ts:255
+
+Removes a file or directory at the specified path same as `rm -rf`.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | The path of the file or directory to remove. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult` indicating whether the file or directory was successfully removed.

package/docs/functions/removeSync.md

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

package/docs/functions/setSyncMessenger.md

@@ -0,0 +1,26 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / setSyncMessenger
+
+# Function: setSyncMessenger()
+
+```ts
+function setSyncMessenger(syncMessenger): void
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:153
+
+Set messenger instance.
+Use this method to share messenger with other environments.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `syncMessenger` | [`SyncMessenger`](../classes/SyncMessenger.md) | SyncMessenger instance. |
+
+## Returns
+
+`void`

package/docs/functions/startSyncAgent.md

@@ -0,0 +1,21 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / startSyncAgent
+
+# Function: startSyncAgent()
+
+```ts
+function startSyncAgent(): void
+```
+
+Defined in: worker/opfs\_worker.ts:111
+
+Start worker agent.
+Listens to postMessage from main thread.
+Start runner loop.
+
+## Returns
+
+`void`

package/docs/functions/stat.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / stat
+
+# Function: stat()
+
+```ts
+function stat(path): AsyncIOResult<FileSystemHandle>
+```
+
+Defined in: fs/opfs\_core.ts:316
+
+Retrieves the status of a file or directory at the specified path.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | The path of the file or directory to retrieve status for. |
+
+## Returns
+
+`AsyncIOResult`\<`FileSystemHandle`\>
+
+A promise that resolves to an `AsyncIOResult` containing the `FileSystemHandle`.

package/docs/functions/statSync.md

@@ -0,0 +1,25 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / statSync
+
+# Function: statSync()
+
+```ts
+function statSync(path): IOResult<FileSystemHandleLike>
+```
+
+Defined in: worker/opfs\_worker\_adapter.ts:382
+
+Sync version of `stat`.
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+
+## Returns
+
+`IOResult`\<[`FileSystemHandleLike`](../interfaces/FileSystemHandleLike.md)\>

package/docs/functions/toFileSystemHandleLike.md

@@ -0,0 +1,27 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / toFileSystemHandleLike
+
+# Function: toFileSystemHandleLike()
+
+```ts
+function toFileSystemHandleLike(handle): Promise<FileSystemHandleLike>
+```
+
+Defined in: fs/utils.ts:81
+
+Serialize a `FileSystemHandle` to plain object.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `handle` | `FileSystemHandle` | `FileSystemHandle` object. |
+
+## Returns
+
+`Promise`\<[`FileSystemHandleLike`](../interfaces/FileSystemHandleLike.md)\>
+
+Serializable version of FileSystemHandle that is FileSystemHandleLike.

package/docs/functions/unzip.md

@@ -0,0 +1,32 @@
+[**@themartiancompany/opfs**](../README.md)
+
+***
+
+[@themartiancompany/opfs](../README.md) / unzip
+
+# Function: unzip()
+
+```ts
+function unzip(zipFilePath, targetPath): AsyncVoidIOResult
+```
+
+Defined in: fs/opfs\_unzip.ts:106
+
+Unzip a zip file to a directory.
+Equivalent to `unzip -o <zipFilePath> -d <targetPath>
+
+Usees [fflate](https://github.com/101arrowz/fflate) as the unzip backend.
+
+## Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `zipFilePath` | `string` | Zip file path. |
+| `targetPath` | `string` | The directory to unzip to. |
+
+## Returns
+
+`AsyncVoidIOResult`
+
+A promise that resolves to an `AsyncIOResult`
+         indicating whether the zip file was successfully unzipped.