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

package/docs/functions/exportAsJson.md

@@ -1,23 +1,12 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > exportAsJson
 
-***
-
-[@fgv/ts-web-extras](../README.md) / exportAsJson
-
-# Function: exportAsJson()
-
-> **exportAsJson**(`data`, `filename`): `void`
+# Function: exportAsJson
 
 Export data as JSON file using legacy blob download method.
 Creates a temporary download link and triggers file download.
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `data` | `unknown` | Data to export as JSON |
-| `filename` | `string` | Name for the downloaded file |
-
-## Returns
+## Signature
 
-`void`
+```typescript
+function exportAsJson(data: unknown, filename: string): void
+```

package/docs/functions/exportUsingFileSystemAPI.md

@@ -1,26 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > exportUsingFileSystemAPI
 
-***
-
-[@fgv/ts-web-extras](../README.md) / exportUsingFileSystemAPI
-
-# Function: exportUsingFileSystemAPI()
-
-> **exportUsingFileSystemAPI**(`data`, `suggestedName`, `description`, `window`): `Promise`\<`boolean`\>
+# Function: exportUsingFileSystemAPI
 
 Export data using File System Access API with fallback to blob download.
 
-## Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `data` | `unknown` | `undefined` | Data to export as JSON |
-| `suggestedName` | `string` | `undefined` | Suggested filename for the save dialog |
-| `description` | `string` | `'JSON files'` | Description for file type filter (default: 'JSON files') |
-| `window` | `Window` | `globalThis.window` | Window object for API access (default: globalThis.window) |
-
-## Returns
-
-`Promise`\<`boolean`\>
+## Signature
 
-Promise resolving to true if saved via File System Access API, false if fallback used
+```typescript
+function exportUsingFileSystemAPI(data: unknown, suggestedName: string, description: string, window: Window): Promise<boolean>
+```

package/docs/functions/extractDirectoryPath.md

@@ -1,23 +1,13 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > extractDirectoryPath
 
-***
-
-[@fgv/ts-web-extras](../README.md) / extractDirectoryPath
-
-# Function: extractDirectoryPath()
-
-> **extractDirectoryPath**(`path`): `string`
+# Function: extractDirectoryPath
 
 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
 
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-
-## Returns
+## Signature
 
-`string`
+```typescript
+function extractDirectoryPath(path: string): string
+```

package/docs/functions/extractFileListMetadata.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > extractFileListMetadata
+
+# Function: extractFileListMetadata
+
+Helper function to extract metadata from a `FileList`.
+
+## Signature
+
+```typescript
+function extractFileListMetadata(fileList: FileList): IFileMetadata[]
+```

package/docs/functions/extractFileMetadata.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > extractFileMetadata
+
+# Function: extractFileMetadata
+
+Helper function to extract metadata from a `File`.
+
+## Signature
+
+```typescript
+function extractFileMetadata(file: File): IFileMetadata
+```

package/docs/functions/fromDirectoryUpload.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > fromDirectoryUpload
+
+# Function: fromDirectoryUpload
+
+Helper function to create a new FileTree instance
+from a directory upload with webkitRelativePath support.
+
+## Signature
+
+```typescript
+function fromDirectoryUpload(fileList: FileList, params: IFileTreeInitParams<string>): Promise<Result<FileTree_2<string>>>
+```

package/docs/functions/fromFileList.md

@@ -0,0 +1,12 @@
+[Home](../README.md) > fromFileList
+
+# Function: fromFileList
+
+Helper function to create a new FileTree instance
+from a browser FileList (e.g., from input[type="file"]).
+
+## Signature
+
+```typescript
+function fromFileList(fileList: FileList, params: IFileTreeInitParams<string>): Promise<Result<FileTree_2<string>>>
+```

package/docs/functions/getOriginalFile.md

@@ -0,0 +1,11 @@
+[Home](../README.md) > getOriginalFile
+
+# Function: getOriginalFile
+
+Helper function to get the original File object from a FileList by path.
+
+## Signature
+
+```typescript
+function getOriginalFile(fileList: FileList, path: string): Result<File>
+```

