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

@fgv/ts-web-extras 5.1.0-2 → 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 (272) hide show

package/docs/classes/HttpTreeAccessors.md CHANGED Viewed

@@ -1,508 +1,261 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > HttpTreeAccessors
-***
-[@fgv/ts-web-extras](../README.md) / HttpTreeAccessors
-# Class: HttpTreeAccessors\<TCT\>
+# Class: HttpTreeAccessors
 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
+**Extends:** `InMemoryTreeAccessors<TCT>`
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
-## Implements
-- [`IPersistentFileTreeAccessors`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
+**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` |
-#### Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.deleteDirectory`
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.deleteDirectory`
-***
+<table><thead><tr><th>
-### deleteFile()
+Method
-> **deleteFile**(`path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`boolean`\>
+</th><th>
-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. |
+Modifiers
-#### Returns
+</th><th>
-[`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)\>
+Description
-A detailed result indicating if the file is mutable and the reason.
+</th></tr></thead>
+<tbody>
+<tr><td>
-#### Implementation of
+[fromHttp(params)](./HttpTreeAccessors.fromHttp.md)
-`FileTree.IPersistentFileTreeAccessors.fileIsMutable`
+</td><td>
-#### Overrides
+`static`
-`FileTree.InMemoryTreeAccessors.fileIsMutable`
+</td><td>
-***
+Creates a new HttpTreeAccessors instance from an HTTP backend.
-### getBaseName()
+</td></tr>
+<tr><td>
-> **getBaseName**(`path`, `suffix?`): `string`
+[create(files, prefix)](./HttpTreeAccessors.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()](./HttpTreeAccessors.syncToDisk.md)
-`FileTree.IPersistentFileTreeAccessors.getBaseName`
+</td><td>
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.getBaseName`
-***
+</td><td>
-### getChildren()
+Synchronizes all dirty files to the HTTP backend.
-> **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()](./HttpTreeAccessors.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
+Checks if there are any dirty files that need synchronization.
-`FileTree.IPersistentFileTreeAccessors.getChildren`
+</td></tr>
+<tr><td>
-#### Inherited from
+[getDirtyPaths()](./HttpTreeAccessors.getDirtyPaths.md)
-`FileTree.InMemoryTreeAccessors.getChildren`
+</td><td>
-***
-### getDirtyPaths()
-> **getDirtyPaths**(): `string`[]
+</td><td>
 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
+</td></tr>
+<tr><td>
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
+[deleteFile(path)](./HttpTreeAccessors.deleteFile.md)
-#### Returns
+</td><td>
-`string`
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.getExtension`
+</td><td>
-#### 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`
+FileTree.IMutableFileTreeAccessors.deleteFile
-Checks if there are any dirty files that need synchronization.
+</td></tr>
+<tr><td>
-#### Returns
+[saveFileContents(path, contents)](./HttpTreeAccessors.saveFileContents.md)
-`boolean`
+</td><td>
-True if there are dirty files, false otherwise.
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.isDirty`
+</td><td>
-***
+Saves file contents and marks the file as dirty for synchronization.
-### joinPaths()
+</td></tr>
+<tr><td>
-> **joinPaths**(...`paths`): `string`
+[fileIsMutable(path)](./HttpTreeAccessors.fileIsMutable.md)
-FileTree.IFileTreeAccessors.joinPaths
+</td><td>
-#### Parameters
-| Parameter | Type |
-| ------ | ------ |
-| ...`paths` | `string`[] |
-#### Returns
+</td><td>
-`string`
-#### Implementation of
+Checks if a file is mutable (can be modified).
-`FileTree.IPersistentFileTreeAccessors.joinPaths`
+</td></tr>
+<tr><td>
-#### Inherited from
+[resolveAbsolutePath(paths)](./HttpTreeAccessors.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)](./HttpTreeAccessors.getExtension.md)
-#### Returns
+</td><td>
-`string`
-#### Implementation of
-`FileTree.IPersistentFileTreeAccessors.resolveAbsolutePath`
+</td><td>
-#### Inherited from
-`FileTree.InMemoryTreeAccessors.resolveAbsolutePath`
+FileTree.IFileTreeAccessors.getExtension
-***
+</td></tr>
+<tr><td>
-### saveFileContents()
+[getBaseName(path, suffix)](./HttpTreeAccessors.getBaseName.md)
-> **saveFileContents**(`path`, `contents`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+</td><td>
-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. |
+</td><td>
-#### Returns
+FileTree.IFileTreeAccessors.getBaseName
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`string`\>
+</td></tr>
+<tr><td>
-A result indicating success or failure.
+[joinPaths(paths)](./HttpTreeAccessors.joinPaths.md)
-#### Implementation of
+</td><td>
-`FileTree.IPersistentFileTreeAccessors.saveFileContents`
-#### Overrides
-`FileTree.InMemoryTreeAccessors.saveFileContents`
+</td><td>
-***
+FileTree.IFileTreeAccessors.joinPaths
-### syncToDisk()
+</td></tr>
+<tr><td>
-> **syncToDisk**(): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`void`\>\>
+[getItem(itemPath)](./HttpTreeAccessors.getItem.md)
-Synchronizes all dirty files to the HTTP backend.
+</td><td>
-#### 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.
+</td><td>
-#### Implementation of
+FileTree.IFileTreeAccessors.getItem
-`FileTree.IPersistentFileTreeAccessors.syncToDisk`
+</td></tr>
+<tr><td>
-***
+[getFileContents(path)](./HttpTreeAccessors.getFileContents.md)
-### create()
+</td><td>
-#### 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.
+</td><td>
-##### Type Parameters
+FileTree.IFileTreeAccessors.getFileContents
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+</td></tr>
+<tr><td>
-##### Parameters
+[getFileContentType(path, provided)](./HttpTreeAccessors.getFileContentType.md)
-| 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. |
+</td><td>
-##### 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
+</td><td>
-`FileTree.InMemoryTreeAccessors.create`
+FileTree.IFileTreeAccessors.getFileContentType
-#### Call Signature
+</td></tr>
+<tr><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`\>\>
+[getChildren(path)](./HttpTreeAccessors.getChildren.md)
-Creates a new [InMemoryTreeAccessors](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) instance with the supplied
-in-memory files.
+</td><td>
-##### Type Parameters
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
-##### Parameters
+</td><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. |
+FileTree.IFileTreeAccessors.getChildren
-##### Returns
+</td></tr>
+<tr><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`\>\>
+[createDirectory(dirPath)](./HttpTreeAccessors.createDirectory.md)
-##### Inherited from
+</td><td>
-`FileTree.InMemoryTreeAccessors.create`
-***
-### fromHttp()
+</td><td>
-> `static` **fromHttp**\<`TCT`\>(`params`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`HttpTreeAccessors`\<`TCT`\>\>\>
+FileTree.IMutableFileTreeAccessors.createDirectory
-Creates a new HttpTreeAccessors instance from an HTTP backend.
+</td></tr>
+<tr><td>
-#### Type Parameters
+[deleteDirectory(path)](./HttpTreeAccessors.deleteDirectory.md)
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+</td><td>
-#### Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `params` | [`IHttpTreeParams`](../interfaces/IHttpTreeParams.md)\<`TCT`\> | Configuration parameters for the HTTP tree accessors. |
-#### Returns
+</td><td>
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`HttpTreeAccessors`\<`TCT`\>\>\>
+FileTree.IMutableFileTreeAccessors.deleteDirectory
-A promise that resolves to a result containing the new HttpTreeAccessors instance or an error message.
+</td></tr>
+</tbody></table>

package/docs/classes/HttpTreeAccessors.saveFileContents.md ADDED Viewed

@@ -0,0 +1,25 @@
+[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > saveFileContents
+## HttpTreeAccessors.saveFileContents() method
+Saves file contents and marks the file as dirty for synchronization.
+**Signature:**
+```typescript
+saveFileContents(path: string, contents: string): Result<string>;
+```
+**Parameters:**
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>path</td><td>string</td><td>The path to the file.</td></tr>
+<tr><td>contents</td><td>string</td><td>The new contents of the file.</td></tr>
+</tbody></table>
+**Returns:**
+Result&lt;string&gt;
+A result indicating success or failure.

package/docs/classes/HttpTreeAccessors.syncToDisk.md ADDED Viewed

@@ -0,0 +1,22 @@
+[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > syncToDisk
+## HttpTreeAccessors.syncToDisk() method
+Synchronizes all dirty files to the HTTP backend.
+Uses a concurrency guard: if a sync is already in progress, callers
+await the existing operation rather than starting a parallel one.
+This prevents the thundering herd that occurs when autoSync fires
+for every file written during a bulk operation (e.g. restore).
+**Signature:**
+```typescript
+syncToDisk(): Promise<Result<void>>;
+```
+**Returns:**
+Promise&lt;Result&lt;void&gt;&gt;
+A promise that resolves to a result indicating success or failure.