@fgv/ts-web-extras 5.0.0

package/docs/ts-web-extras.safeshowdirectorypicker.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [safeShowDirectoryPicker](./ts-web-extras.safeshowdirectorypicker.md)
+
+## safeShowDirectoryPicker() function
+
+Safely access showDirectoryPicker with proper type checking
+
+**Signature:**
+
+```typescript
+export declare function safeShowDirectoryPicker(window: Window, options?: ShowDirectoryPickerOptions): Promise<FileSystemDirectoryHandle | null>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+window
+
+
+</td><td>
+
+Window
+
+
+</td><td>
+
+The window object
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[ShowDirectoryPickerOptions](./ts-web-extras.showdirectorypickeroptions.md)
+
+
+</td><td>
+
+_(Optional)_ Options for the directory picker
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md) \| null&gt;
+
+Promise with directory handle or null if not supported
+

package/docs/ts-web-extras.safeshowopenfilepicker.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [safeShowOpenFilePicker](./ts-web-extras.safeshowopenfilepicker.md)
+
+## safeShowOpenFilePicker() function
+
+Safely access showOpenFilePicker with proper type checking
+
+**Signature:**
+
+```typescript
+export declare function safeShowOpenFilePicker(window: Window, options?: ShowOpenFilePickerOptions): Promise<FileSystemFileHandle[] | null>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+window
+
+
+</td><td>
+
+Window
+
+
+</td><td>
+
+The window object
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md)
+
+
+</td><td>
+
+_(Optional)_ Options for the file picker
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->\[\] \| null&gt;
+
+Promise with file handles or null if not supported
+

package/docs/ts-web-extras.safeshowsavefilepicker.md

@@ -0,0 +1,72 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [safeShowSaveFilePicker](./ts-web-extras.safeshowsavefilepicker.md)
+
+## safeShowSaveFilePicker() function
+
+Safely access showSaveFilePicker with proper type checking
+
+**Signature:**
+
+```typescript
+export declare function safeShowSaveFilePicker(window: Window, options?: ShowSaveFilePickerOptions): Promise<FileSystemFileHandle | null>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+window
+
+
+</td><td>
+
+Window
+
+
+</td><td>
+
+The window object
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md)
+
+
+</td><td>
+
+_(Optional)_ Options for the file picker
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md) \| null&gt;
+
+Promise with file handle or null if not supported
+

package/docs/ts-web-extras.showdirectorypickeroptions.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowDirectoryPickerOptions](./ts-web-extras.showdirectorypickeroptions.md) &gt; [id](./ts-web-extras.showdirectorypickeroptions.id.md)
+
+## ShowDirectoryPickerOptions.id property
+
+**Signature:**
+
+```typescript
+id?: string;
+```

package/docs/ts-web-extras.showdirectorypickeroptions.md

@@ -0,0 +1,96 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowDirectoryPickerOptions](./ts-web-extras.showdirectorypickeroptions.md)
+
+## ShowDirectoryPickerOptions interface
+
+Directory picker options
+
+**Signature:**
+
+```typescript
+export interface ShowDirectoryPickerOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[id?](./ts-web-extras.showdirectorypickeroptions.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[mode?](./ts-web-extras.showdirectorypickeroptions.mode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+'read' \| 'readwrite'
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[startIn?](./ts-web-extras.showdirectorypickeroptions.startin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FileSystemHandle](./ts-web-extras.filesystemhandle_2.md) \| [WellKnownDirectory](./ts-web-extras.wellknowndirectory.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.showdirectorypickeroptions.mode.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowDirectoryPickerOptions](./ts-web-extras.showdirectorypickeroptions.md) &gt; [mode](./ts-web-extras.showdirectorypickeroptions.mode.md)
+
+## ShowDirectoryPickerOptions.mode property
+
+**Signature:**
+
+```typescript
+mode?: 'read' | 'readwrite';
+```

package/docs/ts-web-extras.showdirectorypickeroptions.startin.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowDirectoryPickerOptions](./ts-web-extras.showdirectorypickeroptions.md) &gt; [startIn](./ts-web-extras.showdirectorypickeroptions.startin.md)
+
+## ShowDirectoryPickerOptions.startIn property
+
+**Signature:**
+
+```typescript
+startIn?: FileSystemHandle | WellKnownDirectory;
+```

package/docs/ts-web-extras.showopenfilepickeroptions.excludeacceptalloption.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md) &gt; [excludeAcceptAllOption](./ts-web-extras.showopenfilepickeroptions.excludeacceptalloption.md)
+
+## ShowOpenFilePickerOptions.excludeAcceptAllOption property
+
+**Signature:**
+
+```typescript
+excludeAcceptAllOption?: boolean;
+```