package/docs/functions/isDirectoryHandle.md

@@ -1,23 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > isDirectoryHandle
 
-***
-
-[@fgv/ts-web-extras](../README.md) / isDirectoryHandle
-
-# Function: isDirectoryHandle()
-
-> **isDirectoryHandle**(`handle`): `handle is FileSystemDirectoryHandle`
+# Function: isDirectoryHandle
 
 Type guard to check if a FileSystemHandle is a directory handle
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `handle` | [`FileSystemHandle`](../interfaces/FileSystemHandle.md) | The handle to check |
-
-## Returns
-
-`handle is FileSystemDirectoryHandle`
+## Signature
 
-True if the handle is a FileSystemDirectoryHandle
+```typescript
+function isDirectoryHandle(handle: FileSystemHandle): handle is FileSystemDirectoryHandle
+```

package/docs/functions/isFileHandle.md

@@ -1,23 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > isFileHandle
 
-***
-
-[@fgv/ts-web-extras](../README.md) / isFileHandle
-
-# Function: isFileHandle()
-
-> **isFileHandle**(`handle`): `handle is FileSystemFileHandle`
+# Function: isFileHandle
 
 Type guard to check if a FileSystemHandle is a file handle
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `handle` | [`FileSystemHandle`](../interfaces/FileSystemHandle.md) | The handle to check |
-
-## Returns
-
-`handle is FileSystemFileHandle`
+## Signature
 
-True if the handle is a FileSystemFileHandle
+```typescript
+function isFileHandle(handle: FileSystemHandle): handle is FileSystemFileHandle
+```

package/docs/functions/isFilePath.md

@@ -1,21 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > isFilePath
 
-***
-
-[@fgv/ts-web-extras](../README.md) / isFilePath
-
-# Function: isFilePath()
-
-> **isFilePath**(`path`): `boolean`
+# Function: isFilePath
 
 Determines if a path appears to be a file (has extension) or directory
 
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `path` | `string` |
-
-## Returns
+## Signature
 
-`boolean`
+```typescript
+function isFilePath(path: string): boolean
+```

package/docs/functions/parseContextFilter.md

@@ -1,22 +1,12 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > parseContextFilter
 
-***
-
-[@fgv/ts-web-extras](../README.md) / parseContextFilter
-
-# Function: parseContextFilter()
-
-> **parseContextFilter**(`contextFilter`): `Record`\<`string`, `string`\>
+# Function: parseContextFilter
 
 Converts context filter token to context object
 Example: "language=en-US|territory=US" -\> { language: "en-US", territory: "US" }
 
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `contextFilter` | `string` |
-
-## Returns
+## Signature
 
-`Record`\<`string`, `string`\>
+```typescript
+function parseContextFilter(contextFilter: string): Record<string, string>
+```

package/docs/functions/parseQualifierDefaults.md

@@ -1,22 +1,12 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > parseQualifierDefaults
 
-***
-
-[@fgv/ts-web-extras](../README.md) / parseQualifierDefaults
-
-# Function: parseQualifierDefaults()
-
-> **parseQualifierDefaults**(`qualifierDefaults`): `Record`\<`string`, `string`[]\>
+# Function: parseQualifierDefaults
 
 Converts qualifier defaults token to structured format
 Example: "language=en-US,en-CA|territory=US" -\> { language: ["en-US", "en-CA"], territory: ["US"] }
 
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `qualifierDefaults` | `string` |
-
-## Returns
+## Signature
 
-`Record`\<`string`, `string`[]\>
+```typescript
+function parseQualifierDefaults(qualifierDefaults: string): Record<string, string[]>
+```

package/docs/functions/parseResourceTypes.md

@@ -1,22 +1,12 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > parseResourceTypes
 
