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

package/docs/classes/DirectoryHandleStore.md

@@ -1,120 +0,0 @@
-[Home](../README.md) > DirectoryHandleStore
-
-# Class: DirectoryHandleStore
-
-Manages persistence of FileSystemDirectoryHandle objects in IndexedDB.
-Keyed by a label (typically the directory name).
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-`constructor(dbName, storeName)`
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[save(label, handle)](./DirectoryHandleStore.save.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Saves a directory handle to IndexedDB under the given label.
-
-</td></tr>
-<tr><td>
-
-[load(label)](./DirectoryHandleStore.load.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Retrieves a directory handle by label.
-
-</td></tr>
-<tr><td>
-
-[remove(label)](./DirectoryHandleStore.remove.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Removes a directory handle from IndexedDB.
-
-</td></tr>
-<tr><td>
-
-[getAllLabels()](./DirectoryHandleStore.getAllLabels.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Returns all stored labels (keys).
-
-</td></tr>
-<tr><td>
-
-[getAll()](./DirectoryHandleStore.getAll.md)
-
-</td><td>
-
-
-
-</td><td>
-
-Returns all stored handles as label/handle pairs.
-
-</td></tr>
-</tbody></table>

package/docs/classes/DirectoryHandleStore.remove.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > remove
-
-## DirectoryHandleStore.remove() method
-
-Removes a directory handle from IndexedDB.
-
-**Signature:**
-
-```typescript
-remove(label: string): Promise<Result<void>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>label</td><td>string</td><td>Key to remove</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;void&gt;&gt;
-
-Success or Failure

package/docs/classes/DirectoryHandleStore.save.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [DirectoryHandleStore](./DirectoryHandleStore.md) > save
-
-## DirectoryHandleStore.save() method
-
-Saves a directory handle to IndexedDB under the given label.
-
-**Signature:**
-
-```typescript
-save(label: string, handle: FileSystemDirectoryHandle): Promise<Result<void>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>label</td><td>string</td><td>Key to store the handle under (typically dirHandle.name)</td></tr>
-<tr><td>handle</td><td>FileSystemDirectoryHandle</td><td>The FileSystemDirectoryHandle to persist</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;void&gt;&gt;
-
-Success or Failure

package/docs/classes/FileApiTreeAccessors.create.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > create
-
-## FileApiTreeAccessors.create() method
-
-Create FileTree from various file sources using TreeInitializer array.
-
-**Signature:**
-
-```typescript
-static create(initializers: TreeInitializer[], params?: IFileTreeInitParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>initializers</td><td>TreeInitializer[]</td><td>Array of TreeInitializer objects specifying file sources</td></tr>
-<tr><td>params</td><td>IFileTreeInitParams&lt;TCT&gt;</td><td>Optional `IFileTreeInitParams` for the file tree.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with all content pre-loaded

package/docs/classes/FileApiTreeAccessors.createFromHttp.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > createFromHttp
-
-## FileApiTreeAccessors.createFromHttp() method
-
-Create a persistent FileTree from an HTTP storage service.
-
-**Signature:**
-
-```typescript
-static createFromHttp(params: IHttpTreeParams<TCT>): Promise<Result<FileTree_2<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 including API base URL, namespace, and optional autoSync</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with persistence capability

package/docs/classes/FileApiTreeAccessors.createFromLocalStorage.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > createFromLocalStorage
-
-## FileApiTreeAccessors.createFromLocalStorage() method
-
-Create a persistent FileTree from browser localStorage.
-Changes to files can be synced back to localStorage.
-
-**Signature:**
-
-```typescript
-static createFromLocalStorage(params: ILocalStorageTreeParams<TCT>): Result<FileTree_2<TCT>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>params</td><td>ILocalStorageTreeParams&lt;TCT&gt;</td><td>Configuration including path-to-key mappings and optional autoSync</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;FileTree_2&lt;TCT&gt;&gt;
-
-Result containing a FileTree with persistence capability

package/docs/classes/FileApiTreeAccessors.createPersistent.md

@@ -1,26 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > createPersistent
-
-## FileApiTreeAccessors.createPersistent() method
-
-Create a persistent FileTree from a File System Access API directory handle.
-Changes to files can be synced back to disk.
-
-**Signature:**
-
-```typescript
-static createPersistent(dirHandle: FileSystemDirectoryHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>dirHandle</td><td>FileSystemDirectoryHandle</td><td>FileSystemDirectoryHandle to load files from</td></tr>
-<tr><td>params</td><td>IFileSystemAccessTreeParams&lt;TCT&gt;</td><td>Optional parameters including autoSync and permission settings</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with persistence capability

package/docs/classes/FileApiTreeAccessors.createPersistentFromFile.md

@@ -1,27 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > createPersistentFromFile
-
-## FileApiTreeAccessors.createPersistentFromFile() method
-
-Create a persistent FileTree from a single File System Access API file handle.
-The tree contains exactly one file at `/<filename>`.
-Changes can be synced back to the original file via `syncToDisk()`.
-
-**Signature:**
-
-```typescript
-static createPersistentFromFile(fileHandle: FileSystemFileHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>fileHandle</td><td>FileSystemFileHandle</td><td>FileSystemFileHandle to load</td></tr>
-<tr><td>params</td><td>IFileSystemAccessTreeParams&lt;TCT&gt;</td><td>Optional parameters including autoSync and permission settings</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with persistence capability

package/docs/classes/FileApiTreeAccessors.extractFileMetadata.md

@@ -1,24 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > extractFileMetadata
-
-## FileApiTreeAccessors.extractFileMetadata() method
-
-Extract file metadata from a File.
-
-**Signature:**
-
-```typescript
-static extractFileMetadata(file: File): IFileMetadata;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>file</td><td>File</td><td>The File to extract metadata from</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[IFileMetadata](../interfaces/IFileMetadata.md)
-
-The IFileMetadata | file metadata

package/docs/classes/FileApiTreeAccessors.fromDirectoryUpload.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > fromDirectoryUpload
-
-## FileApiTreeAccessors.fromDirectoryUpload() method
-
-Create FileTree from directory upload with webkitRelativePath.
-
-**Signature:**
-
-```typescript
-static fromDirectoryUpload(fileList: FileList, params?: IFileTreeInitParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>fileList</td><td>FileList</td><td>FileList from a directory upload (input with webkitdirectory)</td></tr>
-<tr><td>params</td><td>IFileTreeInitParams&lt;TCT&gt;</td><td>Optional `IFileTreeInitParams` for the file tree.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with all content pre-loaded

package/docs/classes/FileApiTreeAccessors.fromFileList.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > fromFileList
-
-## FileApiTreeAccessors.fromFileList() method
-
-Create FileTree from FileList (e.g., from input[type="file"]).
-
-**Signature:**
-
-```typescript
-static fromFileList(fileList: FileList, params?: IFileTreeInitParams<TCT>): Promise<Result<FileTree_2<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>fileList</td><td>FileList</td><td>FileList from a file input element</td></tr>
-<tr><td>params</td><td>IFileTreeInitParams&lt;TCT&gt;</td><td>Optional `IFileTreeInitParams` for the file tree.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree_2&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with all content pre-loaded

package/docs/classes/FileApiTreeAccessors.getOriginalFile.md

@@ -1,27 +0,0 @@
-[Home](../README.md) > [FileApiTreeAccessors](./FileApiTreeAccessors.md) > getOriginalFile
-
-## FileApiTreeAccessors.getOriginalFile() method
-
-Get the File object for a specific path from the original FileList.
-This is useful for accessing the original File API object for operations
-like getting file metadata, MIME type, etc.
-
-**Signature:**
-
-```typescript
-static getOriginalFile(fileList: FileList, targetPath: string): Result<File>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>fileList</td><td>FileList</td><td>The original FileList</td></tr>
-<tr><td>targetPath</td><td>string</td><td>The path to find</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;File&gt;
-
-Result containing the File object if found

package/docs/classes/FileApiTreeAccessors.md

@@ -1,172 +0,0 @@
-[Home](../README.md) > FileApiTreeAccessors
-
-# Class: FileApiTreeAccessors
-
-Helper class to create FileTree instances from various file sources.
-Supports File API (FileList) and File System Access API handles.
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-`constructor()`
-
-</td><td>
-
-
-
-</td><td>
-
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-</th><th>
-
-Modifiers
-
-</th><th>
-
-Description
-
-</th></tr></thead>
-<tbody>
-<tr><td>
-
-[createPersistent(dirHandle, params)](./FileApiTreeAccessors.createPersistent.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create a persistent FileTree from a File System Access API directory handle.
-
-</td></tr>
-<tr><td>
-
-[createFromHttp(params)](./FileApiTreeAccessors.createFromHttp.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create a persistent FileTree from an HTTP storage service.
-
-</td></tr>
-<tr><td>
-
-[createPersistentFromFile(fileHandle, params)](./FileApiTreeAccessors.createPersistentFromFile.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create a persistent FileTree from a single File System Access API file handle.
-
-</td></tr>
-<tr><td>
-
-[createFromLocalStorage(params)](./FileApiTreeAccessors.createFromLocalStorage.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create a persistent FileTree from browser localStorage.
-
-</td></tr>
-<tr><td>
-
-[create(initializers, params)](./FileApiTreeAccessors.create.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create FileTree from various file sources using TreeInitializer array.
-
-</td></tr>
-<tr><td>
-
-[fromFileList(fileList, params)](./FileApiTreeAccessors.fromFileList.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create FileTree from FileList (e.g., from input[type="file"]).
-
-</td></tr>
-<tr><td>
-
-[fromDirectoryUpload(fileList, params)](./FileApiTreeAccessors.fromDirectoryUpload.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Create FileTree from directory upload with webkitRelativePath.
-
-</td></tr>
-<tr><td>
-
-[getOriginalFile(fileList, targetPath)](./FileApiTreeAccessors.getOriginalFile.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Get the File object for a specific path from the original FileList.
-
-</td></tr>
-<tr><td>
-
-[extractFileMetadata(file)](./FileApiTreeAccessors.extractFileMetadata.md)
-
-</td><td>
-
-`static`
-
-</td><td>
-
-Extract file metadata from a File.
-
-</td></tr>
-</tbody></table>

package/docs/classes/FileSystemAccessTreeAccessors.deleteFile.md

@@ -1,22 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > deleteFile
-
-## FileSystemAccessTreeAccessors.deleteFile() method
-
-Override deleteFile to track pending deletions for syncToDisk.
-
-**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></td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;boolean&gt;

package/docs/classes/FileSystemAccessTreeAccessors.fileIsMutable.md

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

package/docs/classes/FileSystemAccessTreeAccessors.fromDirectoryHandle.md

@@ -1,25 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > fromDirectoryHandle
-
-## FileSystemAccessTreeAccessors.fromDirectoryHandle() method
-
-Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
-
-**Signature:**
-
-```typescript
-static fromDirectoryHandle(dirHandle: FileSystemDirectoryHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileSystemAccessTreeAccessors<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>dirHandle</td><td>FileSystemDirectoryHandle</td><td>The FileSystemDirectoryHandle to load files from.</td></tr>
-<tr><td>params</td><td>IFileSystemAccessTreeParams&lt;TCT&gt;</td><td>Optional parameters including autoSync and permission settings.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[FileSystemAccessTreeAccessors](FileSystemAccessTreeAccessors.md)&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileSystemAccessTreeAccessors instance.

package/docs/classes/FileSystemAccessTreeAccessors.fromFileHandle.md

@@ -1,29 +0,0 @@
-[Home](../README.md) > [FileSystemAccessTreeAccessors](./FileSystemAccessTreeAccessors.md) > fromFileHandle
-
-## FileSystemAccessTreeAccessors.fromFileHandle() method
-
-Creates a new FileSystemAccessTreeAccessors instance from a single file handle.
-
-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).
-
-**Signature:**
-
-```typescript
-static fromFileHandle(fileHandle: FileSystemFileHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileSystemAccessTreeAccessors<TCT>>>;
-```
-
-**Parameters:**
-
-<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
-<tbody>
-<tr><td>fileHandle</td><td>FileSystemFileHandle</td><td>The FileSystemFileHandle to load.</td></tr>
-<tr><td>params</td><td>IFileSystemAccessTreeParams&lt;TCT&gt;</td><td>Optional parameters including autoSync and permission settings.</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[FileSystemAccessTreeAccessors](FileSystemAccessTreeAccessors.md)&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileSystemAccessTreeAccessors instance.