@fgv/ts-web-extras 5.0.0

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

@@ -0,0 +1,114 @@
+<!-- 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; [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md)
+
+## FileApiTreeAccessors class
+
+Helper class to create FileTree instances from various file sources. Supports File API (FileList) and File System Access API handles.
+
+**Signature:**
+
+```typescript
+export declare class FileApiTreeAccessors<TCT extends string = string> 
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[create(initializers, params)](./ts-web-extras.fileapitreeaccessors.create.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Create FileTree from various file sources using TreeInitializer array.
+
+
+</td></tr>
+<tr><td>
+
+[extractFileMetadata(file)](./ts-web-extras.fileapitreeaccessors.extractfilemetadata.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Extract file metadata from a File.
+
+
+</td></tr>
+<tr><td>
+
+[fromDirectoryUpload(fileList, params)](./ts-web-extras.fileapitreeaccessors.fromdirectoryupload.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Create FileTree from directory upload with webkitRelativePath.
+
+
+</td></tr>
+<tr><td>
+
+[fromFileList(fileList, params)](./ts-web-extras.fileapitreeaccessors.fromfilelist.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Create FileTree from FileList (e.g., from input\[type="file"\]).
+
+
+</td></tr>
+<tr><td>
+
+[getOriginalFile(fileList, targetPath)](./ts-web-extras.fileapitreeaccessors.getoriginalfile.md)
+
+
+</td><td>
+
+`static`
+
+
+</td><td>
+
+Get the File object for a specific path from the original FileList. This is useful for accessing the original File API object for operations like getting file metadata, MIME type, etc.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.filepickeraccepttype.accept.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; [FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md) &gt; [accept](./ts-web-extras.filepickeraccepttype.accept.md)
+
+## FilePickerAcceptType.accept property
+
+**Signature:**
+
+```typescript
+accept: Record<string, string | string[]>;
+```

package/docs/ts-web-extras.filepickeraccepttype.description.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; [FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md) &gt; [description](./ts-web-extras.filepickeraccepttype.description.md)
+
+## FilePickerAcceptType.description property
+
+**Signature:**
+
+```typescript
+description?: string;
+```

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

@@ -0,0 +1,75 @@
+<!-- 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; [FilePickerAcceptType](./ts-web-extras.filepickeraccepttype.md)
+
+## FilePickerAcceptType interface
+
+File picker accept type
+
+**Signature:**
+
+```typescript
+export interface FilePickerAcceptType 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[accept](./ts-web-extras.filepickeraccepttype.accept.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Record&lt;string, string \| string\[\]&gt;
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[description?](./ts-web-extras.filepickeraccepttype.description.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.filesystemcreatewritableoptions_2.keepexistingdata.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; [FileSystemCreateWritableOptions\_2](./ts-web-extras.filesystemcreatewritableoptions_2.md) &gt; [keepExistingData](./ts-web-extras.filesystemcreatewritableoptions_2.keepexistingdata.md)
+
+## FileSystemCreateWritableOptions\_2.keepExistingData property
+
+**Signature:**
+
+```typescript
+keepExistingData?: boolean;
+```

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

@@ -0,0 +1,58 @@
+<!-- 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; [FileSystemCreateWritableOptions\_2](./ts-web-extras.filesystemcreatewritableoptions_2.md)
+
+## FileSystemCreateWritableOptions\_2 interface
+
+Options for creating writable file streams
+
+**Signature:**
+
+```typescript
+export interface FileSystemCreateWritableOptions 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[keepExistingData?](./ts-web-extras.filesystemcreatewritableoptions_2.keepexistingdata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2._symbol.asynciterator_.md

@@ -0,0 +1,15 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [\[Symbol.asyncIterator\]](./ts-web-extras.filesystemdirectoryhandle_2._symbol.asynciterator_.md)
+
+## FileSystemDirectoryHandle\_2.\[Symbol.asyncIterator\]() method
+
+**Signature:**
+
+```typescript
+[Symbol.asyncIterator](): AsyncIterableIterator<[string, FileSystemHandle]>;
+```
+**Returns:**
+
+AsyncIterableIterator&lt;\[string, [FileSystemHandle](./ts-web-extras.filesystemhandle_2.md)<!-- -->\]&gt;
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2.entries.md

@@ -0,0 +1,15 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [entries](./ts-web-extras.filesystemdirectoryhandle_2.entries.md)
+
+## FileSystemDirectoryHandle\_2.entries() method
+
+**Signature:**
+
+```typescript
+entries(): AsyncIterableIterator<[string, FileSystemHandle]>;
+```
+**Returns:**
+
+AsyncIterableIterator&lt;\[string, [FileSystemHandle](./ts-web-extras.filesystemhandle_2.md)<!-- -->\]&gt;
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2.getdirectoryhandle.md

@@ -0,0 +1,66 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [getDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.getdirectoryhandle.md)
+
+## FileSystemDirectoryHandle\_2.getDirectoryHandle() method
+
+**Signature:**
+
+```typescript
+getDirectoryHandle(name: string, options?: FileSystemGetDirectoryOptions): Promise<FileSystemDirectoryHandle>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[FileSystemGetDirectoryOptions](./ts-web-extras.filesystemgetdirectoryoptions_2.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)<!-- -->&gt;
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2.getfilehandle.md

@@ -0,0 +1,66 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [getFileHandle](./ts-web-extras.filesystemdirectoryhandle_2.getfilehandle.md)
+
+## FileSystemDirectoryHandle\_2.getFileHandle() method
+
+**Signature:**
+
+```typescript
+getFileHandle(name: string, options?: FileSystemGetFileOptions): Promise<FileSystemFileHandle>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[FileSystemGetFileOptions](./ts-web-extras.filesystemgetfileoptions_2.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;[FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->&gt;
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2.keys.md

@@ -0,0 +1,15 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [keys](./ts-web-extras.filesystemdirectoryhandle_2.keys.md)
+
+## FileSystemDirectoryHandle\_2.keys() method
+
+**Signature:**
+
+```typescript
+keys(): AsyncIterableIterator<string>;
+```
+**Returns:**
+
+AsyncIterableIterator&lt;string&gt;
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2.kind.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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [kind](./ts-web-extras.filesystemdirectoryhandle_2.kind.md)
+
+## FileSystemDirectoryHandle\_2.kind property
+
+**Signature:**
+
+```typescript
+readonly kind: 'directory';
+```

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

@@ -0,0 +1,146 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md)
+
+## FileSystemDirectoryHandle\_2 interface
+
+Directory handle interface
+
+**Signature:**
+
+```typescript
+export interface FileSystemDirectoryHandle extends FileSystemHandle 
+```
+**Extends:** [FileSystemHandle](./ts-web-extras.filesystemhandle_2.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[kind](./ts-web-extras.filesystemdirectoryhandle_2.kind.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+'directory'
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[\[Symbol.asyncIterator\]()](./ts-web-extras.filesystemdirectoryhandle_2._symbol.asynciterator_.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[entries()](./ts-web-extras.filesystemdirectoryhandle_2.entries.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getDirectoryHandle(name, options)](./ts-web-extras.filesystemdirectoryhandle_2.getdirectoryhandle.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getFileHandle(name, options)](./ts-web-extras.filesystemdirectoryhandle_2.getfilehandle.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[keys()](./ts-web-extras.filesystemdirectoryhandle_2.keys.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[removeEntry(name, options)](./ts-web-extras.filesystemdirectoryhandle_2.removeentry.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resolve(possibleDescendant)](./ts-web-extras.filesystemdirectoryhandle_2.resolve.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[values()](./ts-web-extras.filesystemdirectoryhandle_2.values.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.filesystemdirectoryhandle_2.removeentry.md

@@ -0,0 +1,66 @@
+<!-- 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; [FileSystemDirectoryHandle\_2](./ts-web-extras.filesystemdirectoryhandle_2.md) &gt; [removeEntry](./ts-web-extras.filesystemdirectoryhandle_2.removeentry.md)
+
+## FileSystemDirectoryHandle\_2.removeEntry() method
+
+**Signature:**
+
+```typescript
+removeEntry(name: string, options?: FileSystemRemoveOptions): Promise<void>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+name
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+options
+
+
+</td><td>
+
+[FileSystemRemoveOptions](./ts-web-extras.filesystemremoveoptions_2.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Promise&lt;void&gt;
+