@fgv/ts-web-extras 5.1.0-3 → 5.1.0-5

package/docs/interfaces/ILocalStorageTreeParams.md

@@ -1,30 +1,131 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > ILocalStorageTreeParams
 
-***
+# Interface: ILocalStorageTreeParams
 
-[@fgv/ts-web-extras](../README.md) / ILocalStorageTreeParams
+Configuration for LocalStorageTreeAccessors.
 
-# Interface: ILocalStorageTreeParams\<TCT\>
+**Extends:** `IFileTreeInitParams<TCT>`
 
-Configuration for LocalStorageTreeAccessors.
+## Properties
 
-## Extends
+<table><thead><tr><th>
 
-- [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\>
+Property
 
-## Type Parameters
+</th><th>
 
-| Type Parameter | Default type |
-| ------ | ------ |
-| `TCT` *extends* `string` | `string` |
+Modifiers
 
-## Properties
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[pathToKeyMap](./ILocalStorageTreeParams.pathToKeyMap.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Record&lt;string, string&gt;
+
+</td><td>
+
+Map of directory path prefixes to localStorage keys.
+
+</td></tr>
+<tr><td>
+
+[storage](./ILocalStorageTreeParams.storage.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Storage
+
+</td><td>
+
+Storage instance to use.
+
+</td></tr>
+<tr><td>
+
+[autoSync](./ILocalStorageTreeParams.autoSync.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+If true, automatically sync changes to localStorage on every modification.
+
+</td></tr>
+<tr><td>
+
+[prefix](./ILocalStorageTreeParams.prefix.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[inferContentType](./ILocalStorageTreeParams.inferContentType.md)
+
+</td><td>
+
+
+
+</td><td>
+
+ContentTypeFactory&lt;TCT&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[mutable](./ILocalStorageTreeParams.mutable.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean | IFilterSpec
+
+</td><td>
+
+Controls mutability of the file tree.
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="autosync"></a> `autoSync?` | `boolean` | If true, automatically sync changes to localStorage on every modification. If false (default), changes are only synced when syncToDisk() is called. |
-| <a id="infercontenttype"></a> `inferContentType?` | [`ContentTypeFactory`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | - |
-| <a id="mutable"></a> `mutable?` | `boolean` \| [`IFilterSpec`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) | Controls mutability of the file tree. - `undefined` or `false`: No files are mutable. - `true`: All files are mutable. - `IFilterSpec`: Only files matching the filter are mutable. |
-| <a id="pathtokeymap"></a> `pathToKeyMap` | `Record`\<`string`, `string`\> | 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' } |
-| <a id="prefix"></a> `prefix?` | `string` | - |
-| <a id="storage"></a> `storage?` | `Storage` | Storage instance to use. Defaults to window.localStorage. Can be overridden for testing with mock storage. |
+</td></tr>
+</tbody></table>

package/docs/interfaces/ILocalStorageTreeParams.pathToKeyMap.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [ILocalStorageTreeParams](./ILocalStorageTreeParams.md) > pathToKeyMap
+
+## 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/interfaces/ILocalStorageTreeParams.storage.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > [ILocalStorageTreeParams](./ILocalStorageTreeParams.md) > storage
+
+## 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/interfaces/IUrlConfigOptions.config.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > config
+
+## IUrlConfigOptions.config property
+
+Configuration name or path
+
+**Signature:**
+
+```typescript
+config: string;
+```

package/docs/interfaces/IUrlConfigOptions.configStartDir.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > configStartDir
+
+## IUrlConfigOptions.configStartDir property
+
+Starting directory for config file picker (derived from config path)
+
+**Signature:**
+
+```typescript
+configStartDir: string;
+```

package/docs/interfaces/IUrlConfigOptions.contextFilter.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > contextFilter
+
+## IUrlConfigOptions.contextFilter property
+
+Context filter token (pipe-separated)
+
+**Signature:**
+
+```typescript
+contextFilter: string;
+```

package/docs/interfaces/IUrlConfigOptions.input.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > input
+
+## IUrlConfigOptions.input property
+
+Input file path
+
+**Signature:**
+
+```typescript
+input: string;
+```

package/docs/interfaces/IUrlConfigOptions.inputStartDir.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > inputStartDir
+
+## IUrlConfigOptions.inputStartDir property
+
+Starting directory for input file picker (derived from input path)
+
+**Signature:**
+
+```typescript
+inputStartDir: string;
+```

package/docs/interfaces/IUrlConfigOptions.interactive.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > interactive
+
+## IUrlConfigOptions.interactive property
+
+Whether to launch in interactive mode
+
+**Signature:**
+
+```typescript
+interactive: boolean;
+```

package/docs/interfaces/IUrlConfigOptions.loadZip.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > loadZip
+
+## IUrlConfigOptions.loadZip property
+
+Whether to use ZIP loading mode
+
+**Signature:**
+
+```typescript
+loadZip: boolean;
+```

package/docs/interfaces/IUrlConfigOptions.maxDistance.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > maxDistance
+
+## IUrlConfigOptions.maxDistance property
+
+Maximum distance for language matching
+
+**Signature:**
+
+```typescript
+maxDistance: number;
+```

package/docs/interfaces/IUrlConfigOptions.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / IUrlConfigOptions
+[Home](../README.md) > IUrlConfigOptions
 
 # Interface: IUrlConfigOptions
 
@@ -10,18 +6,243 @@ Configuration options that can be passed via URL parameters
 
 ## Properties
 
-| Property | Type | Description |
-| ------ | ------ | ------ |
-| <a id="config"></a> `config?` | `string` | Configuration name or path |
-| <a id="configstartdir"></a> `configStartDir?` | `string` | Starting directory for config file picker (derived from config path) |
-| <a id="contextfilter"></a> `contextFilter?` | `string` | Context filter token (pipe-separated) |
-| <a id="input"></a> `input?` | `string` | Input file path |
-| <a id="inputstartdir"></a> `inputStartDir?` | `string` | Starting directory for input file picker (derived from input path) |
-| <a id="interactive"></a> `interactive?` | `boolean` | Whether to launch in interactive mode |
-| <a id="loadzip"></a> `loadZip?` | `boolean` | Whether to use ZIP loading mode |
-| <a id="maxdistance"></a> `maxDistance?` | `number` | Maximum distance for language matching |
-| <a id="qualifierdefaults"></a> `qualifierDefaults?` | `string` | Qualifier defaults token (pipe-separated) |
-| <a id="reducequalifiers"></a> `reduceQualifiers?` | `boolean` | Whether to reduce qualifiers |
-| <a id="resourcetypes"></a> `resourceTypes?` | `string` | Resource types filter (comma-separated) |
-| <a id="zipfile"></a> `zipFile?` | `string` | Name of ZIP file to load from Downloads (filename only) |
-| <a id="zippath"></a> `zipPath?` | `string` | Path to ZIP file to load (for CLI-generated ZIPs) |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[input](./IUrlConfigOptions.input.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Input file path
+
+</td></tr>
+<tr><td>
+
+[config](./IUrlConfigOptions.config.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Configuration name or path
+
+</td></tr>
+<tr><td>
+
+[contextFilter](./IUrlConfigOptions.contextFilter.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Context filter token (pipe-separated)
+
+</td></tr>
+<tr><td>
+
+[qualifierDefaults](./IUrlConfigOptions.qualifierDefaults.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Qualifier defaults token (pipe-separated)
+
+</td></tr>
+<tr><td>
+
+[resourceTypes](./IUrlConfigOptions.resourceTypes.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Resource types filter (comma-separated)
+
+</td></tr>
+<tr><td>
+
+[maxDistance](./IUrlConfigOptions.maxDistance.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+Maximum distance for language matching
+
+</td></tr>
+<tr><td>
+
+[reduceQualifiers](./IUrlConfigOptions.reduceQualifiers.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to reduce qualifiers
+
+</td></tr>
+<tr><td>
+
+[interactive](./IUrlConfigOptions.interactive.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to launch in interactive mode
+
+</td></tr>
+<tr><td>
+
+[inputStartDir](./IUrlConfigOptions.inputStartDir.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Starting directory for input file picker (derived from input path)
+
+</td></tr>
+<tr><td>
+
+[configStartDir](./IUrlConfigOptions.configStartDir.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Starting directory for config file picker (derived from config path)
+
+</td></tr>
+<tr><td>
+
+[loadZip](./IUrlConfigOptions.loadZip.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Whether to use ZIP loading mode
+
+</td></tr>
+<tr><td>
+
+[zipPath](./IUrlConfigOptions.zipPath.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Path to ZIP file to load (for CLI-generated ZIPs)
+
+</td></tr>
+<tr><td>
+
+[zipFile](./IUrlConfigOptions.zipFile.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Name of ZIP file to load from Downloads (filename only)
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IUrlConfigOptions.qualifierDefaults.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > qualifierDefaults
+
+## IUrlConfigOptions.qualifierDefaults property
+
+Qualifier defaults token (pipe-separated)
+
+**Signature:**
+
+```typescript
+qualifierDefaults: string;
+```

package/docs/interfaces/IUrlConfigOptions.reduceQualifiers.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > reduceQualifiers
+
+## IUrlConfigOptions.reduceQualifiers property
+
+Whether to reduce qualifiers
+
+**Signature:**
+
+```typescript
+reduceQualifiers: boolean;
+```

package/docs/interfaces/IUrlConfigOptions.resourceTypes.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > resourceTypes
+
+## IUrlConfigOptions.resourceTypes property
+
+Resource types filter (comma-separated)
+
+**Signature:**
+
+```typescript
+resourceTypes: string;
+```

package/docs/interfaces/IUrlConfigOptions.zipFile.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > zipFile
+
+## IUrlConfigOptions.zipFile property
+
+Name of ZIP file to load from Downloads (filename only)
+
+**Signature:**
+
+```typescript
+zipFile: string;
+```

package/docs/interfaces/IUrlConfigOptions.zipPath.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IUrlConfigOptions](./IUrlConfigOptions.md) > zipPath
+
+## IUrlConfigOptions.zipPath property
+
+Path to ZIP file to load (for CLI-generated ZIPs)
+
+**Signature:**
+
+```typescript
+zipPath: string;
+```

package/docs/interfaces/ShowDirectoryPickerOptions.id.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [ShowDirectoryPickerOptions](./ShowDirectoryPickerOptions.md) > id
+
+## ShowDirectoryPickerOptions.id property
+
+**Signature:**
+
+```typescript
+id: string;
+```