-***
-
-[@fgv/ts-web-extras](../README.md) / parseResourceTypes
-
-# Function: parseResourceTypes()
-
-> **parseResourceTypes**(`resourceTypes`): `string`[]
+# Function: parseResourceTypes
 
 Converts resource types string to array
 Example: "json,string" -\> ["json", "string"]
 
-## Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `resourceTypes` | `string` |
-
-## Returns
+## Signature
 
-`string`[]
+```typescript
+function parseResourceTypes(resourceTypes: string): string[]
+```

package/docs/functions/parseUrlParameters.md

@@ -1,15 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > parseUrlParameters
 
-***
-
-[@fgv/ts-web-extras](../README.md) / parseUrlParameters
-
-# Function: parseUrlParameters()
-
-> **parseUrlParameters**(): [`IUrlConfigOptions`](../interfaces/IUrlConfigOptions.md)
+# Function: parseUrlParameters
 
 Parses URL parameters and extracts configuration options
 
-## Returns
+## Signature
 
-[`IUrlConfigOptions`](../interfaces/IUrlConfigOptions.md)
+```typescript
+function parseUrlParameters(): IUrlConfigOptions
+```

package/docs/functions/safeShowDirectoryPicker.md

@@ -1,24 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > safeShowDirectoryPicker
 
-***
-
-[@fgv/ts-web-extras](../README.md) / safeShowDirectoryPicker
-
-# Function: safeShowDirectoryPicker()
-
-> **safeShowDirectoryPicker**(`window`, `options?`): `Promise`\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `null`\>
+# Function: safeShowDirectoryPicker
 
 Safely access showDirectoryPicker with proper type checking
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `window` | `Window` | The window object |
-| `options?` | [`ShowDirectoryPickerOptions`](../interfaces/ShowDirectoryPickerOptions.md) | Options for the directory picker |
-
-## Returns
-
-`Promise`\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `null`\>
+## Signature
 
-Promise with directory handle or null if not supported
+```typescript
+function safeShowDirectoryPicker(window: Window, options: ShowDirectoryPickerOptions): Promise<FileSystemDirectoryHandle | null>
+```

package/docs/functions/safeShowOpenFilePicker.md

@@ -1,24 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > safeShowOpenFilePicker
 
-***
-
-[@fgv/ts-web-extras](../README.md) / safeShowOpenFilePicker
-
-# Function: safeShowOpenFilePicker()
-
-> **safeShowOpenFilePicker**(`window`, `options?`): `Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md)[] \| `null`\>
+# Function: safeShowOpenFilePicker
 
 Safely access showOpenFilePicker with proper type checking
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `window` | `Window` | The window object |
-| `options?` | [`ShowOpenFilePickerOptions`](../interfaces/ShowOpenFilePickerOptions.md) | Options for the file picker |
-
-## Returns
-
-`Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md)[] \| `null`\>
+## Signature
 
-Promise with file handles or null if not supported
+```typescript
+function safeShowOpenFilePicker(window: Window, options: ShowOpenFilePickerOptions): Promise<FileSystemFileHandle[] | null>
+```

package/docs/functions/safeShowSaveFilePicker.md

@@ -1,24 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > safeShowSaveFilePicker
 
-***
-
-[@fgv/ts-web-extras](../README.md) / safeShowSaveFilePicker
-
-# Function: safeShowSaveFilePicker()
-
-> **safeShowSaveFilePicker**(`window`, `options?`): `Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md) \| `null`\>
+# Function: safeShowSaveFilePicker
 
 Safely access showSaveFilePicker with proper type checking
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `window` | `Window` | The window object |
-| `options?` | [`ShowSaveFilePickerOptions`](../interfaces/ShowSaveFilePickerOptions.md) | Options for the file picker |
-
-## Returns
-
-`Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md) \| `null`\>
+## Signature
 
-Promise with file handle or null if not supported
+```typescript
+function safeShowSaveFilePicker(window: Window, options: ShowSaveFilePickerOptions): Promise<FileSystemFileHandle | null>
+```

package/docs/functions/supportsFileSystemAccess.md

