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

package/docs/interfaces/IFileMetadata.path.md

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

package/docs/interfaces/IFileMetadata.size.md

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

package/docs/interfaces/IFileMetadata.type.md

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

package/docs/interfaces/IFileSystemAccessTreeParams.autoSync.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > [IFileSystemAccessTreeParams](./IFileSystemAccessTreeParams.md) > autoSync
+
+## IFileSystemAccessTreeParams.autoSync property
+
+Automatically sync changes to disk immediately after each save.
+If false, changes are batched and written on explicit syncToDisk() call.
+
+**Signature:**
+
+```typescript
+autoSync: boolean;
+```

package/docs/interfaces/IFileSystemAccessTreeParams.filePath.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [IFileSystemAccessTreeParams](./IFileSystemAccessTreeParams.md) > filePath
+
+## IFileSystemAccessTreeParams.filePath property
+
+Override the path at which the file is stored in the tree (for fromFileHandle).
+Must be an absolute path (e.g., '/data/confections/common.yaml').
+If omitted, defaults to `/<filename>`.
+
+**Signature:**
+
+```typescript
+filePath: string;
+```

package/docs/interfaces/IFileSystemAccessTreeParams.logger.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > [IFileSystemAccessTreeParams](./IFileSystemAccessTreeParams.md) > logger
+
+## IFileSystemAccessTreeParams.logger property
+
+Optional logger for auto-sync and persistence failures.
+
+**Signature:**
+
+```typescript
+logger: LogReporter<unknown, unknown>;
+```

package/docs/interfaces/IFileSystemAccessTreeParams.md

@@ -1,30 +1,148 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > IFileSystemAccessTreeParams
 
-***
+# Interface: IFileSystemAccessTreeParams
 
-[@fgv/ts-web-extras](../README.md) / IFileSystemAccessTreeParams
+Options for creating persistent file trees.
 
-# Interface: IFileSystemAccessTreeParams\<TCT\>
+**Extends:** `IFileTreeInitParams<TCT>`
 
