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

package/docs/functions/parseResourceTypes.md

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

package/docs/functions/parseUrlParameters.md

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

package/docs/functions/safeShowDirectoryPicker.md

@@ -0,0 +1,24 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / safeShowDirectoryPicker
+
+# Function: safeShowDirectoryPicker()
+
+> **safeShowDirectoryPicker**(`window`, `options?`): `Promise`\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `null`\>
+
+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`\>
+
+Promise with directory handle or null if not supported

package/docs/functions/safeShowOpenFilePicker.md

@@ -0,0 +1,24 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / safeShowOpenFilePicker
+
+# Function: safeShowOpenFilePicker()
+
+> **safeShowOpenFilePicker**(`window`, `options?`): `Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md)[] \| `null`\>
+
+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`\>
+
+Promise with file handles or null if not supported

package/docs/functions/safeShowSaveFilePicker.md

@@ -0,0 +1,24 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / safeShowSaveFilePicker
+
+# Function: safeShowSaveFilePicker()
+
+> **safeShowSaveFilePicker**(`window`, `options?`): `Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md) \| `null`\>
+
+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`\>
+
+Promise with file handle or null if not supported

package/docs/functions/supportsFileSystemAccess.md

@@ -0,0 +1,23 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / supportsFileSystemAccess
+
+# Function: supportsFileSystemAccess()
+
+> **supportsFileSystemAccess**(`window`): `window is WindowWithFsAccess`
+
+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`
+
+True if the window supports File System Access API

package/docs/interfaces/FilePickerAcceptType.md

@@ -0,0 +1,16 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FilePickerAcceptType
+
+# Interface: FilePickerAcceptType
+
+File picker accept type
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="accept"></a> `accept` | `Record`\<`string`, `string` \| `string`[]\> |
+| <a id="description"></a> `description?` | `string` |

package/docs/interfaces/FileSystemCreateWritableOptions.md

@@ -0,0 +1,15 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemCreateWritableOptions
+
+# Interface: FileSystemCreateWritableOptions
+
+Options for creating writable file streams
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="keepexistingdata"></a> `keepExistingData?` | `boolean` |

package/docs/interfaces/FileSystemDirectoryHandle.md

