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

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

@@ -1,70 +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; [exportAsJson](./ts-web-extras.exportasjson.md)
-
-## exportAsJson() function
-
-Export data as JSON file using legacy blob download method. Creates a temporary download link and triggers file download.
-
-**Signature:**
-
-```typescript
-export declare function exportAsJson(data: unknown, filename: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-Data to export as JSON
-
-
-</td></tr>
-<tr><td>
-
-filename
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Name for the downloaded file
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,104 +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; [exportUsingFileSystemAPI](./ts-web-extras.exportusingfilesystemapi.md)
-
-## exportUsingFileSystemAPI() function
-
-Export data using File System Access API with fallback to blob download.
-
-**Signature:**
-
-```typescript
-export declare function exportUsingFileSystemAPI(data: unknown, suggestedName: string, description?: string, window?: Window): Promise<boolean>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-Data to export as JSON
-
-
-</td></tr>
-<tr><td>
-
-suggestedName
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Suggested filename for the save dialog
-
-
-</td></tr>
-<tr><td>
-
-description
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-_(Optional)_ Description for file type filter (default: 'JSON files')
-
-
-</td></tr>
-<tr><td>
-
-window
-
-
-</td><td>
-
-Window
-
-
-</td><td>
-
-_(Optional)_ Window object for API access (default: globalThis.window)
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-Promise resolving to true if saved via File System Access API, false if fallback used
-

package/docs/ts-web-extras.extractdirectorypath.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; [extractDirectoryPath](./ts-web-extras.extractdirectorypath.md)
-
-## extractDirectoryPath() function
-
-Extracts the directory path from a file or directory path If the path appears to be a directory (no extension), returns it as-is If the path appears to be a file, returns the parent directory
-
-**Signature:**
-
-```typescript
-export declare function extractDirectoryPath(path: string): 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>
-</tbody></table>
-
-**Returns:**
-
-string
-

package/docs/ts-web-extras.fileapitreeaccessors.create.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [create](./ts-web-extras.fileapitreeaccessors.create.md)
-
-## FileApiTreeAccessors.create() method
-
-Create FileTree from various file sources using TreeInitializer array.
-
-**Signature:**
-
-```typescript
-static create<TCT extends string = string>(initializers: TreeInitializer[], params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<TCT>>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-initializers
-
-
-</td><td>
-
-[TreeInitializer](./ts-web-extras.treeinitializer.md)<!-- -->\[\]
-
-
-</td><td>
-
-Array of TreeInitializer objects specifying file sources
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-FileTree.IFileTreeInitParams&lt;TCT&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with all content pre-loaded
-

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

@@ -1,74 +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) &gt; [createFromLocalStorage](./ts-web-extras.fileapitreeaccessors.createfromlocalstorage.md)
-
-## FileApiTreeAccessors.createFromLocalStorage() method
-
-Create a persistent FileTree from browser localStorage. Changes to files can be synced back to localStorage.
-
-**Signature:**
-
-```typescript
-static createFromLocalStorage<TCT extends string = string>(params: ILocalStorageTreeParams<TCT>): Result<FileTree.FileTree<TCT>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-params
-
-
-</td><td>
-
-[ILocalStorageTreeParams](./ts-web-extras.ilocalstoragetreeparams.md)<!-- -->&lt;TCT&gt;
-
-
-</td><td>
-
-Configuration including path-to-key mappings and optional autoSync
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;
-
-Result containing a FileTree with persistence capability
-
-## Remarks
-
-- Works in all browsers with localStorage support - Maps directory paths to localStorage keys - Each key stores multiple collections as JSON - Files are automatically discovered from storage
-
-## Example
-
-
-```typescript
-const tree = FileApiTreeAccessors.createFromLocalStorage({
-  pathToKeyMap: {
-    '/data/ingredients': 'myapp:ingredients:v1',
-    '/data/fillings': 'myapp:fillings:v1'
-  },
-  mutable: true,
-  autoSync: false
-});
-```
-

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

@@ -1,76 +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) &gt; [createPersistent](./ts-web-extras.fileapitreeaccessors.createpersistent.md)
-
-## 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<TCT extends string = string>(dirHandle: FileSystemDirectoryHandle, params?: IFileSystemAccessTreeParams<TCT>): Promise<Result<FileTree.FileTree<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>
-
-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;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with persistence capability
-
-## Remarks
-
-- Only works in browsers supporting File System Access API (Chrome, Edge, Opera) - Requires 'readwrite' permission on the directory handle - Falls back to read-only mode if permissions unavailable (unless requireWritePermission is true)
-

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

@@ -1,54 +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) &gt; [extractFileMetadata](./ts-web-extras.fileapitreeaccessors.extractfilemetadata.md)
-
-## 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](./ts-web-extras.ifilemetadata.md)
-
-The [file metadata](./ts-web-extras.ifilemetadata.md)
-

package/docs/ts-web-extras.fileapitreeaccessors.fromdirectoryupload.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [fromDirectoryUpload](./ts-web-extras.fileapitreeaccessors.fromdirectoryupload.md)
-
-## FileApiTreeAccessors.fromDirectoryUpload() method
-
-Create FileTree from directory upload with webkitRelativePath.
-
-**Signature:**
-
-```typescript
-static fromDirectoryUpload<TCT extends string = string>(fileList: FileList, params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<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>
-
-FileTree.IFileTreeInitParams&lt;TCT&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with all content pre-loaded
-

package/docs/ts-web-extras.fileapitreeaccessors.fromfilelist.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [fromFileList](./ts-web-extras.fileapitreeaccessors.fromfilelist.md)
-
-## FileApiTreeAccessors.fromFileList() method
-
-Create FileTree from FileList (e.g., from input\[type="file"\]).
-
-**Signature:**
-
-```typescript
-static fromFileList<TCT extends string = string>(fileList: FileList, params?: FileTree.IFileTreeInitParams<TCT>): Promise<Result<FileTree.FileTree<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>
-
-FileTree.IFileTreeInitParams&lt;TCT&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree.FileTree&lt;TCT&gt;&gt;&gt;
-
-Promise resolving to a FileTree with all content pre-loaded
-

package/docs/ts-web-extras.fileapitreeaccessors.getoriginalfile.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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md) &gt; [getOriginalFile](./ts-web-extras.fileapitreeaccessors.getoriginalfile.md)
-
-## 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
-