-Options for creating persistent file trees.
+## 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>
+
+[autoSync](./IFileSystemAccessTreeParams.autoSync.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Automatically sync changes to disk immediately after each save.
+
+</td></tr>
+<tr><td>
+
+[requireWritePermission](./IFileSystemAccessTreeParams.requireWritePermission.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+Require write permission on the directory handle.
+
+</td></tr>
+<tr><td>
+
+[filePath](./IFileSystemAccessTreeParams.filePath.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+Override the path at which the file is stored in the tree (for fromFileHandle).
+
+</td></tr>
+<tr><td>
+
+[logger](./IFileSystemAccessTreeParams.logger.md)
+
+</td><td>
+
+
+
+</td><td>
+
+LogReporter&lt;unknown, unknown&gt;
+
+</td><td>
+
+Optional logger for auto-sync and persistence failures.
+
+</td></tr>
+<tr><td>
+
+[prefix](./IFileSystemAccessTreeParams.prefix.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[inferContentType](./IFileSystemAccessTreeParams.inferContentType.md)
+
+</td><td>
+
+
+
+</td><td>
+
+ContentTypeFactory&lt;TCT&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[mutable](./IFileSystemAccessTreeParams.mutable.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean | IFilterSpec
+
+</td><td>
+
+Controls mutability of the file tree.
 
-| Property | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| <a id="autosync"></a> `autoSync?` | `boolean` | `false` | Automatically sync changes to disk immediately after each save. If false, changes are batched and written on explicit syncToDisk() call. |
-| <a id="filepath"></a> `filePath?` | `string` | `undefined` | Override the path at which the file is stored in the tree (for fromFileHandle). Must be an absolute path (e.g., '/data/confections/common.yaml'). If omitted, defaults to `/<filename>`. |
-| <a id="infercontenttype"></a> `inferContentType?` | [`ContentTypeFactory`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | `undefined` | - |
-| <a id="mutable"></a> `mutable?` | `boolean` \| [`IFilterSpec`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs) | `undefined` | 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="prefix"></a> `prefix?` | `string` | `undefined` | - |
-| <a id="requirewritepermission"></a> `requireWritePermission?` | `boolean` | `true` | Require write permission on the directory handle. If true, fails if write permission cannot be obtained. If false, falls back to read-only mode. |
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileSystemAccessTreeParams.requireWritePermission.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [IFileSystemAccessTreeParams](./IFileSystemAccessTreeParams.md) > requireWritePermission
+
+## IFileSystemAccessTreeParams.requireWritePermission property
+
+Require write permission on the directory handle.
+If true, fails if write permission cannot be obtained.
+If false, falls back to read-only mode.
+
+**Signature:**
+
+```typescript
+requireWritePermission: boolean;
+```

package/docs/interfaces/IFsAccessApis.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / IFsAccessApis
+[Home](../README.md) > IFsAccessApis
 
 # Interface: IFsAccessApis
 
@@ -10,48 +6,57 @@ File System Access API methods available on Window
 
 ## Methods
 
-### showDirectoryPicker()
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[showDirectoryPicker(options)](./IFsAccessApis.showDirectoryPicker.md)
+
+</td><td>
+
+
+
+</td><td>
 
-> **showDirectoryPicker**(`options?`): `Promise`\<[`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)\>
 
-#### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `options?` | [`ShowDirectoryPickerOptions`](ShowDirectoryPickerOptions.md) |
+</td></tr>
+<tr><td>
 
-#### Returns
+[showOpenFilePicker(options)](./IFsAccessApis.showOpenFilePicker.md)
 
-`Promise`\<[`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)\>
+</td><td>
 
-***
 
-### showOpenFilePicker()
 
-> **showOpenFilePicker**(`options?`): `Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)[]\>
+</td><td>
 
-#### Parameters
 
-| Parameter | Type |
-| ------ | ------ |
-| `options?` | [`ShowOpenFilePickerOptions`](ShowOpenFilePickerOptions.md) |
 
-#### Returns
+</td></tr>
+<tr><td>
 
-`Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)[]\>
+[showSaveFilePicker(options)](./IFsAccessApis.showSaveFilePicker.md)
 
-***
+</td><td>
 
-### showSaveFilePicker()
 
-> **showSaveFilePicker**(`options?`): `Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
 
-#### Parameters
+</td><td>
 
-| Parameter | Type |
-| ------ | ------ |
-| `options?` | [`ShowSaveFilePickerOptions`](ShowSaveFilePickerOptions.md) |
 
-#### Returns
 
-`Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFsAccessApis.showDirectoryPicker.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IFsAccessApis](./IFsAccessApis.md) > showDirectoryPicker
+
+## IFsAccessApis.showDirectoryPicker() method
+
+**Signature:**
+
+```typescript
+showDirectoryPicker(options?: ShowDirectoryPickerOptions): Promise<FileSystemDirectoryHandle>;
+```
+
+**Parameters:**
+
+<table><thead><tr><th>Parameter</th><th>Type</th><th>Description</th></tr></thead>
+<tbody>
+<tr><td>options</td><td>ShowDirectoryPickerOptions</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemDirectoryHandle](FileSystemDirectoryHandle.md)&gt;

package/docs/interfaces/IFsAccessApis.showOpenFilePicker.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IFsAccessApis](./IFsAccessApis.md) > showOpenFilePicker
+
+## 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</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemFileHandle](FileSystemFileHandle.md)[]&gt;

package/docs/interfaces/IFsAccessApis.showSaveFilePicker.md

@@ -0,0 +1,20 @@
+[Home](../README.md) > [IFsAccessApis](./IFsAccessApis.md) > showSaveFilePicker
+
+## 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</td><td></td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemFileHandle](FileSystemFileHandle.md)&gt;

package/docs/interfaces/IHttpTreeParams.autoSync.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IHttpTreeParams](./IHttpTreeParams.md) > autoSync
+
+## IHttpTreeParams.autoSync property
+
+**Signature:**
+
+```typescript
+readonly autoSync: boolean;
+```

package/docs/interfaces/IHttpTreeParams.baseUrl.md

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

package/docs/interfaces/IHttpTreeParams.fetchImpl.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IHttpTreeParams](./IHttpTreeParams.md) > fetchImpl
+
+## IHttpTreeParams.fetchImpl property
+
+**Signature:**
+
+```typescript
+readonly fetchImpl: { (input: RequestInfo | URL, init?: RequestInit): Promise<Response>; (input: string | Request | URL, init?: RequestInit): Promise<Response> };
+```