@@ -1,23 +1,11 @@
-[**@fgv/ts-web-extras**](../README.md)
+[Home](../README.md) > supportsFileSystemAccess
 
-***
-
-[@fgv/ts-web-extras](../README.md) / supportsFileSystemAccess
-
-# Function: supportsFileSystemAccess()
-
-> **supportsFileSystemAccess**(`window`): `window is WindowWithFsAccess`
+# Function: supportsFileSystemAccess
 
 Type guard to check if the browser supports the File System Access API
 
-## Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `window` | `Window` | The window object to check |
-
-## Returns
-
-`window is WindowWithFsAccess`
+## Signature
 
-True if the window supports File System Access API
+```typescript
+function supportsFileSystemAccess(window: Window): window is WindowWithFsAccess
+```

package/docs/interfaces/FilePickerAcceptType.accept.md

@@ -0,0 +1,9 @@
+[Home](../README.md) > [FilePickerAcceptType](./FilePickerAcceptType.md) > accept
+
+## FilePickerAcceptType.accept property
+
+**Signature:**
+
+```typescript
+accept: Record<string, string | string[]>;
+```

package/docs/interfaces/FilePickerAcceptType.description.md

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

package/docs/interfaces/FilePickerAcceptType.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / FilePickerAcceptType
+[Home](../README.md) > FilePickerAcceptType
 
 # Interface: FilePickerAcceptType
 
@@ -10,7 +6,56 @@ File picker accept type
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="accept"></a> `accept` | `Record`\<`string`, `string` \| `string`[]\> |
-| <a id="description"></a> `description?` | `string` |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[description](./FilePickerAcceptType.description.md)
+
+</td><td>
+
+
+
+</td><td>
+
+string
+
+</td><td>
+
+
+
+</td></tr>
+<tr><td>
+
+[accept](./FilePickerAcceptType.accept.md)
+
+</td><td>
+
+
+
+</td><td>
+
+Record&lt;string, string | string[]&gt;
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemCreateWritableOptions.keepExistingData.md

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

package/docs/interfaces/FileSystemCreateWritableOptions.md

@@ -1,8 +1,4 @@
-[**@fgv/ts-web-extras**](../README.md)
-
-***
-
-[@fgv/ts-web-extras](../README.md) / FileSystemCreateWritableOptions
+[Home](../README.md) > FileSystemCreateWritableOptions
 
 # Interface: FileSystemCreateWritableOptions
 
@@ -10,6 +6,39 @@ Options for creating writable file streams
 
 ## Properties
 
-| Property | Type |
-| ------ | ------ |
-| <a id="keepexistingdata"></a> `keepExistingData?` | `boolean` |
+<table><thead><tr><th>
+
+Property
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody>
+<tr><td>
+
+[keepExistingData](./FileSystemCreateWritableOptions.keepExistingData.md)
+
+</td><td>
+
+
+
+</td><td>
+
+boolean
+
+</td><td>
+
+
+
+</td></tr>
+</tbody></table>

package/docs/interfaces/FileSystemDirectoryHandle._asyncIterator_.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > [asyncIterator]
+
+## FileSystemDirectoryHandle.[asyncIterator]() method
+
+**Signature:**
+
+```typescript
+[asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle]>;
+```
+
+**Returns:**
+
+AsyncIterableIterator&lt;[string, [FileSystemHandle](FileSystemHandle.md)]&gt;

package/docs/interfaces/FileSystemDirectoryHandle.entries.md

@@ -0,0 +1,13 @@
+[Home](../README.md) > [FileSystemDirectoryHandle](./FileSystemDirectoryHandle.md) > entries
+
+## FileSystemDirectoryHandle.entries() method
+
+**Signature:**
+
+```typescript
+entries(): AsyncIterableIterator<[string, FileSystemHandle]>;
+```
+
+**Returns:**
+
+AsyncIterableIterator&lt;[string, [FileSystemHandle](FileSystemHandle.md)]&gt;