@fgv/ts-web-extras 5.0.2 → 5.1.0-1

package/docs/classes/HttpTreeAccessors.md

@@ -0,0 +1,508 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / HttpTreeAccessors
+
+# Class: HttpTreeAccessors\<TCT\>
+
+HTTP-backed file tree accessors that cache data in memory and persist via REST API.
+
+## 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`\>
+
+## 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` |
+
+#### Returns
+
+[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.deleteDirectory`
+
+#### Inherited from
+
+`FileTree.InMemoryTreeAccessors.deleteDirectory`
+
+***
+
+### deleteFile()
+
+> **deleteFile**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
+
+FileTree.IMutableFileTreeAccessors.deleteFile
+
+#### 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)\>
+
+Checks if a file is mutable (can be modified).
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | The path to the file. |
+
+#### Returns
+
+[`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)\>
+
+A detailed result indicating if the file is mutable and the reason.
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.fileIsMutable`
+
+#### Overrides
+
+`FileTree.InMemoryTreeAccessors.fileIsMutable`
+
+***
+
+### getBaseName()
+
+> **getBaseName**(`path`, `suffix?`): `string`
+
+FileTree.IFileTreeAccessors.getBaseName
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+| `suffix?` | `string` |
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.getBaseName`
+
+#### Inherited from
+
+`FileTree.InMemoryTreeAccessors.getBaseName`
+
+***
+
+### getChildren()
+
+> **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`\>[]\>
+
+FileTree.IFileTreeAccessors.getChildren
+
+#### Parameters
+
+| 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`\>[]\>
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.getChildren`
+
+#### Inherited from
+
+`FileTree.InMemoryTreeAccessors.getChildren`
+
+***
+
+### getDirtyPaths()
+
+> **getDirtyPaths**(): `string`[]
+
+Gets the list of paths for all dirty files.
+
+#### Returns
+
+`string`[]
+
+An array of file paths that have been modified but not yet synchronized.
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
+
+***
+
+### getExtension()
+
+> **getExtension**(`path`): `string`
+
+FileTree.IFileTreeAccessors.getExtension
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+
+#### Returns
+
+`string`
+
+#### 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
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `path` | `string` |
+
+#### Returns
+
+[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+
+#### 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`
+
+Checks if there are any dirty files that need synchronization.
+
+#### Returns
+
+`boolean`
+
+True if there are dirty files, false otherwise.
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.isDirty`
+
+***
+
+### joinPaths()
+
+> **joinPaths**(...`paths`): `string`
+
+FileTree.IFileTreeAccessors.joinPaths
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`paths` | `string`[] |
+
+#### Returns
+
+`string`
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.joinPaths`
+
+#### Inherited from
+
+`FileTree.InMemoryTreeAccessors.joinPaths`
+
+***
+
+### resolveAbsolutePath()
+
+> **resolveAbsolutePath**(...`paths`): `string`
+
+FileTree.IFileTreeAccessors.resolveAbsolutePath
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| ...`paths` | `string`[] |
+
+#### Returns
+
+`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`\>
+
+Saves file contents and marks the file as dirty for synchronization.
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `path` | `string` | The path to the file. |
+| `contents` | `string` | The new contents of the file. |
+
+#### Returns
+
+[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+
+A result indicating success or failure.
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.saveFileContents`
+
+#### Overrides
+
+`FileTree.InMemoryTreeAccessors.saveFileContents`
+
+***
+
+### syncToDisk()
+
+> **syncToDisk**(): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+
+Synchronizes all dirty files to the HTTP backend.
+
+#### Returns
+
+`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+
+A promise that resolves to a result indicating success or failure.
+
+#### Implementation of
+
+`FileTree.IPersistentFileTreeAccessors.syncToDisk`
+
+***
+
+### create()
+
+#### Call Signature
+
+> `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`\>\>
+
+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
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TCT` *extends* `string` | `string` |
+
+##### 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
+
+[`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`
+
+#### Call Signature
+
+> `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
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TCT` *extends* `string` | `string` |
+
+##### 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. |
+| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | Optional params for the tree. |
+
+##### Returns
+
+[`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`
+
+***
+
+### fromHttp()
+
+> `static` **fromHttp**\<`TCT`\>(`params`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`HttpTreeAccessors`\<`TCT`\>\>\>
+
+Creates a new HttpTreeAccessors instance from an HTTP backend.
+
+#### Type Parameters
+
+| Type Parameter | Default type |
+| ------ | ------ |
+| `TCT` *extends* `string` | `string` |
+
+#### Parameters
+
+| Parameter | Type | Description |
+| ------ | ------ | ------ |
+| `params` | [`IHttpTreeParams`](../interfaces/IHttpTreeParams.md)\<`TCT`\> | Configuration parameters for the HTTP tree accessors. |
+
+#### Returns
+
+`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`HttpTreeAccessors`\<`TCT`\>\>\>
+
+A promise that resolves to a result containing the new HttpTreeAccessors instance or an error message.