package/docs/ts-web-extras.showopenfilepickeroptions.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md) &gt; [id](./ts-web-extras.showopenfilepickeroptions.id.md)
+
+## ShowOpenFilePickerOptions.id property
+
+**Signature:**
+
+```typescript
+id?: string;
+```

package/docs/ts-web-extras.showopenfilepickeroptions.md

@@ -0,0 +1,134 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md)
+
+## ShowOpenFilePickerOptions interface
+
+File picker options
+
+**Signature:**
+
+```typescript
+export interface ShowOpenFilePickerOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[excludeAcceptAllOption?](./ts-web-extras.showopenfilepickeroptions.excludeacceptalloption.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[id?](./ts-web-extras.showopenfilepickeroptions.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[multiple?](./ts-web-extras.showopenfilepickeroptions.multiple.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[startIn?](./ts-web-extras.showopenfilepickeroptions.startin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FileSystemHandle](./ts-web-extras.filesystemhandle_2.md) \| [WellKnownDirectory](./ts-web-extras.wellknowndirectory.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[types?](./ts-web-extras.showopenfilepickeroptions.types.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md)<!-- -->\[\]
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.showopenfilepickeroptions.multiple.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md) &gt; [multiple](./ts-web-extras.showopenfilepickeroptions.multiple.md)
+
+## ShowOpenFilePickerOptions.multiple property
+
+**Signature:**
+
+```typescript
+multiple?: boolean;
+```

package/docs/ts-web-extras.showopenfilepickeroptions.startin.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md) &gt; [startIn](./ts-web-extras.showopenfilepickeroptions.startin.md)
+
+## ShowOpenFilePickerOptions.startIn property
+
+**Signature:**
+
+```typescript
+startIn?: FileSystemHandle | WellKnownDirectory;
+```

package/docs/ts-web-extras.showopenfilepickeroptions.types.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowOpenFilePickerOptions](./ts-web-extras.showopenfilepickeroptions.md) &gt; [types](./ts-web-extras.showopenfilepickeroptions.types.md)
+
+## ShowOpenFilePickerOptions.types property
+
+**Signature:**
+
+```typescript
+types?: FilePickerAcceptType[];
+```

package/docs/ts-web-extras.showsavefilepickeroptions.excludeacceptalloption.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md) &gt; [excludeAcceptAllOption](./ts-web-extras.showsavefilepickeroptions.excludeacceptalloption.md)
+
+## ShowSaveFilePickerOptions.excludeAcceptAllOption property
+
+**Signature:**
+
+```typescript
+excludeAcceptAllOption?: boolean;
+```

package/docs/ts-web-extras.showsavefilepickeroptions.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md) &gt; [id](./ts-web-extras.showsavefilepickeroptions.id.md)
+
+## ShowSaveFilePickerOptions.id property
+
+**Signature:**
+
+```typescript
+id?: string;
+```

package/docs/ts-web-extras.showsavefilepickeroptions.md

@@ -0,0 +1,134 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@fgv/ts-web-extras](./ts-web-extras.md) &gt; [ShowSaveFilePickerOptions](./ts-web-extras.showsavefilepickeroptions.md)
+
+## ShowSaveFilePickerOptions interface
+
+Save file picker options
+
+**Signature:**
+
+```typescript
+export interface ShowSaveFilePickerOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[excludeAcceptAllOption?](./ts-web-extras.showsavefilepickeroptions.excludeacceptalloption.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[id?](./ts-web-extras.showsavefilepickeroptions.id.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[startIn?](./ts-web-extras.showsavefilepickeroptions.startin.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FileSystemHandle](./ts-web-extras.filesystemhandle_2.md) \| [WellKnownDirectory](./ts-web-extras.wellknowndirectory.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[suggestedName?](./ts-web-extras.showsavefilepickeroptions.suggestedname.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[types?](./ts-web-extras.showsavefilepickeroptions.types.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md)<!-- -->\[\]
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+