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

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></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.

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>
-
-FileTree.IFileTreeAccessors.resolveAbsolutePath
-
-</td></tr>
-<tr><td>
-
-[getExtension(path)](./FileSystemAccessTreeAccessors.getExtension.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.getExtension
-
-</td></tr>
-<tr><td>
-
-[getBaseName(path, suffix)](./FileSystemAccessTreeAccessors.getBaseName.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.getBaseName
-
-</td></tr>
-<tr><td>
-
-[joinPaths(paths)](./FileSystemAccessTreeAccessors.joinPaths.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.joinPaths
-
-</td></tr>
-<tr><td>
-
-[getItem(itemPath)](./FileSystemAccessTreeAccessors.getItem.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.getItem
-
-</td></tr>
-<tr><td>
-
-[getFileContents(path)](./FileSystemAccessTreeAccessors.getFileContents.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.getFileContents
-
-</td></tr>
-<tr><td>
-
-[getFileContentType(path, provided)](./FileSystemAccessTreeAccessors.getFileContentType.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.getFileContentType
-
-</td></tr>
-<tr><td>
-
-[getChildren(path)](./FileSystemAccessTreeAccessors.getChildren.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IFileTreeAccessors.getChildren
-
-</td></tr>
-<tr><td>
-
-[createDirectory(dirPath)](./FileSystemAccessTreeAccessors.createDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IMutableFileTreeAccessors.createDirectory
-
-</td></tr>
-<tr><td>
-
-[deleteDirectory(path)](./FileSystemAccessTreeAccessors.deleteDirectory.md)
-
-</td><td>
-
-
-
-</td><td>
-
-FileTree.IMutableFileTreeAccessors.deleteDirectory
-
-</td></tr>
-</tbody></table>