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

package/docs/interfaces/IFileHandleTreeInitializer.md

@@ -0,0 +1,61 @@
+[Home](../README.md) > IFileHandleTreeInitializer
+
+# Interface: IFileHandleTreeInitializer
+
+Tree initializer for File System Access API file handles.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[prefix](./IFileHandleTreeInitializer.prefix.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[fileHandles](./IFileHandleTreeInitializer.fileHandles.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+[FileSystemFileHandle](FileSystemFileHandle.md)[]
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileHandleTreeInitializer.prefix.md

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

package/docs/interfaces/IFileListTreeInitializer.fileList.md

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

package/docs/interfaces/IFileListTreeInitializer.md

@@ -0,0 +1,44 @@
+[Home](../README.md) > IFileListTreeInitializer
+
+# Interface: IFileListTreeInitializer
+
+Tree initializer for FileList objects (from File API).
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[fileList](./IFileListTreeInitializer.fileList.md)
+
+</td><td>
+
+`readonly`
+
+</td><td>
+
+FileList
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileMetadata.lastModified.md

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

package/docs/interfaces/IFileMetadata.md

@@ -0,0 +1,112 @@
+[Home](../README.md) > IFileMetadata
+
+# Interface: IFileMetadata
+
+Interface for file metadata.
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[path](./IFileMetadata.path.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[name](./IFileMetadata.name.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[size](./IFileMetadata.size.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[type](./IFileMetadata.type.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[lastModified](./IFileMetadata.lastModified.md)
+
+</td><td>
+
+
+
+</td><td>
+
+number
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/IFileMetadata.name.md

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

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

@@ -0,0 +1,148 @@
+[Home](../README.md) > IFileSystemAccessTreeParams
+
+# Interface: IFileSystemAccessTreeParams
+
+Options for creating persistent file trees.
+
+**Extends:** `IFileTreeInitParams<TCT>`
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</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.
+
+</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

@@ -0,0 +1,62 @@
+[Home](../README.md) > IFsAccessApis
+
+# Interface: IFsAccessApis
+
+File System Access API methods available on Window
+
+## Methods
+
+<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>
+
+
+
+</td></tr>
+<tr><td>
+
+[showOpenFilePicker(options)](./IFsAccessApis.showOpenFilePicker.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[showSaveFilePicker(options)](./IFsAccessApis.showSaveFilePicker.md)
+
+</td><td>
+
+
+
+</td><td>
+
+
+
+</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>;
+```