@fgv/ts-web-extras 5.1.0-0 → 5.1.0-2

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

@@ -1,57 +0,0 @@
-<!-- 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; [FileSystemWritableFileStream\_2](./ts-web-extras.filesystemwritablefilestream_2.md)
-
-## FileSystemWritableFileStream\_2 interface
-
-Writable file stream interface
-
-**Signature:**
-
-```typescript
-export interface FileSystemWritableFileStream extends WritableStream 
-```
-**Extends:** WritableStream
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[seek(position)](./ts-web-extras.filesystemwritablefilestream_2.seek.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[truncate(size)](./ts-web-extras.filesystemwritablefilestream_2.truncate.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[write(data)](./ts-web-extras.filesystemwritablefilestream_2.write.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/ts-web-extras.filesystemwritablefilestream_2.seek.md

@@ -1,50 +0,0 @@
-<!-- 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; [FileSystemWritableFileStream\_2](./ts-web-extras.filesystemwritablefilestream_2.md) &gt; [seek](./ts-web-extras.filesystemwritablefilestream_2.seek.md)
-
-## FileSystemWritableFileStream\_2.seek() method
-
-**Signature:**
-
-```typescript
-seek(position: number): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-position
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/ts-web-extras.filesystemwritablefilestream_2.truncate.md

@@ -1,50 +0,0 @@
-<!-- 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; [FileSystemWritableFileStream\_2](./ts-web-extras.filesystemwritablefilestream_2.md) &gt; [truncate](./ts-web-extras.filesystemwritablefilestream_2.truncate.md)
-
-## FileSystemWritableFileStream\_2.truncate() method
-
-**Signature:**
-
-```typescript
-truncate(size: number): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-size
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

package/docs/ts-web-extras.filesystemwritablefilestream_2.write.md

@@ -1,50 +0,0 @@
-<!-- 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; [FileSystemWritableFileStream\_2](./ts-web-extras.filesystemwritablefilestream_2.md) &gt; [write](./ts-web-extras.filesystemwritablefilestream_2.write.md)
-
-## FileSystemWritableFileStream\_2.write() method
-
-**Signature:**
-
-```typescript
-write(data: BufferSource | Blob | string): Promise<void>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-data
-
-
-</td><td>
-
-BufferSource \| Blob \| string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;void&gt;
-

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

@@ -1,13 +0,0 @@
-<!-- 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) &gt; [defaultFileApiTreeInitParams](./ts-web-extras.filetreehelpers.defaultfileapitreeinitparams.md)
-
-## FileTreeHelpers.defaultFileApiTreeInitParams variable
-
-Default initialization parameters for a `FileTree` using [FileApiTreeAccessors](./ts-web-extras.fileapitreeaccessors.md)<!-- -->.
-
-**Signature:**
-
-```typescript
-defaultFileApiTreeInitParams: FileTree.IFileTreeInitParams<string>
-```

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

@@ -1,56 +0,0 @@
-<!-- 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) &gt; [extractFileListMetadata](./ts-web-extras.filetreehelpers.extractfilelistmetadata.md)
-
-## FileTreeHelpers.extractFileListMetadata() function
-
-Helper function to extract metadata from a `FileList`<!-- -->.
-
-**Signature:**
-
-```typescript
-export declare function extractFileListMetadata(fileList: FileList): Array<IFileMetadata>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fileList
-
-
-</td><td>
-
-FileList
-
-
-</td><td>
-
-The `FileList` to extract metadata from
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Array&lt;[IFileMetadata](./ts-web-extras.ifilemetadata.md)<!-- -->&gt;
-
-Array of [file metadata](./ts-web-extras.ifilemetadata.md) objects
-

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

@@ -1,56 +0,0 @@
-<!-- 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) &gt; [extractFileMetadata](./ts-web-extras.filetreehelpers.extractfilemetadata.md)
-
-## FileTreeHelpers.extractFileMetadata() function
-
-Helper function to extract metadata from a `File`<!-- -->.
-
-**Signature:**
-
-```typescript
-export declare function extractFileMetadata(file: File): IFileMetadata;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-file
-
-
-</td><td>
-
-File
-
-
-</td><td>
-
-The File to extract metadata from
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-[IFileMetadata](./ts-web-extras.ifilemetadata.md)
-
-[file metadata](./ts-web-extras.ifilemetadata.md) object
-

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

@@ -1,76 +0,0 @@
-<!-- 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) &gt; [fromDirectoryUpload](./ts-web-extras.filetreehelpers.fromdirectoryupload.md)
-
-## FileTreeHelpers.fromDirectoryUpload() function
-
-Helper function to create a new FileTree instance from a directory upload with webkitRelativePath support.
-
-**Signature:**
-
-```typescript
-export declare function fromDirectoryUpload(fileList: FileList, params?: FileTree.IFileTreeInitParams<string>): Promise<Result<FileTree.FileTree<string>>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fileList
-
-
-</td><td>
-
-FileList
-
-
-</td><td>
-
-FileList from a directory upload (input with webkitdirectory)
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-FileTree.IFileTreeInitParams&lt;string&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree.FileTree&lt;string&gt;&gt;&gt;
-
-Promise resolving to a successful Result with the new FileTree instance if successful, or a failed Result with an error message otherwise
-
-## Remarks
-
-The content type of the files is always `string` and the default accept contentType function (`FileTree.FileItem.defaultAcceptContentType`<!-- -->) is is used, so content type is derived from the mime type of the file, when available.
-

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

@@ -1,76 +0,0 @@
-<!-- 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) &gt; [fromFileList](./ts-web-extras.filetreehelpers.fromfilelist.md)
-
-## FileTreeHelpers.fromFileList() function
-
-Helper function to create a new FileTree instance from a browser FileList (e.g., from input\[type="file"\]).
-
-**Signature:**
-
-```typescript
-export declare function fromFileList(fileList: FileList, params?: FileTree.IFileTreeInitParams<string>): Promise<Result<FileTree.FileTree<string>>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fileList
-
-
-</td><td>
-
-FileList
-
-
-</td><td>
-
-FileList from a file input element
-
-
-</td></tr>
-<tr><td>
-
-params
-
-
-</td><td>
-
-FileTree.IFileTreeInitParams&lt;string&gt;
-
-
-</td><td>
-
-_(Optional)_ Optional `IFileTreeInitParams` for the file tree.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;Result&lt;FileTree.FileTree&lt;string&gt;&gt;&gt;
-
-Promise resolving to a successful Result with the new FileTree instance if successful, or a failed Result with an error message otherwise
-
-## Remarks
-
-The content type of the files is always `string` and the default accept contentType function (`FileTree.FileItem.defaultAcceptContentType`<!-- -->) is used, so content type is derived from the mime type of the file, when available.
-

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

@@ -1,72 +0,0 @@
-<!-- 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) &gt; [getOriginalFile](./ts-web-extras.filetreehelpers.getoriginalfile.md)
-
-## FileTreeHelpers.getOriginalFile() function
-
-Helper function to get the original File object from a FileList by path.
-
-**Signature:**
-
-```typescript
-export declare function getOriginalFile(fileList: FileList, path: string): Result<File>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-fileList
-
-
-</td><td>
-
-FileList
-
-
-</td><td>
-
-The original FileList
-
-
-</td></tr>
-<tr><td>
-
-path
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The path to the file
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Result&lt;File&gt;
-
-A successful Result with the File object if found, or a failed Result with an error message otherwise
-

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

@@ -1,102 +0,0 @@
-<!-- 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

@@ -1,11 +0,0 @@
-<!-- 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[];
-```