@fgv/ts-web-extras 5.1.0-19 → 5.1.0-20

package/docs/classes/FileSystemAccessTreeAccessors.getDirtyPaths.md

@@ -1,15 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > getDirtyPaths
-
-## FileSystemAccessTreeAccessors.getDirtyPaths() method
-
-Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
-
-**Signature:**
-
-```typescript
-getDirtyPaths(): string[];
-```
-
-**Returns:**
-
-string[]

package/docs/classes/FileSystemAccessTreeAccessors.isDirty.md

@@ -1,15 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > isDirty
-
-## FileSystemAccessTreeAccessors.isDirty() method
-
-Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
-
-**Signature:**
-
-```typescript
-isDirty(): boolean;
-```
-
-**Returns:**
-
-boolean

package/docs/classes/FileSystemAccessTreeAccessors.md

@@ -1,275 +0,0 @@
-[Home](../README.md) > FileSystemAccessTreeAccessors
-
-# Class: FileSystemAccessTreeAccessors
-
-Implementation of `FileTree.IPersistentFileTreeAccessors` that uses the File System Access API
-to provide persistent file editing in browsers.
-
-**Extends:** `InMemoryTreeAccessors<TCT>`
-
-**Implements:** `IPersistentFileTreeAccessors<TCT>`
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[fromDirectoryHandle(dirHandle, params)](./FileSystemAccessTreeAccessors.fromDirectoryHandle.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
-
-</td></tr>
-<tr><td>
-
-[fromFileHandle(fileHandle, params)](./FileSystemAccessTreeAccessors.fromFileHandle.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Creates a new FileSystemAccessTreeAccessors instance from a single file handle.
-
-</td></tr>
-<tr><td>
-
-[create(files, prefix)](./FileSystemAccessTreeAccessors.create.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Creates a new FileTree.InMemoryTreeAccessors | InMemoryTreeAccessors instance with the supplied
-
-</td></tr>
-<tr><td>
-
-[syncToDisk()](./FileSystemAccessTreeAccessors.syncToDisk.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
-
-</td></tr>
-<tr><td>
-
-[isDirty()](./FileSystemAccessTreeAccessors.isDirty.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
-
-</td></tr>
-<tr><td>
-
-[getDirtyPaths()](./FileSystemAccessTreeAccessors.getDirtyPaths.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
-
-</td></tr>
-<tr><td>
-
-[deleteFile(path)](./FileSystemAccessTreeAccessors.deleteFile.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Override deleteFile to track pending deletions for syncToDisk.
-
-</td></tr>
-<tr><td>
-
-[saveFileContents(path, contents)](./FileSystemAccessTreeAccessors.saveFileContents.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
-
-</td></tr>
-<tr><td>
-
-[fileIsMutable(path)](./FileSystemAccessTreeAccessors.fileIsMutable.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
-
-</td></tr>
-<tr><td>
-
-[resolveAbsolutePath(paths)](./FileSystemAccessTreeAccessors.resolveAbsolutePath.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Resolves paths to an absolute path.
-
-</td></tr>
-<tr><td>
-
-[getExtension(path)](./FileSystemAccessTreeAccessors.getExtension.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the extension of a path.
-
-</td></tr>
-<tr><td>
-
-[getBaseName(path, suffix)](./FileSystemAccessTreeAccessors.getBaseName.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the base name of a path.
-
-</td></tr>
-<tr><td>
-
-[joinPaths(paths)](./FileSystemAccessTreeAccessors.joinPaths.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Joins paths together.
-
-</td></tr>
-<tr><td>
-
-[getItem(itemPath)](./FileSystemAccessTreeAccessors.getItem.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets an item from the file tree.
-
-</td></tr>
-<tr><td>
-
-[getFileContents(path)](./FileSystemAccessTreeAccessors.getFileContents.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the contents of a file in the file tree.
-
-</td></tr>
-<tr><td>
-
-[getFileContentType(path, provided)](./FileSystemAccessTreeAccessors.getFileContentType.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the content type of a file in the file tree.
-
-</td></tr>
-<tr><td>
-
-[getChildren(path)](./FileSystemAccessTreeAccessors.getChildren.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the children of a directory in the file tree.
-
-</td></tr>
-<tr><td>
-
-[createDirectory(dirPath)](./FileSystemAccessTreeAccessors.createDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Creates a directory at the given path, including any missing parent directories.
-
-</td></tr>
-<tr><td>
-
-[deleteDirectory(path)](./FileSystemAccessTreeAccessors.deleteDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Deletes a directory at the given path.
-
-</td></tr>
-</tbody></table>

package/docs/classes/FileSystemAccessTreeAccessors.saveFileContents.md

@@ -1,23 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > saveFileContents
-
-## FileSystemAccessTreeAccessors.saveFileContents() method
-
-Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
-
-**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></td></tr>
-<tr><td>contents</td><td>string</td><td></td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;string&gt;

package/docs/classes/FileSystemAccessTreeAccessors.syncToDisk.md

@@ -1,15 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > syncToDisk
-
-## FileSystemAccessTreeAccessors.syncToDisk() method
-
-Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
-
-**Signature:**
-
-```typescript
-syncToDisk(): Promise<Result<void>>;
-```
-
-**Returns:**
-
-Promise&lt;Result&lt;void&gt;&gt;

package/docs/classes/HttpTreeAccessors.deleteFile.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > deleteFile
-
-## HttpTreeAccessors.deleteFile() method
-
-Deletes a file at the given path.
-
-**Signature:**
-
-```typescript
-deleteFile(path: string): Result<boolean>;
-```
-
-**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 of the file to delete.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;boolean&gt;
-
-`Success` with `true` if the file was deleted, or `Failure` with an error message.

package/docs/classes/HttpTreeAccessors.fileIsMutable.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > fileIsMutable
-
-## HttpTreeAccessors.fileIsMutable() method
-
-Checks if a file is mutable (can be modified).
-
-**Signature:**
-
-```typescript
-fileIsMutable(path: string): DetailedResult<boolean, SaveDetail>;
-```
-
-**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>
-</tbody></table>
-
-**Returns:**
-
-DetailedResult&lt;boolean, SaveDetail&gt;
-
-A detailed result indicating if the file is mutable and the reason.

package/docs/classes/HttpTreeAccessors.fromHttp.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > fromHttp
-
-## HttpTreeAccessors.fromHttp() method
-
-Creates a new HttpTreeAccessors instance from an HTTP backend.
-
-**Signature:**
-
-```typescript
-static fromHttp(params: IHttpTreeParams<TCT>): Promise<Result<HttpTreeAccessors<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>params</td><td>IHttpTreeParams&lt;TCT&gt;</td><td>Configuration parameters for the HTTP tree accessors.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[HttpTreeAccessors](HttpTreeAccessors.md)&lt;TCT&gt;&gt;&gt;
-
-A promise that resolves to a result containing the new HttpTreeAccessors instance or an error message.

package/docs/classes/HttpTreeAccessors.getDirtyPaths.md

@@ -1,17 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > getDirtyPaths
-
-## HttpTreeAccessors.getDirtyPaths() method
-
-Gets the list of paths for all dirty files.
-
-**Signature:**
-
-```typescript
-getDirtyPaths(): string[];
-```
-
-**Returns:**
-
-string[]
-
-An array of file paths that have been modified but not yet synchronized.

package/docs/classes/HttpTreeAccessors.isDirty.md

@@ -1,17 +0,0 @@
-[Home](../README.md) > [HttpTreeAccessors](./HttpTreeAccessors.md) > isDirty
-
-## HttpTreeAccessors.isDirty() method
-
-Checks if there are any dirty files that need synchronization.
-
-**Signature:**
-
-```typescript
-isDirty(): boolean;
-```
-
-**Returns:**
-
-boolean
-
-True if there are dirty files, false otherwise.

package/docs/classes/HttpTreeAccessors.md

@@ -1,261 +0,0 @@
-[Home](../README.md) > HttpTreeAccessors
-
-# Class: HttpTreeAccessors
-
-HTTP-backed file tree accessors that cache data in memory and persist via REST API.
-
-**Extends:** `InMemoryTreeAccessors<TCT>`
-
-**Implements:** `IPersistentFileTreeAccessors<TCT>`
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[fromHttp(params)](./HttpTreeAccessors.fromHttp.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Creates a new HttpTreeAccessors instance from an HTTP backend.
-
-</td></tr>
-<tr><td>
-
-[create(files, prefix)](./HttpTreeAccessors.create.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Creates a new FileTree.InMemoryTreeAccessors | InMemoryTreeAccessors instance with the supplied
-
-</td></tr>
-<tr><td>
-
-[syncToDisk()](./HttpTreeAccessors.syncToDisk.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Synchronizes all dirty files to the HTTP backend.
-
-</td></tr>
-<tr><td>
-
-[isDirty()](./HttpTreeAccessors.isDirty.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Checks if there are any dirty files that need synchronization.
-
-</td></tr>
-<tr><td>
-
-[getDirtyPaths()](./HttpTreeAccessors.getDirtyPaths.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the list of paths for all dirty files.
-
-</td></tr>
-<tr><td>
-
-[deleteFile(path)](./HttpTreeAccessors.deleteFile.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Deletes a file at the given path.
-
-</td></tr>
-<tr><td>
-
-[saveFileContents(path, contents)](./HttpTreeAccessors.saveFileContents.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Saves file contents and marks the file as dirty for synchronization.
-
-</td></tr>
-<tr><td>
-
-[fileIsMutable(path)](./HttpTreeAccessors.fileIsMutable.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Checks if a file is mutable (can be modified).
-
-</td></tr>
-<tr><td>
-
-[resolveAbsolutePath(paths)](./HttpTreeAccessors.resolveAbsolutePath.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Resolves paths to an absolute path.
-
-</td></tr>
-<tr><td>
-
-[getExtension(path)](./HttpTreeAccessors.getExtension.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the extension of a path.
-
-</td></tr>
-<tr><td>
-
-[getBaseName(path, suffix)](./HttpTreeAccessors.getBaseName.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the base name of a path.
-
-</td></tr>
-<tr><td>
-
-[joinPaths(paths)](./HttpTreeAccessors.joinPaths.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Joins paths together.
-
-</td></tr>
-<tr><td>
-
-[getItem(itemPath)](./HttpTreeAccessors.getItem.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets an item from the file tree.
-
-</td></tr>
-<tr><td>
-
-[getFileContents(path)](./HttpTreeAccessors.getFileContents.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the contents of a file in the file tree.
-
-</td></tr>
-<tr><td>
-
-[getFileContentType(path, provided)](./HttpTreeAccessors.getFileContentType.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the content type of a file in the file tree.
-
-</td></tr>
-<tr><td>
-
-[getChildren(path)](./HttpTreeAccessors.getChildren.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Gets the children of a directory in the file tree.
-
-</td></tr>
-<tr><td>
-
-[createDirectory(dirPath)](./HttpTreeAccessors.createDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Creates a directory at the given path, including any missing parent directories.
-
-</td></tr>
-<tr><td>
-
-[deleteDirectory(path)](./HttpTreeAccessors.deleteDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Deletes a directory at the given path.
-
-</td></tr>
-</tbody></table>