@fgv/ts-web-extras 5.0.0

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

@@ -0,0 +1,102 @@
+<!-- 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; [FileTreeHelpers](./ts-web-extras.filetreehelpers.md)
+
+## FileTreeHelpers namespace
+
+## Functions
+
+<table><thead><tr><th>
+
+Function
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[extractFileListMetadata(fileList)](./ts-web-extras.filetreehelpers.extractfilelistmetadata.md)
+
+
+</td><td>
+
+Helper function to extract metadata from a `FileList`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[extractFileMetadata(file)](./ts-web-extras.filetreehelpers.extractfilemetadata.md)
+
+
+</td><td>
+
+Helper function to extract metadata from a `File`<!-- -->.
+
+
+</td></tr>
+<tr><td>
+
+[fromDirectoryUpload(fileList, params)](./ts-web-extras.filetreehelpers.fromdirectoryupload.md)
+
+
+</td><td>
+
+Helper function to create a new FileTree instance from a directory upload with webkitRelativePath support.
+
+
+</td></tr>
+<tr><td>
+
+[fromFileList(fileList, params)](./ts-web-extras.filetreehelpers.fromfilelist.md)
+
+
+</td><td>
+
+Helper function to create a new FileTree instance from a browser FileList (e.g., from input\[type="file"\]).
+
+
+</td></tr>
+<tr><td>
+
+[getOriginalFile(fileList, path)](./ts-web-extras.filetreehelpers.getoriginalfile.md)
+
+
+</td><td>
+
+Helper function to get the original File object from a FileList by path.
+
+
+</td></tr>
+</tbody></table>
+
+## Variables
+
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[defaultFileApiTreeInitParams](./ts-web-extras.filetreehelpers.defaultfileapitreeinitparams.md)
+
+
+</td><td>
+
+Default initialization parameters for a `FileTree` using [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md)<!-- -->.
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.idirectoryhandletreeinitializer.dirhandles.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; [IDirectoryHandleTreeInitializer](./ts-web-extras.idirectoryhandletreeinitializer.md) &gt; [dirHandles](./ts-web-extras.idirectoryhandletreeinitializer.dirhandles.md)
+
+## IDirectoryHandleTreeInitializer.dirHandles property
+
+**Signature:**
+
+```typescript
+readonly dirHandles: FileSystemDirectoryHandle[];
+```

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

@@ -0,0 +1,100 @@
+<!-- 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; [IDirectoryHandleTreeInitializer](./ts-web-extras.idirectoryhandletreeinitializer.md)
+
+## IDirectoryHandleTreeInitializer interface
+
+Tree initializer for File System Access API directory handles.
+
+**Signature:**
+
+```typescript
+export interface IDirectoryHandleTreeInitializer 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[dirHandles](./ts-web-extras.idirectoryhandletreeinitializer.dirhandles.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[FileSystemDirectoryHandle](./ts-web-extras.filesystemdirectoryhandle_2.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[nonRecursive?](./ts-web-extras.idirectoryhandletreeinitializer.nonrecursive.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[prefix?](./ts-web-extras.idirectoryhandletreeinitializer.prefix.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.idirectoryhandletreeinitializer.nonrecursive.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; [IDirectoryHandleTreeInitializer](./ts-web-extras.idirectoryhandletreeinitializer.md) &gt; [nonRecursive](./ts-web-extras.idirectoryhandletreeinitializer.nonrecursive.md)
+
+## IDirectoryHandleTreeInitializer.nonRecursive property
+
+**Signature:**
+
+```typescript
+readonly nonRecursive?: boolean;
+```

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

package/docs/ts-web-extras.ifilehandletreeinitializer.filehandles.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; [IFileHandleTreeInitializer](./ts-web-extras.ifilehandletreeinitializer.md) &gt; [fileHandles](./ts-web-extras.ifilehandletreeinitializer.filehandles.md)
+
+## IFileHandleTreeInitializer.fileHandles property
+
+**Signature:**
+
+```typescript
+readonly fileHandles: FileSystemFileHandle[];
+```

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

@@ -0,0 +1,79 @@
+<!-- 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; [IFileHandleTreeInitializer](./ts-web-extras.ifilehandletreeinitializer.md)
+
+## IFileHandleTreeInitializer interface
+
+Tree initializer for File System Access API file handles.
+
+**Signature:**
+
+```typescript
+export interface IFileHandleTreeInitializer 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fileHandles](./ts-web-extras.ifilehandletreeinitializer.filehandles.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+[FileSystemFileHandle](./ts-web-extras.filesystemfilehandle_2.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[prefix?](./ts-web-extras.ifilehandletreeinitializer.prefix.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

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

package/docs/ts-web-extras.ifilelisttreeinitializer.filelist.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; [IFileListTreeInitializer](./ts-web-extras.ifilelisttreeinitializer.md) &gt; [fileList](./ts-web-extras.ifilelisttreeinitializer.filelist.md)
+
+## IFileListTreeInitializer.fileList property
+
+**Signature:**
+
+```typescript
+readonly fileList: FileList;
+```

package/docs/ts-web-extras.ifilelisttreeinitializer.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; [IFileListTreeInitializer](./ts-web-extras.ifilelisttreeinitializer.md)
+
+## IFileListTreeInitializer interface
+
+Tree initializer for FileList objects (from File API).
+
+**Signature:**
+
+```typescript
+export interface IFileListTreeInitializer 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[fileList](./ts-web-extras.ifilelisttreeinitializer.filelist.md)
+
+
+</td><td>
+
+`readonly`
+
+
+</td><td>
+
+FileList
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/ts-web-extras.ifilemetadata.lastmodified.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; [IFileMetadata](./ts-web-extras.ifilemetadata.md) &gt; [lastModified](./ts-web-extras.ifilemetadata.lastmodified.md)
+
+## IFileMetadata.lastModified property
+
+**Signature:**
+
+```typescript
+lastModified: number;
+```

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

@@ -0,0 +1,124 @@
+<!-- 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; [IFileMetadata](./ts-web-extras.ifilemetadata.md)
+
+## IFileMetadata interface
+
+Interface for file metadata.
+
+**Signature:**
+
+```typescript
+export interface IFileMetadata 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[lastModified](./ts-web-extras.ifilemetadata.lastmodified.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[name](./ts-web-extras.ifilemetadata.name.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[path](./ts-web-extras.ifilemetadata.path.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[size](./ts-web-extras.ifilemetadata.size.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[type](./ts-web-extras.ifilemetadata.type.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

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

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

package/docs/ts-web-extras.ifilemetadata.size.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; [IFileMetadata](./ts-web-extras.ifilemetadata.md) &gt; [size](./ts-web-extras.ifilemetadata.size.md)
+
+## IFileMetadata.size property
+
+**Signature:**
+
+```typescript
+size: number;
+```

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

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

@@ -0,0 +1,56 @@
+<!-- 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; [IFsAccessApis](./ts-web-extras.ifsaccessapis.md)
+
+## IFsAccessApis interface
+
+File System Access API methods available on Window
+
+**Signature:**
+
+```typescript
+export interface IFsAccessApis 
+```
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[showDirectoryPicker(options)](./ts-web-extras.ifsaccessapis.showdirectorypicker.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[showOpenFilePicker(options)](./ts-web-extras.ifsaccessapis.showopenfilepicker.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[showSaveFilePicker(options)](./ts-web-extras.ifsaccessapis.showsavefilepicker.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+