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

package/docs/ts-web-extras.fileapitreeaccessors.md

@@ -1,146 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md)
-
-## FileApiTreeAccessors class
-
-Helper class to create FileTree instances from various file sources. Supports File API (FileList) and File System Access API handles.
-
-**Signature:**
-
-```typescript
-export declare class FileApiTreeAccessors<TCT extends string = string> 
-```
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[create(initializers, params)](./ts-web-extras.fileapitreeaccessors.create.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Create FileTree from various file sources using TreeInitializer array.
-
-
-</td></tr>
-<tr><td>
-
-[createFromLocalStorage(params)](./ts-web-extras.fileapitreeaccessors.createfromlocalstorage.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Create a persistent FileTree from browser localStorage. Changes to files can be synced back to localStorage.
-
-
-</td></tr>
-<tr><td>
-
-[createPersistent(dirHandle, params)](./ts-web-extras.fileapitreeaccessors.createpersistent.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Create a persistent FileTree from a File System Access API directory handle. Changes to files can be synced back to disk.
-
-
-</td></tr>
-<tr><td>
-
-[extractFileMetadata(file)](./ts-web-extras.fileapitreeaccessors.extractfilemetadata.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Extract file metadata from a File.
-
-
-</td></tr>
-<tr><td>
-
-[fromDirectoryUpload(fileList, params)](./ts-web-extras.fileapitreeaccessors.fromdirectoryupload.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Create FileTree from directory upload with webkitRelativePath.
-
-
-</td></tr>
-<tr><td>
-
-[fromFileList(fileList, params)](./ts-web-extras.fileapitreeaccessors.fromfilelist.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Create FileTree from FileList (e.g., from input\[type="file"\]).
-
-
-</td></tr>
-<tr><td>
-
-[getOriginalFile(fileList, targetPath)](./ts-web-extras.fileapitreeaccessors.getoriginalfile.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-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.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.filepickeraccepttype.accept.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md) &gt; [accept](./ts-web-extras.filepickeraccepttype.accept.md)
-
-## FilePickerAcceptType.accept property
-
-**Signature:**
-
-```typescript
-accept: Record<string, string | string[]>;
-```

package/docs/ts-web-extras.filepickeraccepttype.description.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md) &gt; [description](./ts-web-extras.filepickeraccepttype.description.md)
-
-## FilePickerAcceptType.description property
-
-**Signature:**
-
-```typescript
-description?: string;
-```

package/docs/ts-web-extras.filepickeraccepttype.md

@@ -1,75 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md)
-
-## FilePickerAcceptType interface
-
-File picker accept type
-
-**Signature:**
-
-```typescript
-export interface FilePickerAcceptType 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[accept](./ts-web-extras.filepickeraccepttype.accept.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Record&lt;string, string \| string\[\]&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[description?](./ts-web-extras.filepickeraccepttype.description.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.filesystemaccesstreeaccessors._constructor_.md

@@ -1,114 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [(constructor)](./ts-web-extras.filesystemaccesstreeaccessors._constructor_.md)
-
-## FileSystemAccessTreeAccessors.(constructor)
-
-Protected constructor for FileSystemAccessTreeAccessors.
-
-**Signature:**
-
-```typescript
-protected constructor(files: FileTree.IInMemoryFile<TCT>[], rootDir: FileSystemDirectoryHandle, handles: Map<string, FileSystemFileHandle>, params: IFileSystemAccessTreeParams<TCT> | undefined, hasWritePermission: boolean);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-files
-
-
-</td><td>
-
-FileTree.IInMemoryFile&lt;TCT&gt;\[\]
-
-
-</td><td>
-
-An array of in-memory files to include in the tree.
-
-
-</td></tr>
-<tr><td>
-
-rootDir
-
-
-</td><td>
-
-[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)
-
-
-</td><td>
-
-The root directory handle.
-
-
-</td></tr>
-<tr><td>
-
-handles
-
-
-</td><td>
-
-Map&lt;string, [FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->&gt;
-
-
-</td><td>
-
-Map of file paths to their handles.
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-[IFileSystemAccessTreeParams](./ts-web-extras.ifilesystemaccesstreeparams.md)<!-- -->&lt;TCT&gt; \| undefined
-
-
-</td><td>
-
-Optional params for the tree.
-
-
-</td></tr>
-<tr><td>
-
-hasWritePermission
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether write permission was granted.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.filesystemaccesstreeaccessors.fileismutable.md

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [fileIsMutable](./ts-web-extras.filesystemaccesstreeaccessors.fileismutable.md)
-
-## FileSystemAccessTreeAccessors.fileIsMutable() method
-
-Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
-
-**Signature:**
-
-```typescript
-fileIsMutable(path: string): DetailedResult<boolean, FileTree.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, FileTree.SaveDetail&gt;
-

package/docs/ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md

@@ -1,72 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [fromDirectoryHandle](./ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md)
-
-## FileSystemAccessTreeAccessors.fromDirectoryHandle() method
-
-Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
-
-**Signature:**
-
-```typescript
-static fromDirectoryHandle<TCT extends string = string>(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](./ts-web-extras.filesystemdirectoryhandle_2.md)
-
-
-</td><td>
-
-The FileSystemDirectoryHandle to load files from.
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-[IFileSystemAccessTreeParams](./ts-web-extras.ifilesystemaccesstreeparams.md)<!-- -->&lt;TCT&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional parameters including autoSync and permission settings.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;[FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md)<!-- -->&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileSystemAccessTreeAccessors instance.
-

package/docs/ts-web-extras.filesystemaccesstreeaccessors.getdirtypaths.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [getDirtyPaths](./ts-web-extras.filesystemaccesstreeaccessors.getdirtypaths.md)
-
-## FileSystemAccessTreeAccessors.getDirtyPaths() method
-
-Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
-
-**Signature:**
-
-```typescript
-getDirtyPaths(): string[];
-```
-**Returns:**
-
-string\[\]
-

package/docs/ts-web-extras.filesystemaccesstreeaccessors.isdirty.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md) &gt; [isDirty](./ts-web-extras.filesystemaccesstreeaccessors.isdirty.md)
-
-## FileSystemAccessTreeAccessors.isDirty() method
-
-Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
-
-**Signature:**
-
-```typescript
-isDirty(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/ts-web-extras.filesystemaccesstreeaccessors.md

@@ -1,159 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [FileSystemAccessTreeAccessors](./ts-web-extras.filesystemaccesstreeaccessors.md)
-
-## FileSystemAccessTreeAccessors class
-
-Implementation of `FileTree.IPersistentFileTreeAccessors` that uses the File System Access API to provide persistent file editing in browsers.
-
-**Signature:**
-
-```typescript
-export declare class FileSystemAccessTreeAccessors<TCT extends string = string> extends FileTree.InMemoryTreeAccessors<TCT> implements FileTree.IPersistentFileTreeAccessors<TCT> 
-```
-**Extends:** FileTree.InMemoryTreeAccessors&lt;TCT&gt;
-
-**Implements:** FileTree.IPersistentFileTreeAccessors&lt;TCT&gt;
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(files, rootDir, handles, params, hasWritePermission)](./ts-web-extras.filesystemaccesstreeaccessors._constructor_.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-Protected constructor for FileSystemAccessTreeAccessors.
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[fileIsMutable(path)](./ts-web-extras.filesystemaccesstreeaccessors.fileismutable.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Implements `FileTree.IMutableFileTreeAccessors.fileIsMutable`
-
-
-</td></tr>
-<tr><td>
-
-[fromDirectoryHandle(dirHandle, params)](./ts-web-extras.filesystemaccesstreeaccessors.fromdirectoryhandle.md)
-
-
-</td><td>
-
-`static`
-
-
-</td><td>
-
-Creates a new FileSystemAccessTreeAccessors instance from a directory handle.
-
-
-</td></tr>
-<tr><td>
-
-[getDirtyPaths()](./ts-web-extras.filesystemaccesstreeaccessors.getdirtypaths.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Implements `FileTree.IPersistentFileTreeAccessors.getDirtyPaths`
-
-
-</td></tr>
-<tr><td>
-
-[isDirty()](./ts-web-extras.filesystemaccesstreeaccessors.isdirty.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Implements `FileTree.IPersistentFileTreeAccessors.isDirty`
-
-
-</td></tr>
-<tr><td>
-
-[saveFileContents(path, contents)](./ts-web-extras.filesystemaccesstreeaccessors.savefilecontents.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Implements `FileTree.IMutableFileTreeAccessors.saveFileContents`
-
-
-</td></tr>
-<tr><td>
-
-[syncToDisk()](./ts-web-extras.filesystemaccesstreeaccessors.synctodisk.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Implements `FileTree.IPersistentFileTreeAccessors.syncToDisk`
-
-
-</td></tr>
-</tbody></table>
-