package/docs/interfaces/IHttpTreeParams.logger.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [IHttpTreeParams](./IHttpTreeParams.md) > logger
+
+## IHttpTreeParams.logger property
+
+**Signature:**
+
+```typescript
+readonly logger: LogReporter<unknown, unknown>;
+```

package/docs/interfaces/IHttpTreeParams.md

@@ -1,32 +1,182 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > IHttpTreeParams
 
-***
+# Interface: IHttpTreeParams
 
-[@fgv/ts-web-extras](../README.md) / IHttpTreeParams
+Configuration for creating HTTP-backed tree accessors.
 
-# Interface: IHttpTreeParams\<TCT\>
+**Extends:** `IFileTreeInitParams<TCT>`
 
-Configuration for creating HTTP-backed tree accessors.
+## 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>
+
+[baseUrl](./IHttpTreeParams.baseUrl.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[namespace](./IHttpTreeParams.namespace.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[autoSync](./IHttpTreeParams.autoSync.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[fetchImpl](./IHttpTreeParams.fetchImpl.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+{ (input: RequestInfo | URL, init?: RequestInit): Promise&lt;Response&gt;; (input: string | Request | URL, init?: RequestInit): Promise&lt;Response&gt; }
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[userId](./IHttpTreeParams.userId.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[logger](./IHttpTreeParams.logger.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+LogReporter&lt;unknown, unknown&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[prefix](./IHttpTreeParams.prefix.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[inferContentType](./IHttpTreeParams.inferContentType.md)
+
+</td><td>
+
+
+
+</td><td>
+
+ContentTypeFactory&lt;TCT&gt;
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[mutable](./IHttpTreeParams.mutable.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean | IFilterSpec
+
+</td><td>
+
+Controls mutability of the file tree.
 
-| Property | Modifier | Type | Description |
-| ------ | ------ | ------ | ------ |
-| <a id="autosync"></a> `autoSync?` | `readonly` | `boolean` | - |
-| <a id="baseurl"></a> `baseUrl` | `readonly` | `string` | - |
-| <a id="fetchimpl"></a> `fetchImpl?` | `readonly` | \{(`input`, `init?`): `Promise`\<`Response`\>; (`input`, `init?`): `Promise`\<`Response`\>; \} | - |
-| <a id="infercontenttype"></a> `inferContentType?` | `public` | [`ContentTypeFactory`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`TCT`\> | - |
-| <a id="mutable"></a> `mutable?` | `public` | `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="namespace"></a> `namespace?` | `readonly` | `string` | - |
-| <a id="prefix"></a> `prefix?` | `public` | `string` | - |
-| <a id="userid"></a> `userId?` | `readonly` | `string` | - |
+</td></tr>
+</tbody></table>

package/docs/interfaces/IHttpTreeParams.namespace.md

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

package/docs/interfaces/IHttpTreeParams.userId.md

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

package/docs/interfaces/ILocalStorageTreeParams.autoSync.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > [ILocalStorageTreeParams](./ILocalStorageTreeParams.md) > autoSync
+
+## 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;
+```