@@ -0,0 +1,187 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemDirectoryHandle
+
+# Interface: FileSystemDirectoryHandle
+
+Directory handle interface
+
+## Extends
+
+- [`FileSystemHandle`](FileSystemHandle.md)
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="kind"></a> `kind` | `readonly` | `"directory"` |
+| <a id="name"></a> `name` | `readonly` | `string` |
+
+## Methods
+
+### \[asyncIterator\]()
+
+> **\[asyncIterator\]**(): `AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
+
+#### Returns
+
+`AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
+
+***
+
+### entries()
+
+> **entries**(): `AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
+
+#### Returns
+
+`AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
+
+***
+
+### getDirectoryHandle()
+
+> **getDirectoryHandle**(`name`, `options?`): `Promise`\<`FileSystemDirectoryHandle`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `options?` | [`FileSystemGetDirectoryOptions`](FileSystemGetDirectoryOptions.md) |
+
+#### Returns
+
+`Promise`\<`FileSystemDirectoryHandle`\>
+
+***
+
+### getFileHandle()
+
+> **getFileHandle**(`name`, `options?`): `Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `options?` | [`FileSystemGetFileOptions`](FileSystemGetFileOptions.md) |
+
+#### Returns
+
+`Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
+
+***
+
+### isSameEntry()
+
+> **isSameEntry**(`other`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `other` | [`FileSystemHandle`](FileSystemHandle.md) |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Inherited from
+
+[`FileSystemHandle`](FileSystemHandle.md).[`isSameEntry`](FileSystemHandle.md#issameentry)
+
+***
+
+### keys()
+
+> **keys**(): `AsyncIterableIterator`\<`string`\>
+
+#### Returns
+
+`AsyncIterableIterator`\<`string`\>
+
+***
+
+### queryPermission()
+
+> **queryPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
+
+#### Returns
+
+`Promise`\<`PermissionState`\>
+
+#### Inherited from
+
+[`FileSystemHandle`](FileSystemHandle.md).[`queryPermission`](FileSystemHandle.md#querypermission)
+
+***
+
+### removeEntry()
+
+> **removeEntry**(`name`, `options?`): `Promise`\<`void`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `name` | `string` |
+| `options?` | [`FileSystemRemoveOptions`](FileSystemRemoveOptions.md) |
+
+#### Returns
+
+`Promise`\<`void`\>
+
+***
+
+### requestPermission()
+
+> **requestPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
+
+#### Returns
+
+`Promise`\<`PermissionState`\>
+
+#### Inherited from
+
+[`FileSystemHandle`](FileSystemHandle.md).[`requestPermission`](FileSystemHandle.md#requestpermission)
+
+***
+
+### resolve()
+
+> **resolve**(`possibleDescendant`): `Promise`\<`string`[] \| `null`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `possibleDescendant` | [`FileSystemHandle`](FileSystemHandle.md) |
+
+#### Returns
+
+`Promise`\<`string`[] \| `null`\>
+
+***
+
+### values()
+
+> **values**(): `AsyncIterableIterator`\<[`FileSystemHandle`](FileSystemHandle.md)\>
+
+#### Returns
+
+`AsyncIterableIterator`\<[`FileSystemHandle`](FileSystemHandle.md)\>

package/docs/interfaces/FileSystemFileHandle.md

@@ -0,0 +1,106 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemFileHandle
+
+# Interface: FileSystemFileHandle
+
+File handle interface
+
+## Extends
+
+- [`FileSystemHandle`](FileSystemHandle.md)
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="kind"></a> `kind` | `readonly` | `"file"` |
+| <a id="name"></a> `name` | `readonly` | `string` |
+
+## Methods
+
+### createWritable()
+
+> **createWritable**(`options?`): `Promise`\<[`FileSystemWritableFileStream`](FileSystemWritableFileStream.md)\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options?` | [`FileSystemCreateWritableOptions`](FileSystemCreateWritableOptions.md) |
+
+#### Returns
+
+`Promise`\<[`FileSystemWritableFileStream`](FileSystemWritableFileStream.md)\>
+
+***
+
+### getFile()
+
+> **getFile**(): `Promise`\<`File`\>
+
+#### Returns
+
+`Promise`\<`File`\>
+
+***
+
+### isSameEntry()
+
+> **isSameEntry**(`other`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `other` | [`FileSystemHandle`](FileSystemHandle.md) |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+#### Inherited from
+
+[`FileSystemHandle`](FileSystemHandle.md).[`isSameEntry`](FileSystemHandle.md#issameentry)
+
+***
+
+### queryPermission()
+
+> **queryPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
+
+#### Returns
+
+`Promise`\<`PermissionState`\>
+
+#### Inherited from
+
+[`FileSystemHandle`](FileSystemHandle.md).[`queryPermission`](FileSystemHandle.md#querypermission)
+
+***
+
+### requestPermission()
+
+> **requestPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
+
+#### Returns
+
+`Promise`\<`PermissionState`\>
+
+#### Inherited from
+
+[`FileSystemHandle`](FileSystemHandle.md).[`requestPermission`](FileSystemHandle.md#requestpermission)

package/docs/interfaces/FileSystemGetDirectoryOptions.md

@@ -0,0 +1,15 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemGetDirectoryOptions
+
+# Interface: FileSystemGetDirectoryOptions
+
+Options for getting directory handles
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="create"></a> `create?` | `boolean` |

package/docs/interfaces/FileSystemGetFileOptions.md

@@ -0,0 +1,15 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemGetFileOptions
+
+# Interface: FileSystemGetFileOptions
+
+Options for getting file handles
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="create"></a> `create?` | `boolean` |

package/docs/interfaces/FileSystemHandle.md

@@ -0,0 +1,69 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemHandle
+
+# Interface: FileSystemHandle
+
+Base interface for file system handles
+
+## Extended by
+
+- [`FileSystemFileHandle`](FileSystemFileHandle.md)
+- [`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)
+
+## Properties
+
+| Property | Modifier | Type |
+| ------ | ------ | ------ |
+| <a id="kind"></a> `kind` | `readonly` | `"file"` \| `"directory"` |
+| <a id="name"></a> `name` | `readonly` | `string` |
+
+## Methods
+
+### isSameEntry()
+
+> **isSameEntry**(`other`): `Promise`\<`boolean`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `other` | `FileSystemHandle` |
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+***
+
+### queryPermission()
+
+> **queryPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
+
+#### Returns
+
+`Promise`\<`PermissionState`\>
+
+***
+
+### requestPermission()
+
+> **requestPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
+
+#### Returns
+
+`Promise`\<`PermissionState`\>

package/docs/interfaces/FileSystemHandlePermissionDescriptor.md

@@ -0,0 +1,15 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemHandlePermissionDescriptor
+
+# Interface: FileSystemHandlePermissionDescriptor
+
+Permission descriptor for file system handles
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="mode"></a> `mode?` | `"readwrite"` \| `"read"` |

package/docs/interfaces/FileSystemRemoveOptions.md

@@ -0,0 +1,15 @@
+[**@fgv/ts-web-extras**](../README.md)
+
+***
+
+[@fgv/ts-web-extras](../README.md) / FileSystemRemoveOptions
+
+# Interface: FileSystemRemoveOptions
+
+Options for removing entries
+
+## Properties
+
+| Property | Type |
+| ------ | ------ |
+| <a id="recursive"></a> `recursive?` | `boolean` |