npm - @fgv/ts-web-extras - Versions diffs - 5.1.0-3 → 5.1.0-4 - Mend

@fgv/ts-web-extras 5.1.0-3 → 5.1.0-4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (255) hide show

package/docs/classes/FileSystemAccessTreeAccessors.md CHANGED Viewed

@@ -1,557 +1,275 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > FileSystemAccessTreeAccessors
-***
-[@fgv/ts-web-extras](../README.md) / FileSystemAccessTreeAccessors
-# Class: FileSystemAccessTreeAccessors\<TCT\>
+# Class: FileSystemAccessTreeAccessors
 Implementation of `FileTree.IPersistentFileTreeAccessors` that uses the File System Access API
 to provide persistent file editing in browsers.
-## Extends
-- [`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
-## Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
-## Implements
-- [`IPersistentFileTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
-## Constructors
-### Constructor
+**Extends:** `InMemoryTreeAccessors<TCT>`
-> `protected` **new FileSystemAccessTreeAccessors**\<`TCT`\>(`files`, `rootDir`, `handles`, `params`, `hasWritePermission`): `FileSystemAccessTreeAccessors`\<`TCT`\>
-Protected constructor for FileSystemAccessTreeAccessors.
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `files` | [`IInMemoryFile`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[] | An array of in-memory files to include in the tree. |
-| `rootDir` | [`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) | The root directory handle. |
-| `handles` | `Map`\<`string`, [`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md)\> | Map of file paths to their handles. |
-| `params` | [`IFileSystemAccessTreeParams`](../interfaces/IFileSystemAccessTreeParams.md)\<`TCT`\> \| `undefined` | Optional params for the tree. |
-| `hasWritePermission` | `boolean` | Whether write permission was granted. |
-#### Returns
-`FileSystemAccessTreeAccessors`\<`TCT`\>
-#### Overrides
-`FileTree.InMemoryTreeAccessors<TCT>.constructor`
+**Implements:** `IPersistentFileTreeAccessors<TCT>`
 ## Methods
-### createDirectory()
-> **createDirectory**(`dirPath`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-FileTree.IMutableFileTreeAccessors.createDirectory
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `dirPath` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.createDirectory`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.createDirectory`
-***
-### deleteDirectory()
-> **deleteDirectory**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
-FileTree.IMutableFileTreeAccessors.deleteDirectory
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
+<table><thead><tr><th>
-#### Returns
+Method
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
+</th><th>
-#### Implementation of
+Modifiers
-`FileTree.IPersistentFileTreeAccessors.deleteDirectory`
+</th><th>
-#### Inherited from
+Description
-`FileTree.InMemoryTreeAccessors.deleteDirectory`
+</th></tr></thead>
+<tbody>
+<tr><td>
-***
+[fromDirectoryHandle(dirHandle, params)](./FileSystemAccessTreeAccessors.fromDirectoryHandle.md)
-### deleteFile()
+</td><td>
-> **deleteFile**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
+`static`
-FileTree.IMutableFileTreeAccessors.deleteFile
+</td><td>
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.deleteFile`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.deleteFile`
-***
-### fileIsMutable()
-> **fileIsMutable**(`path`): [`DetailedResult`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`, [`SaveDetail`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\>
-Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
+Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
-[`DetailedResult`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`, [`SaveDetail`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\>
+</td></tr>
+<tr><td>
-#### Implementation of
+[fromFileHandle(fileHandle, params)](./FileSystemAccessTreeAccessors.fromFileHandle.md)
-`FileTree.IPersistentFileTreeAccessors.fileIsMutable`
+</td><td>
-#### Overrides
+`static`
-`FileTree.InMemoryTreeAccessors.fileIsMutable`
+</td><td>
-***
+Creates a new FileSystemAccessTreeAccessors instance from a single file handle.
-### getBaseName()
+</td></tr>
+<tr><td>
-> **getBaseName**(`path`, `suffix?`): `string`
+[create(files, prefix)](./FileSystemAccessTreeAccessors.create.md)
-FileTree.IFileTreeAccessors.getBaseName
+</td><td>
-#### Parameters
+`static`
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-| `suffix?` | `string` |
+</td><td>
-#### Returns
+Creates a new FileTree.InMemoryTreeAccessors | InMemoryTreeAccessors instance with the supplied
-`string`
+</td></tr>
+<tr><td>
-#### Implementation of
+[syncToDisk()](./FileSystemAccessTreeAccessors.syncToDisk.md)
-`FileTree.IPersistentFileTreeAccessors.getBaseName`
+</td><td>
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getBaseName`
-***
+</td><td>
-### getChildren()
+Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
-> **getChildren**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<readonly [`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[]\>
+</td></tr>
+<tr><td>
-FileTree.IFileTreeAccessors.getChildren
+[isDirty()](./FileSystemAccessTreeAccessors.isDirty.md)
-#### Parameters
+</td><td>
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<readonly [`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[]\>
+</td><td>
-#### Implementation of
+Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
-`FileTree.IPersistentFileTreeAccessors.getChildren`
+</td></tr>
+<tr><td>
-#### Inherited from
+[getDirtyPaths()](./FileSystemAccessTreeAccessors.getDirtyPaths.md)
-`FileTree.InMemoryTreeAccessors.getChildren`
+</td><td>
-***
-### getDirtyPaths()
-> **getDirtyPaths**(): `string`[]
+</td><td>
 Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
-#### Returns
-`string`[]
+</td></tr>
+<tr><td>
-#### Implementation of
+[deleteFile(path)](./FileSystemAccessTreeAccessors.deleteFile.md)
-`FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
+</td><td>
-***
-### getExtension()
-> **getExtension**(`path`): `string`
-FileTree.IFileTreeAccessors.getExtension
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
+</td><td>
-#### Returns
+Override deleteFile to track pending deletions for syncToDisk.
-`string`
+</td></tr>
+<tr><td>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getExtension`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getExtension`
-***
-### getFileContents()
-> **getFileContents**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-FileTree.IFileTreeAccessors.getFileContents
+[saveFileContents(path, contents)](./FileSystemAccessTreeAccessors.saveFileContents.md)
-#### Parameters
+</td><td>
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+</td><td>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getFileContents`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getFileContents`
-***
-### getFileContentType()
-> **getFileContentType**(`path`, `provided?`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`TCT` \| `undefined`\>
-FileTree.IFileTreeAccessors.getFileContentType
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-| `provided?` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`TCT` \| `undefined`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getFileContentType`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getFileContentType`
-***
-### getItem()
-> **getItem**(`itemPath`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-FileTree.IFileTreeAccessors.getItem
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| `itemPath` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTreeItem`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getItem`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getItem`
-***
-### isDirty()
-> **isDirty**(): `boolean`
-Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
-#### Returns
-`boolean`
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.isDirty`
-***
-### joinPaths()
+Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
-> **joinPaths**(...`paths`): `string`
+</td></tr>
+<tr><td>
-FileTree.IFileTreeAccessors.joinPaths
+[fileIsMutable(path)](./FileSystemAccessTreeAccessors.fileIsMutable.md)
-#### Parameters
+</td><td>
-| Parameter | Type |
-| ------ | ------ |
-| ...`paths` | `string`[] |
-#### Returns
-`string`
+</td><td>
-#### Implementation of
+Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
-`FileTree.IPersistentFileTreeAccessors.joinPaths`
+</td></tr>
+<tr><td>
-#### Inherited from
+[resolveAbsolutePath(paths)](./FileSystemAccessTreeAccessors.resolveAbsolutePath.md)
-`FileTree.InMemoryTreeAccessors.joinPaths`
+</td><td>
-***
-### resolveAbsolutePath()
-> **resolveAbsolutePath**(...`paths`): `string`
+</td><td>
 FileTree.IFileTreeAccessors.resolveAbsolutePath
-#### Parameters
+</td></tr>
+<tr><td>
-| Parameter | Type |
-| ------ | ------ |
-| ...`paths` | `string`[] |
+[getExtension(path)](./FileSystemAccessTreeAccessors.getExtension.md)
-#### Returns
+</td><td>
-`string`
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.resolveAbsolutePath`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.resolveAbsolutePath`
-***
-### saveFileContents()
-> **saveFileContents**(`path`, `contents`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
-#### Parameters
+</td><td>
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-| `contents` | `string` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.saveFileContents`
+FileTree.IFileTreeAccessors.getExtension
-#### Overrides
+</td></tr>
+<tr><td>
-`FileTree.InMemoryTreeAccessors.saveFileContents`
+[getBaseName(path, suffix)](./FileSystemAccessTreeAccessors.getBaseName.md)
-***
+</td><td>
-### syncToDisk()
-> **syncToDisk**(): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
-Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
+</td><td>
-#### Returns
+FileTree.IFileTreeAccessors.getBaseName
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+</td></tr>
+<tr><td>
-#### Implementation of
+[joinPaths(paths)](./FileSystemAccessTreeAccessors.joinPaths.md)
-`FileTree.IPersistentFileTreeAccessors.syncToDisk`
+</td><td>
-***
-### create()
-#### Call Signature
+</td><td>
-> `static` **create**\<`TCT`\>(`files`, `prefix?`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
+FileTree.IFileTreeAccessors.joinPaths
-Creates a new [InMemoryTreeAccessors](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) instance with the supplied
-in-memory files.
+</td></tr>
+<tr><td>
-##### Type Parameters
+[getItem(itemPath)](./FileSystemAccessTreeAccessors.getItem.md)
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+</td><td>
-##### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `files` | [`IInMemoryFile`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[] | An array of [in-memory files](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) to include in the tree. |
-| `prefix?` | `string` | Optional prefix for the tree. |
-##### Returns
+</td><td>
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
+FileTree.IFileTreeAccessors.getItem
-##### Inherited from
+</td></tr>
+<tr><td>
-`FileTree.InMemoryTreeAccessors.create`
+[getFileContents(path)](./FileSystemAccessTreeAccessors.getFileContents.md)
-#### Call Signature
+</td><td>
-> `static` **create**\<`TCT`\>(`files`, `params?`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-Creates a new [InMemoryTreeAccessors](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) instance with the supplied
-in-memory files.
-##### Type Parameters
+</td><td>
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+FileTree.IFileTreeAccessors.getFileContents
-##### Parameters
+</td></tr>
+<tr><td>
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `files` | [`IInMemoryFile`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>[] | An array of [in-memory files](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) to include in the tree. |
-| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | Optional params for the tree. |
+[getFileContentType(path, provided)](./FileSystemAccessTreeAccessors.getFileContentType.md)
-##### Returns
+</td><td>
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`InMemoryTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>\>
-##### Inherited from
-`FileTree.InMemoryTreeAccessors.create`
+</td><td>
-***
+FileTree.IFileTreeAccessors.getFileContentType
-### fromDirectoryHandle()
+</td></tr>
+<tr><td>
-> `static` **fromDirectoryHandle**\<`TCT`\>(`dirHandle`, `params?`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`FileSystemAccessTreeAccessors`\<`TCT`\>\>\>
+[getChildren(path)](./FileSystemAccessTreeAccessors.getChildren.md)
-Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
+</td><td>
-#### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
-#### Parameters
+</td><td>
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `dirHandle` | [`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) | The FileSystemDirectoryHandle to load files from. |
-| `params?` | [`IFileSystemAccessTreeParams`](../interfaces/IFileSystemAccessTreeParams.md)\<`TCT`\> | Optional parameters including autoSync and permission settings. |
+FileTree.IFileTreeAccessors.getChildren
-#### Returns
+</td></tr>
+<tr><td>
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`FileSystemAccessTreeAccessors`\<`TCT`\>\>\>
+[createDirectory(dirPath)](./FileSystemAccessTreeAccessors.createDirectory.md)
-Promise resolving to a FileSystemAccessTreeAccessors instance.
+</td><td>
-***
-### fromFileHandle()
-> `static` **fromFileHandle**\<`TCT`\>(`fileHandle`, `params?`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`FileSystemAccessTreeAccessors`\<`TCT`\>\>\>
+</td><td>
-Creates a new FileSystemAccessTreeAccessors instance from a single file handle.
+FileTree.IMutableFileTreeAccessors.createDirectory
-The resulting tree contains exactly one file at `/<filename>`.
-`syncToDisk()` writes changes back to the original file via the File System Access API.
-New file creation is not supported on this tree (no parent directory handle).
+</td></tr>
+<tr><td>
-#### Type Parameters
+[deleteDirectory(path)](./FileSystemAccessTreeAccessors.deleteDirectory.md)
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+</td><td>
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileHandle` | [`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md) | The FileSystemFileHandle to load. |
-| `params?` | [`IFileSystemAccessTreeParams`](../interfaces/IFileSystemAccessTreeParams.md)\<`TCT`\> | Optional parameters including autoSync and permission settings. |
-#### Returns
+</td><td>
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`FileSystemAccessTreeAccessors`\<`TCT`\>\>\>
+FileTree.IMutableFileTreeAccessors.deleteDirectory
-Promise resolving to a FileSystemAccessTreeAccessors instance.
+</td></tr>
+</tbody></table>