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

package/docs/ts-web-extras.ifsaccessapis.showopenfilepicker.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; [IFsAccessApis](./ts-web-extras.ifsaccessapis.md) &gt; [showOpenFilePicker](./ts-web-extras.ifsaccessapis.showopenfilepicker.md)
-
-## IFsAccessApis.showOpenFilePicker() method
-
-**Signature:**
-
-```typescript
-showOpenFilePicker(options?: ShowOpenFilePickerOptions): Promise<FileSystemFileHandle[]>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->\[\]&gt;
-

package/docs/ts-web-extras.ifsaccessapis.showsavefilepicker.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; [IFsAccessApis](./ts-web-extras.ifsaccessapis.md) &gt; [showSaveFilePicker](./ts-web-extras.ifsaccessapis.showsavefilepicker.md)
-
-## IFsAccessApis.showSaveFilePicker() method
-
-**Signature:**
-
-```typescript
-showSaveFilePicker(options?: ShowSaveFilePickerOptions): Promise<FileSystemFileHandle>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-options
-
-
-</td><td>
-
-[ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->&gt;
-

package/docs/ts-web-extras.ilocalstoragetreeparams.autosync.md

@@ -1,13 +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; [ILocalStorageTreeParams](./ts-web-extras.ilocalstoragetreeparams.md) &gt; [autoSync](./ts-web-extras.ilocalstoragetreeparams.autosync.md)
-
-## ILocalStorageTreeParams.autoSync property
-
-If true, automatically sync changes to localStorage on every modification. If false (default), changes are only synced when syncToDisk() is called.
-
-**Signature:**
-
-```typescript
-autoSync?: boolean;
-```

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

@@ -1,97 +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; [ILocalStorageTreeParams](./ts-web-extras.ilocalstoragetreeparams.md)
-
-## ILocalStorageTreeParams interface
-
-Configuration for LocalStorageTreeAccessors.
-
-**Signature:**
-
-```typescript
-export interface ILocalStorageTreeParams<TCT extends string = string> extends FileTree.IFileTreeInitParams<TCT> 
-```
-**Extends:** FileTree.IFileTreeInitParams&lt;TCT&gt;
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[autoSync?](./ts-web-extras.ilocalstoragetreeparams.autosync.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_ If true, automatically sync changes to localStorage on every modification. If false (default), changes are only synced when syncToDisk() is called.
-
-
-</td></tr>
-<tr><td>
-
-[pathToKeyMap](./ts-web-extras.ilocalstoragetreeparams.pathtokeymap.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Record&lt;string, string&gt;
-
-
-</td><td>
-
-Map of directory path prefixes to localStorage keys. Files under each prefix are stored in the corresponding localStorage key. Example: { '/data/ingredients': 'myapp:ingredients:v1' }
-
-
-</td></tr>
-<tr><td>
-
-[storage?](./ts-web-extras.ilocalstoragetreeparams.storage.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Storage
-
-
-</td><td>
-
-_(Optional)_ Storage instance to use. Defaults to window.localStorage. Can be overridden for testing with mock storage.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.ilocalstoragetreeparams.pathtokeymap.md

@@ -1,13 +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; [ILocalStorageTreeParams](./ts-web-extras.ilocalstoragetreeparams.md) &gt; [pathToKeyMap](./ts-web-extras.ilocalstoragetreeparams.pathtokeymap.md)
-
-## ILocalStorageTreeParams.pathToKeyMap property
-
-Map of directory path prefixes to localStorage keys. Files under each prefix are stored in the corresponding localStorage key. Example: { '/data/ingredients': 'myapp:ingredients:v1' }
-
-**Signature:**
-
-```typescript
-pathToKeyMap: Record<string, string>;
-```

package/docs/ts-web-extras.ilocalstoragetreeparams.storage.md

@@ -1,13 +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; [ILocalStorageTreeParams](./ts-web-extras.ilocalstoragetreeparams.md) &gt; [storage](./ts-web-extras.ilocalstoragetreeparams.storage.md)
-
-## ILocalStorageTreeParams.storage property
-
-Storage instance to use. Defaults to window.localStorage. Can be overridden for testing with mock storage.
-
-**Signature:**
-
-```typescript
-storage?: Storage;
-```

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

@@ -1,56 +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; [isDirectoryHandle](./ts-web-extras.isdirectoryhandle.md)
-
-## isDirectoryHandle() function
-
-Type guard to check if a FileSystemHandle is a directory handle
-
-**Signature:**
-
-```typescript
-export declare function isDirectoryHandle(handle: FileSystemHandle): handle is FileSystemDirectoryHandle;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-handle
-
-
-</td><td>
-
-[FileSystemHandle](./ts-web-extras.filesystemhandle_2.md)
-
-
-</td><td>
-
-The handle to check
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-handle is [FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)
-
-True if the handle is a FileSystemDirectoryHandle
-

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

@@ -1,56 +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; [isFileHandle](./ts-web-extras.isfilehandle.md)
-
-## isFileHandle() function
-
-Type guard to check if a FileSystemHandle is a file handle
-
-**Signature:**
-
-```typescript
-export declare function isFileHandle(handle: FileSystemHandle): handle is FileSystemFileHandle;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-handle
-
-
-</td><td>
-
-[FileSystemHandle](./ts-web-extras.filesystemhandle_2.md)
-
-
-</td><td>
-
-The handle to check
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-handle is [FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)
-
-True if the handle is a FileSystemFileHandle
-

package/docs/ts-web-extras.isfilepath.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; [isFilePath](./ts-web-extras.isfilepath.md)
-
-## isFilePath() function
-
-Determines if a path appears to be a file (has extension) or directory
-
-**Signature:**
-
-```typescript
-export declare function isFilePath(path: string): 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:**
-
-boolean
-

package/docs/ts-web-extras.iurlconfigoptions.config.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [config](./ts-web-extras.iurlconfigoptions.config.md)
-
-## IUrlConfigOptions.config property
-
-Configuration name or path
-
-**Signature:**
-
-```typescript
-config?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.configstartdir.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [configStartDir](./ts-web-extras.iurlconfigoptions.configstartdir.md)
-
-## IUrlConfigOptions.configStartDir property
-
-Starting directory for config file picker (derived from config path)
-
-**Signature:**
-
-```typescript
-configStartDir?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.contextfilter.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [contextFilter](./ts-web-extras.iurlconfigoptions.contextfilter.md)
-
-## IUrlConfigOptions.contextFilter property
-
-Context filter token (pipe-separated)
-
-**Signature:**
-
-```typescript
-contextFilter?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.input.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [input](./ts-web-extras.iurlconfigoptions.input.md)
-
-## IUrlConfigOptions.input property
-
-Input file path
-
-**Signature:**
-
-```typescript
-input?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.inputstartdir.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [inputStartDir](./ts-web-extras.iurlconfigoptions.inputstartdir.md)
-
-## IUrlConfigOptions.inputStartDir property
-
-Starting directory for input file picker (derived from input path)
-
-**Signature:**
-
-```typescript
-inputStartDir?: string;
-```

package/docs/ts-web-extras.iurlconfigoptions.interactive.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [interactive](./ts-web-extras.iurlconfigoptions.interactive.md)
-
-## IUrlConfigOptions.interactive property
-
-Whether to launch in interactive mode
-
-**Signature:**
-
-```typescript
-interactive?: boolean;
-```

package/docs/ts-web-extras.iurlconfigoptions.loadzip.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [loadZip](./ts-web-extras.iurlconfigoptions.loadzip.md)
-
-## IUrlConfigOptions.loadZip property
-
-Whether to use ZIP loading mode
-
-**Signature:**
-
-```typescript
-loadZip?: boolean;
-```

package/docs/ts-web-extras.iurlconfigoptions.maxdistance.md

@@ -1,13 +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; [IUrlConfigOptions](./ts-web-extras.iurlconfigoptions.md) &gt; [maxDistance](./ts-web-extras.iurlconfigoptions.maxdistance.md)
-
-## IUrlConfigOptions.maxDistance property
-
-Maximum distance for language matching
-
-**Signature:**
-
-```typescript
-maxDistance?: number;
-```