npm - @fgv/ts-web-extras - Versions diffs - 5.1.0-3 → 5.1.0-4 - Mend

@fgv/ts-web-extras 5.1.0-3 → 5.1.0-4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (255) hide show

package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileListMetadata.md DELETED Viewed

@@ -1,23 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-***
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / extractFileListMetadata
-# Function: extractFileListMetadata()
-> **extractFileListMetadata**(`fileList`): [`IFileMetadata`](../../../../interfaces/IFileMetadata.md)[]
-Helper function to extract metadata from a `FileList`.
-## Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | The `FileList` to extract metadata from |
-## Returns
-[`IFileMetadata`](../../../../interfaces/IFileMetadata.md)[]
-Array of [file metadata](../../../../interfaces/IFileMetadata.md) objects

package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileMetadata.md DELETED Viewed

@@ -1,23 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-***
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / extractFileMetadata
-# Function: extractFileMetadata()
-> **extractFileMetadata**(`file`): [`IFileMetadata`](../../../../interfaces/IFileMetadata.md)
-Helper function to extract metadata from a `File`.
-## Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `file` | `File` | The File to extract metadata from |
-## Returns
-[`IFileMetadata`](../../../../interfaces/IFileMetadata.md)
-[file metadata](../../../../interfaces/IFileMetadata.md) object

package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromDirectoryUpload.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-***
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / fromDirectoryUpload
-# Function: fromDirectoryUpload()
-> **fromDirectoryUpload**(`fileList`, `params?`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-Helper function to create a new FileTree instance
-from a directory upload with webkitRelativePath support.
-## Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | FileList from a directory upload (input with webkitdirectory) |
-| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\> | Optional `IFileTreeInitParams` for the file tree. |
-## Returns
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-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/@fgv/namespaces/FileTreeHelpers/functions/fromFileList.md DELETED Viewed

@@ -1,33 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-***
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / fromFileList
-# Function: fromFileList()
-> **fromFileList**(`fileList`, `params?`): `Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-Helper function to create a new FileTree instance
-from a browser FileList (e.g., from input[type="file"]).
-## Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | FileList from a file input element |
-| `params?` | [`IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\> | Optional `IFileTreeInitParams` for the file tree. |
-## Returns
-`Promise`\<[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<[`FileTree_2`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>\>\>
-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/@fgv/namespaces/FileTreeHelpers/functions/getOriginalFile.md DELETED Viewed

@@ -1,25 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-***
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / getOriginalFile
-# Function: getOriginalFile()
-> **getOriginalFile**(`fileList`, `path`): [`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`File`\>
-Helper function to get the original File object from a FileList by path.
-## Parameters
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `fileList` | `FileList` | The original FileList |
-| `path` | `string` | The path to the file |
-## Returns
-[`Result`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils/docs)\<`File`\>
-A successful Result with the File object if found,
-or a failed Result with an error message otherwise

package/docs/@fgv/namespaces/FileTreeHelpers/variables/defaultFileApiTreeInitParams.md DELETED Viewed

@@ -1,11 +0,0 @@
-[**@fgv/ts-web-extras**](../../../../README.md)
-***
-[@fgv/ts-web-extras](../../../../README.md) / [FileTreeHelpers](../README.md) / defaultFileApiTreeInitParams
-# Variable: defaultFileApiTreeInitParams
-> `const` **defaultFileApiTreeInitParams**: [`FileTree.IFileTreeInitParams`](https://github.com/ErikFortune/fgv/tree/main/libraries/ts-json-base/docs)\<`string`\>
-Default initialization parameters for a `FileTree` using [FileApiTreeAccessors](../../../../classes/FileApiTreeAccessors.md).

/package/temp/test/jest/jest-transform-cache-7492f1b44480e0cdd1f220078fb3afd8-79ef2876fae7ca75eedb2aa53dc48338/{d6/package_d6e3b0fa94752e16b0b2a2777739b973 → 7c/package_7c16afc8299e635d80273763175c7a50} RENAMED Viewed

File without changes