@fgv/ts-web-extras 5.1.0-2 → 5.1.0-21
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.
- package/dist/packlets/crypto-utils/browserCryptoProvider.js +208 -18
- package/dist/packlets/crypto-utils/browserCryptoProvider.js.map +1 -1
- package/dist/packlets/file-tree/fileApiTreeAccessors.js +1 -1
- package/dist/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
- package/dist/packlets/file-tree/httpTreeAccessors.js +72 -42
- package/dist/packlets/file-tree/httpTreeAccessors.js.map +1 -1
- package/dist/ts-web-extras.d.ts +59 -7
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts +52 -5
- package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts.map +1 -1
- package/lib/packlets/crypto-utils/browserCryptoProvider.js +207 -17
- package/lib/packlets/crypto-utils/browserCryptoProvider.js.map +1 -1
- package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts +1 -1
- package/lib/packlets/file-tree/fileApiTreeAccessors.js +1 -1
- package/lib/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
- package/lib/packlets/file-tree/httpTreeAccessors.d.ts +6 -0
- package/lib/packlets/file-tree/httpTreeAccessors.d.ts.map +1 -1
- package/lib/packlets/file-tree/httpTreeAccessors.js +72 -42
- package/lib/packlets/file-tree/httpTreeAccessors.js.map +1 -1
- package/package.json +27 -26
- package/.rush/temp/chunked-rush-logs/ts-web-extras.build.chunks.jsonl +0 -75
- package/.rush/temp/chunked-rush-logs/ts-web-extras.test.chunks.jsonl +0 -75
- package/.rush/temp/operation/build/all.log +0 -75
- package/.rush/temp/operation/build/error.log +0 -18
- package/.rush/temp/operation/build/log-chunks.jsonl +0 -75
- package/.rush/temp/operation/build/state.json +0 -3
- package/.rush/temp/operation/test/all.log +0 -75
- package/.rush/temp/operation/test/error.log +0 -18
- package/.rush/temp/operation/test/log-chunks.jsonl +0 -75
- package/.rush/temp/operation/test/state.json +0 -3
- package/.rush/temp/shrinkwrap-deps.json +0 -635
- package/CHANGELOG.md +0 -23
- package/config/api-extractor.json +0 -343
- package/config/jest.config.json +0 -19
- package/config/rig.json +0 -16
- package/config/typedoc.json +0 -6
- package/dist/test/mocks/idb-keyval.js +0 -6
- package/dist/test/mocks/idb-keyval.js.map +0 -1
- package/dist/test/setupTests.js +0 -74
- package/dist/test/setupTests.js.map +0 -1
- package/dist/test/unit/browserHashProvider.test.js +0 -140
- package/dist/test/unit/browserHashProvider.test.js.map +0 -1
- package/dist/test/unit/directoryHandleStore.test.js +0 -190
- package/dist/test/unit/directoryHandleStore.test.js.map +0 -1
- package/dist/test/unit/fileApiTreeAccessors.test.js +0 -1188
- package/dist/test/unit/fileApiTreeAccessors.test.js.map +0 -1
- package/dist/test/unit/fileApiTypes.test.js +0 -472
- package/dist/test/unit/fileApiTypes.test.js.map +0 -1
- package/dist/test/unit/fileSystemAccessTreeAccessors.test.js +0 -622
- package/dist/test/unit/fileSystemAccessTreeAccessors.test.js.map +0 -1
- package/dist/test/unit/fileTreeHelpers.test.js +0 -590
- package/dist/test/unit/fileTreeHelpers.test.js.map +0 -1
- package/dist/test/unit/httpTreeAccessors.test.js +0 -1229
- package/dist/test/unit/httpTreeAccessors.test.js.map +0 -1
- package/dist/test/unit/localStorageTreeAccessors.test.js +0 -812
- package/dist/test/unit/localStorageTreeAccessors.test.js.map +0 -1
- package/dist/test/unit/urlParams.test.js +0 -393
- package/dist/test/unit/urlParams.test.js.map +0 -1
- package/dist/test/utils/fileSystemAccessMocks.js +0 -271
- package/dist/test/utils/fileSystemAccessMocks.js.map +0 -1
- package/dist/test/utils/testHelpers.js +0 -124
- package/dist/test/utils/testHelpers.js.map +0 -1
- package/docs/@fgv/namespaces/CryptoUtils/README.md +0 -18
- package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserCryptoProvider.md +0 -203
- package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserHashProvider.md +0 -63
- package/docs/@fgv/namespaces/CryptoUtils/functions/createBrowserCryptoProvider.md +0 -18
- package/docs/@fgv/namespaces/FileTreeHelpers/README.md +0 -19
- package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileListMetadata.md +0 -23
- package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileMetadata.md +0 -23
- package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromDirectoryUpload.md +0 -33
- package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromFileList.md +0 -33
- package/docs/@fgv/namespaces/FileTreeHelpers/functions/getOriginalFile.md +0 -25
- package/docs/@fgv/namespaces/FileTreeHelpers/variables/defaultFileApiTreeInitParams.md +0 -11
- package/docs/README.md +0 -78
- package/docs/classes/DirectoryHandleStore.md +0 -116
- package/docs/classes/FileApiTreeAccessors.md +0 -286
- package/docs/classes/FileSystemAccessTreeAccessors.md +0 -557
- package/docs/classes/HttpTreeAccessors.md +0 -508
- package/docs/classes/LocalStorageTreeAccessors.md +0 -520
- package/docs/functions/exportAsJson.md +0 -23
- package/docs/functions/exportUsingFileSystemAPI.md +0 -26
- package/docs/functions/extractDirectoryPath.md +0 -23
- package/docs/functions/isDirectoryHandle.md +0 -23
- package/docs/functions/isFileHandle.md +0 -23
- package/docs/functions/isFilePath.md +0 -21
- package/docs/functions/parseContextFilter.md +0 -22
- package/docs/functions/parseQualifierDefaults.md +0 -22
- package/docs/functions/parseResourceTypes.md +0 -22
- package/docs/functions/parseUrlParameters.md +0 -15
- package/docs/functions/safeShowDirectoryPicker.md +0 -24
- package/docs/functions/safeShowOpenFilePicker.md +0 -24
- package/docs/functions/safeShowSaveFilePicker.md +0 -24
- package/docs/functions/supportsFileSystemAccess.md +0 -23
- package/docs/interfaces/FilePickerAcceptType.md +0 -16
- package/docs/interfaces/FileSystemCreateWritableOptions.md +0 -15
- package/docs/interfaces/FileSystemDirectoryHandle.md +0 -187
- package/docs/interfaces/FileSystemFileHandle.md +0 -106
- package/docs/interfaces/FileSystemGetDirectoryOptions.md +0 -15
- package/docs/interfaces/FileSystemGetFileOptions.md +0 -15
- package/docs/interfaces/FileSystemHandle.md +0 -69
- package/docs/interfaces/FileSystemHandlePermissionDescriptor.md +0 -15
- package/docs/interfaces/FileSystemRemoveOptions.md +0 -15
- package/docs/interfaces/FileSystemWritableFileStream.md +0 -127
- package/docs/interfaces/IDirectoryHandleTreeInitializer.md +0 -17
- package/docs/interfaces/IFileHandleTreeInitializer.md +0 -16
- package/docs/interfaces/IFileListTreeInitializer.md +0 -15
- package/docs/interfaces/IFileMetadata.md +0 -19
- package/docs/interfaces/IFileSystemAccessTreeParams.md +0 -30
- package/docs/interfaces/IFsAccessApis.md +0 -57
- package/docs/interfaces/IHttpTreeParams.md +0 -32
- package/docs/interfaces/ILocalStorageTreeParams.md +0 -30
- package/docs/interfaces/IUrlConfigOptions.md +0 -27
- package/docs/interfaces/ShowDirectoryPickerOptions.md +0 -17
- package/docs/interfaces/ShowOpenFilePickerOptions.md +0 -19
- package/docs/interfaces/ShowSaveFilePickerOptions.md +0 -19
- package/docs/type-aliases/TreeInitializer.md +0 -11
- package/docs/type-aliases/WellKnownDirectory.md +0 -11
- package/docs/type-aliases/WindowWithFsAccess.md +0 -11
- package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md +0 -11
- package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md +0 -11
- package/etc/ts-web-extras.api.md +0 -433
- package/lib/test/mocks/idb-keyval.d.ts +0 -6
- package/lib/test/mocks/idb-keyval.d.ts.map +0 -1
- package/lib/test/mocks/idb-keyval.js +0 -9
- package/lib/test/mocks/idb-keyval.js.map +0 -1
- package/lib/test/setupTests.d.ts +0 -2
- package/lib/test/setupTests.d.ts.map +0 -1
- package/lib/test/setupTests.js +0 -76
- package/lib/test/setupTests.js.map +0 -1
- package/lib/test/unit/browserHashProvider.test.d.ts +0 -2
- package/lib/test/unit/browserHashProvider.test.d.ts.map +0 -1
- package/lib/test/unit/browserHashProvider.test.js +0 -142
- package/lib/test/unit/browserHashProvider.test.js.map +0 -1
- package/lib/test/unit/directoryHandleStore.test.d.ts +0 -2
- package/lib/test/unit/directoryHandleStore.test.d.ts.map +0 -1
- package/lib/test/unit/directoryHandleStore.test.js +0 -192
- package/lib/test/unit/directoryHandleStore.test.js.map +0 -1
- package/lib/test/unit/fileApiTreeAccessors.test.d.ts +0 -2
- package/lib/test/unit/fileApiTreeAccessors.test.d.ts.map +0 -1
- package/lib/test/unit/fileApiTreeAccessors.test.js +0 -1190
- package/lib/test/unit/fileApiTreeAccessors.test.js.map +0 -1
- package/lib/test/unit/fileApiTypes.test.d.ts +0 -2
- package/lib/test/unit/fileApiTypes.test.d.ts.map +0 -1
- package/lib/test/unit/fileApiTypes.test.js +0 -474
- package/lib/test/unit/fileApiTypes.test.js.map +0 -1
- package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts +0 -2
- package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts.map +0 -1
- package/lib/test/unit/fileSystemAccessTreeAccessors.test.js +0 -624
- package/lib/test/unit/fileSystemAccessTreeAccessors.test.js.map +0 -1
- package/lib/test/unit/fileTreeHelpers.test.d.ts +0 -2
- package/lib/test/unit/fileTreeHelpers.test.d.ts.map +0 -1
- package/lib/test/unit/fileTreeHelpers.test.js +0 -592
- package/lib/test/unit/fileTreeHelpers.test.js.map +0 -1
- package/lib/test/unit/httpTreeAccessors.test.d.ts +0 -2
- package/lib/test/unit/httpTreeAccessors.test.d.ts.map +0 -1
- package/lib/test/unit/httpTreeAccessors.test.js +0 -1231
- package/lib/test/unit/httpTreeAccessors.test.js.map +0 -1
- package/lib/test/unit/localStorageTreeAccessors.test.d.ts +0 -2
- package/lib/test/unit/localStorageTreeAccessors.test.d.ts.map +0 -1
- package/lib/test/unit/localStorageTreeAccessors.test.js +0 -814
- package/lib/test/unit/localStorageTreeAccessors.test.js.map +0 -1
- package/lib/test/unit/urlParams.test.d.ts +0 -2
- package/lib/test/unit/urlParams.test.d.ts.map +0 -1
- package/lib/test/unit/urlParams.test.js +0 -395
- package/lib/test/unit/urlParams.test.js.map +0 -1
- package/lib/test/utils/fileSystemAccessMocks.d.ts +0 -53
- package/lib/test/utils/fileSystemAccessMocks.d.ts.map +0 -1
- package/lib/test/utils/fileSystemAccessMocks.js +0 -277
- package/lib/test/utils/fileSystemAccessMocks.js.map +0 -1
- package/lib/test/utils/testHelpers.d.ts +0 -51
- package/lib/test/utils/testHelpers.d.ts.map +0 -1
- package/lib/test/utils/testHelpers.js +0 -133
- package/lib/test/utils/testHelpers.js.map +0 -1
- package/rush-logs/ts-web-extras.build.cache.log +0 -0
- package/rush-logs/ts-web-extras.build.error.log +0 -18
- package/rush-logs/ts-web-extras.build.log +0 -75
- package/rush-logs/ts-web-extras.test.cache.log +0 -1
- package/rush-logs/ts-web-extras.test.error.log +0 -18
- package/rush-logs/ts-web-extras.test.log +0 -75
- package/src/index.browser.ts +0 -24
- package/src/index.ts +0 -47
- package/src/packlets/crypto-utils/browserCryptoProvider.ts +0 -311
- package/src/packlets/crypto-utils/browserHashProvider.ts +0 -73
- package/src/packlets/crypto-utils/index.ts +0 -29
- package/src/packlets/file-api-types/index.ts +0 -366
- package/src/packlets/file-tree/directoryHandleStore.ts +0 -136
- package/src/packlets/file-tree/fileApiTreeAccessors.ts +0 -528
- package/src/packlets/file-tree/fileSystemAccessTreeAccessors.ts +0 -519
- package/src/packlets/file-tree/httpTreeAccessors.ts +0 -448
- package/src/packlets/file-tree/index.ts +0 -32
- package/src/packlets/file-tree/localStorageTreeAccessors.ts +0 -430
- package/src/packlets/helpers/fileTreeHelpers.ts +0 -107
- package/src/packlets/helpers/index.ts +0 -28
- package/src/packlets/url-utils/index.ts +0 -28
- package/src/packlets/url-utils/urlParams.ts +0 -245
- package/src/test/mocks/idb-keyval.ts +0 -5
- package/src/test/setupTests.ts +0 -87
- package/src/test/unit/browserHashProvider.test.ts +0 -155
- package/src/test/unit/browserHashProvider.test.ts.bak +0 -376
- package/src/test/unit/directoryHandleStore.test.ts +0 -251
- package/src/test/unit/fileApiTreeAccessors.test.ts +0 -1387
- package/src/test/unit/fileApiTypes.test.ts +0 -587
- package/src/test/unit/fileSystemAccessTreeAccessors.test.ts +0 -885
- package/src/test/unit/fileTreeHelpers.test.ts +0 -694
- package/src/test/unit/httpTreeAccessors.test.ts +0 -1571
- package/src/test/unit/localStorageTreeAccessors.test.ts +0 -1014
- package/src/test/unit/urlParams.test.ts +0 -464
- package/src/test/utils/fileSystemAccessMocks.ts +0 -353
- package/src/test/utils/testHelpers.ts +0 -155
- package/temp/build/typescript/ts_8nwakTlr.json +0 -1
- package/temp/coverage/base.css +0 -224
- package/temp/coverage/block-navigation.js +0 -87
- package/temp/coverage/crypto/browserHashProvider.ts.html +0 -304
- package/temp/coverage/crypto/index.html +0 -116
- package/temp/coverage/crypto-utils/browserCryptoProvider.ts.html +0 -1018
- package/temp/coverage/crypto-utils/browserHashProvider.ts.html +0 -304
- package/temp/coverage/crypto-utils/index.html +0 -131
- package/temp/coverage/favicon.png +0 -0
- package/temp/coverage/file-tree/directoryHandleStore.ts.html +0 -493
- package/temp/coverage/file-tree/fileApiTreeAccessors.ts.html +0 -1669
- package/temp/coverage/file-tree/fileSystemAccessTreeAccessors.ts.html +0 -1642
- package/temp/coverage/file-tree/httpTreeAccessors.ts.html +0 -1429
- package/temp/coverage/file-tree/index.html +0 -176
- package/temp/coverage/file-tree/localStorageTreeAccessors.ts.html +0 -1375
- package/temp/coverage/helpers/fileTreeHelpers.ts.html +0 -406
- package/temp/coverage/helpers/index.html +0 -116
- package/temp/coverage/index.html +0 -161
- package/temp/coverage/lcov-report/base.css +0 -224
- package/temp/coverage/lcov-report/block-navigation.js +0 -87
- package/temp/coverage/lcov-report/crypto/browserHashProvider.ts.html +0 -304
- package/temp/coverage/lcov-report/crypto/index.html +0 -116
- package/temp/coverage/lcov-report/crypto-utils/browserCryptoProvider.ts.html +0 -1018
- package/temp/coverage/lcov-report/crypto-utils/browserHashProvider.ts.html +0 -304
- package/temp/coverage/lcov-report/crypto-utils/index.html +0 -131
- package/temp/coverage/lcov-report/favicon.png +0 -0
- package/temp/coverage/lcov-report/file-tree/directoryHandleStore.ts.html +0 -493
- package/temp/coverage/lcov-report/file-tree/fileApiTreeAccessors.ts.html +0 -1669
- package/temp/coverage/lcov-report/file-tree/fileSystemAccessTreeAccessors.ts.html +0 -1642
- package/temp/coverage/lcov-report/file-tree/httpTreeAccessors.ts.html +0 -1429
- package/temp/coverage/lcov-report/file-tree/index.html +0 -176
- package/temp/coverage/lcov-report/file-tree/localStorageTreeAccessors.ts.html +0 -1375
- package/temp/coverage/lcov-report/helpers/fileTreeHelpers.ts.html +0 -406
- package/temp/coverage/lcov-report/helpers/index.html +0 -116
- package/temp/coverage/lcov-report/index.html +0 -161
- package/temp/coverage/lcov-report/prettify.css +0 -1
- package/temp/coverage/lcov-report/prettify.js +0 -2
- package/temp/coverage/lcov-report/sort-arrow-sprite.png +0 -0
- package/temp/coverage/lcov-report/sorter.js +0 -210
- package/temp/coverage/lcov-report/url-utils/index.html +0 -116
- package/temp/coverage/lcov-report/url-utils/urlParams.ts.html +0 -820
- package/temp/coverage/lcov.info +0 -3597
- package/temp/coverage/prettify.css +0 -1
- package/temp/coverage/prettify.js +0 -2
- package/temp/coverage/sort-arrow-sprite.png +0 -0
- package/temp/coverage/sorter.js +0 -210
- package/temp/coverage/url-utils/index.html +0 -116
- package/temp/coverage/url-utils/urlParams.ts.html +0 -820
- package/temp/test/jest/haste-map-b931e4e63102f86c5bd4949f7dced44f-9d713eb41149188b4e5c0ae3d86d0a57-2ad8e16b24e391b8cdbe50b55c137169 +0 -0
- package/temp/test/jest/jest-transform-cache-b931e4e63102f86c5bd4949f7dced44f-79ef2876fae7ca75eedb2aa53dc48338/b5/package_b5f57afc9ec2c011239b1608ee5bdfa5 +0 -53
- package/temp/test/jest/perf-cache-b931e4e63102f86c5bd4949f7dced44f-da39a3ee5e6b4b0d3255bfef95601890 +0 -1
- package/temp/ts-web-extras.api.json +0 -8850
- package/temp/ts-web-extras.api.md +0 -433
- package/tsconfig.json +0 -7
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / parseResourceTypes
|
|
6
|
-
|
|
7
|
-
# Function: parseResourceTypes()
|
|
8
|
-
|
|
9
|
-
> **parseResourceTypes**(`resourceTypes`): `string`[]
|
|
10
|
-
|
|
11
|
-
Converts resource types string to array
|
|
12
|
-
Example: "json,string" -\> ["json", "string"]
|
|
13
|
-
|
|
14
|
-
## Parameters
|
|
15
|
-
|
|
16
|
-
| Parameter | Type |
|
|
17
|
-
| ------ | ------ |
|
|
18
|
-
| `resourceTypes` | `string` |
|
|
19
|
-
|
|
20
|
-
## Returns
|
|
21
|
-
|
|
22
|
-
`string`[]
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / parseUrlParameters
|
|
6
|
-
|
|
7
|
-
# Function: parseUrlParameters()
|
|
8
|
-
|
|
9
|
-
> **parseUrlParameters**(): [`IUrlConfigOptions`](../interfaces/IUrlConfigOptions.md)
|
|
10
|
-
|
|
11
|
-
Parses URL parameters and extracts configuration options
|
|
12
|
-
|
|
13
|
-
## Returns
|
|
14
|
-
|
|
15
|
-
[`IUrlConfigOptions`](../interfaces/IUrlConfigOptions.md)
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / safeShowDirectoryPicker
|
|
6
|
-
|
|
7
|
-
# Function: safeShowDirectoryPicker()
|
|
8
|
-
|
|
9
|
-
> **safeShowDirectoryPicker**(`window`, `options?`): `Promise`\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `null`\>
|
|
10
|
-
|
|
11
|
-
Safely access showDirectoryPicker with proper type checking
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
| Parameter | Type | Description |
|
|
16
|
-
| ------ | ------ | ------ |
|
|
17
|
-
| `window` | `Window` | The window object |
|
|
18
|
-
| `options?` | [`ShowDirectoryPickerOptions`](../interfaces/ShowDirectoryPickerOptions.md) | Options for the directory picker |
|
|
19
|
-
|
|
20
|
-
## Returns
|
|
21
|
-
|
|
22
|
-
`Promise`\<[`FileSystemDirectoryHandle`](../interfaces/FileSystemDirectoryHandle.md) \| `null`\>
|
|
23
|
-
|
|
24
|
-
Promise with directory handle or null if not supported
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / safeShowOpenFilePicker
|
|
6
|
-
|
|
7
|
-
# Function: safeShowOpenFilePicker()
|
|
8
|
-
|
|
9
|
-
> **safeShowOpenFilePicker**(`window`, `options?`): `Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md)[] \| `null`\>
|
|
10
|
-
|
|
11
|
-
Safely access showOpenFilePicker with proper type checking
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
| Parameter | Type | Description |
|
|
16
|
-
| ------ | ------ | ------ |
|
|
17
|
-
| `window` | `Window` | The window object |
|
|
18
|
-
| `options?` | [`ShowOpenFilePickerOptions`](../interfaces/ShowOpenFilePickerOptions.md) | Options for the file picker |
|
|
19
|
-
|
|
20
|
-
## Returns
|
|
21
|
-
|
|
22
|
-
`Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md)[] \| `null`\>
|
|
23
|
-
|
|
24
|
-
Promise with file handles or null if not supported
|
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / safeShowSaveFilePicker
|
|
6
|
-
|
|
7
|
-
# Function: safeShowSaveFilePicker()
|
|
8
|
-
|
|
9
|
-
> **safeShowSaveFilePicker**(`window`, `options?`): `Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md) \| `null`\>
|
|
10
|
-
|
|
11
|
-
Safely access showSaveFilePicker with proper type checking
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
| Parameter | Type | Description |
|
|
16
|
-
| ------ | ------ | ------ |
|
|
17
|
-
| `window` | `Window` | The window object |
|
|
18
|
-
| `options?` | [`ShowSaveFilePickerOptions`](../interfaces/ShowSaveFilePickerOptions.md) | Options for the file picker |
|
|
19
|
-
|
|
20
|
-
## Returns
|
|
21
|
-
|
|
22
|
-
`Promise`\<[`FileSystemFileHandle`](../interfaces/FileSystemFileHandle.md) \| `null`\>
|
|
23
|
-
|
|
24
|
-
Promise with file handle or null if not supported
|
|
@@ -1,23 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / supportsFileSystemAccess
|
|
6
|
-
|
|
7
|
-
# Function: supportsFileSystemAccess()
|
|
8
|
-
|
|
9
|
-
> **supportsFileSystemAccess**(`window`): `window is WindowWithFsAccess`
|
|
10
|
-
|
|
11
|
-
Type guard to check if the browser supports the File System Access API
|
|
12
|
-
|
|
13
|
-
## Parameters
|
|
14
|
-
|
|
15
|
-
| Parameter | Type | Description |
|
|
16
|
-
| ------ | ------ | ------ |
|
|
17
|
-
| `window` | `Window` | The window object to check |
|
|
18
|
-
|
|
19
|
-
## Returns
|
|
20
|
-
|
|
21
|
-
`window is WindowWithFsAccess`
|
|
22
|
-
|
|
23
|
-
True if the window supports File System Access API
|
|
@@ -1,16 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FilePickerAcceptType
|
|
6
|
-
|
|
7
|
-
# Interface: FilePickerAcceptType
|
|
8
|
-
|
|
9
|
-
File picker accept type
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
| Property | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| <a id="accept"></a> `accept` | `Record`\<`string`, `string` \| `string`[]\> |
|
|
16
|
-
| <a id="description"></a> `description?` | `string` |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemCreateWritableOptions
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemCreateWritableOptions
|
|
8
|
-
|
|
9
|
-
Options for creating writable file streams
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
| Property | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| <a id="keepexistingdata"></a> `keepExistingData?` | `boolean` |
|
|
@@ -1,187 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemDirectoryHandle
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemDirectoryHandle
|
|
8
|
-
|
|
9
|
-
Directory handle interface
|
|
10
|
-
|
|
11
|
-
## Extends
|
|
12
|
-
|
|
13
|
-
- [`FileSystemHandle`](FileSystemHandle.md)
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
| Property | Modifier | Type |
|
|
18
|
-
| ------ | ------ | ------ |
|
|
19
|
-
| <a id="kind"></a> `kind` | `readonly` | `"directory"` |
|
|
20
|
-
| <a id="name"></a> `name` | `readonly` | `string` |
|
|
21
|
-
|
|
22
|
-
## Methods
|
|
23
|
-
|
|
24
|
-
### \[asyncIterator\]()
|
|
25
|
-
|
|
26
|
-
> **\[asyncIterator\]**(): `AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
|
|
27
|
-
|
|
28
|
-
#### Returns
|
|
29
|
-
|
|
30
|
-
`AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
|
|
31
|
-
|
|
32
|
-
***
|
|
33
|
-
|
|
34
|
-
### entries()
|
|
35
|
-
|
|
36
|
-
> **entries**(): `AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
|
|
37
|
-
|
|
38
|
-
#### Returns
|
|
39
|
-
|
|
40
|
-
`AsyncIterableIterator`\<\[`string`, [`FileSystemHandle`](FileSystemHandle.md)\]\>
|
|
41
|
-
|
|
42
|
-
***
|
|
43
|
-
|
|
44
|
-
### getDirectoryHandle()
|
|
45
|
-
|
|
46
|
-
> **getDirectoryHandle**(`name`, `options?`): `Promise`\<`FileSystemDirectoryHandle`\>
|
|
47
|
-
|
|
48
|
-
#### Parameters
|
|
49
|
-
|
|
50
|
-
| Parameter | Type |
|
|
51
|
-
| ------ | ------ |
|
|
52
|
-
| `name` | `string` |
|
|
53
|
-
| `options?` | [`FileSystemGetDirectoryOptions`](FileSystemGetDirectoryOptions.md) |
|
|
54
|
-
|
|
55
|
-
#### Returns
|
|
56
|
-
|
|
57
|
-
`Promise`\<`FileSystemDirectoryHandle`\>
|
|
58
|
-
|
|
59
|
-
***
|
|
60
|
-
|
|
61
|
-
### getFileHandle()
|
|
62
|
-
|
|
63
|
-
> **getFileHandle**(`name`, `options?`): `Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
|
|
64
|
-
|
|
65
|
-
#### Parameters
|
|
66
|
-
|
|
67
|
-
| Parameter | Type |
|
|
68
|
-
| ------ | ------ |
|
|
69
|
-
| `name` | `string` |
|
|
70
|
-
| `options?` | [`FileSystemGetFileOptions`](FileSystemGetFileOptions.md) |
|
|
71
|
-
|
|
72
|
-
#### Returns
|
|
73
|
-
|
|
74
|
-
`Promise`\<[`FileSystemFileHandle`](FileSystemFileHandle.md)\>
|
|
75
|
-
|
|
76
|
-
***
|
|
77
|
-
|
|
78
|
-
### isSameEntry()
|
|
79
|
-
|
|
80
|
-
> **isSameEntry**(`other`): `Promise`\<`boolean`\>
|
|
81
|
-
|
|
82
|
-
#### Parameters
|
|
83
|
-
|
|
84
|
-
| Parameter | Type |
|
|
85
|
-
| ------ | ------ |
|
|
86
|
-
| `other` | [`FileSystemHandle`](FileSystemHandle.md) |
|
|
87
|
-
|
|
88
|
-
#### Returns
|
|
89
|
-
|
|
90
|
-
`Promise`\<`boolean`\>
|
|
91
|
-
|
|
92
|
-
#### Inherited from
|
|
93
|
-
|
|
94
|
-
[`FileSystemHandle`](FileSystemHandle.md).[`isSameEntry`](FileSystemHandle.md#issameentry)
|
|
95
|
-
|
|
96
|
-
***
|
|
97
|
-
|
|
98
|
-
### keys()
|
|
99
|
-
|
|
100
|
-
> **keys**(): `AsyncIterableIterator`\<`string`\>
|
|
101
|
-
|
|
102
|
-
#### Returns
|
|
103
|
-
|
|
104
|
-
`AsyncIterableIterator`\<`string`\>
|
|
105
|
-
|
|
106
|
-
***
|
|
107
|
-
|
|
108
|
-
### queryPermission()
|
|
109
|
-
|
|
110
|
-
> **queryPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
|
|
111
|
-
|
|
112
|
-
#### Parameters
|
|
113
|
-
|
|
114
|
-
| Parameter | Type |
|
|
115
|
-
| ------ | ------ |
|
|
116
|
-
| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
|
|
117
|
-
|
|
118
|
-
#### Returns
|
|
119
|
-
|
|
120
|
-
`Promise`\<`PermissionState`\>
|
|
121
|
-
|
|
122
|
-
#### Inherited from
|
|
123
|
-
|
|
124
|
-
[`FileSystemHandle`](FileSystemHandle.md).[`queryPermission`](FileSystemHandle.md#querypermission)
|
|
125
|
-
|
|
126
|
-
***
|
|
127
|
-
|
|
128
|
-
### removeEntry()
|
|
129
|
-
|
|
130
|
-
> **removeEntry**(`name`, `options?`): `Promise`\<`void`\>
|
|
131
|
-
|
|
132
|
-
#### Parameters
|
|
133
|
-
|
|
134
|
-
| Parameter | Type |
|
|
135
|
-
| ------ | ------ |
|
|
136
|
-
| `name` | `string` |
|
|
137
|
-
| `options?` | [`FileSystemRemoveOptions`](FileSystemRemoveOptions.md) |
|
|
138
|
-
|
|
139
|
-
#### Returns
|
|
140
|
-
|
|
141
|
-
`Promise`\<`void`\>
|
|
142
|
-
|
|
143
|
-
***
|
|
144
|
-
|
|
145
|
-
### requestPermission()
|
|
146
|
-
|
|
147
|
-
> **requestPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
|
|
148
|
-
|
|
149
|
-
#### Parameters
|
|
150
|
-
|
|
151
|
-
| Parameter | Type |
|
|
152
|
-
| ------ | ------ |
|
|
153
|
-
| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
|
|
154
|
-
|
|
155
|
-
#### Returns
|
|
156
|
-
|
|
157
|
-
`Promise`\<`PermissionState`\>
|
|
158
|
-
|
|
159
|
-
#### Inherited from
|
|
160
|
-
|
|
161
|
-
[`FileSystemHandle`](FileSystemHandle.md).[`requestPermission`](FileSystemHandle.md#requestpermission)
|
|
162
|
-
|
|
163
|
-
***
|
|
164
|
-
|
|
165
|
-
### resolve()
|
|
166
|
-
|
|
167
|
-
> **resolve**(`possibleDescendant`): `Promise`\<`string`[] \| `null`\>
|
|
168
|
-
|
|
169
|
-
#### Parameters
|
|
170
|
-
|
|
171
|
-
| Parameter | Type |
|
|
172
|
-
| ------ | ------ |
|
|
173
|
-
| `possibleDescendant` | [`FileSystemHandle`](FileSystemHandle.md) |
|
|
174
|
-
|
|
175
|
-
#### Returns
|
|
176
|
-
|
|
177
|
-
`Promise`\<`string`[] \| `null`\>
|
|
178
|
-
|
|
179
|
-
***
|
|
180
|
-
|
|
181
|
-
### values()
|
|
182
|
-
|
|
183
|
-
> **values**(): `AsyncIterableIterator`\<[`FileSystemHandle`](FileSystemHandle.md)\>
|
|
184
|
-
|
|
185
|
-
#### Returns
|
|
186
|
-
|
|
187
|
-
`AsyncIterableIterator`\<[`FileSystemHandle`](FileSystemHandle.md)\>
|
|
@@ -1,106 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemFileHandle
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemFileHandle
|
|
8
|
-
|
|
9
|
-
File handle interface
|
|
10
|
-
|
|
11
|
-
## Extends
|
|
12
|
-
|
|
13
|
-
- [`FileSystemHandle`](FileSystemHandle.md)
|
|
14
|
-
|
|
15
|
-
## Properties
|
|
16
|
-
|
|
17
|
-
| Property | Modifier | Type |
|
|
18
|
-
| ------ | ------ | ------ |
|
|
19
|
-
| <a id="kind"></a> `kind` | `readonly` | `"file"` |
|
|
20
|
-
| <a id="name"></a> `name` | `readonly` | `string` |
|
|
21
|
-
|
|
22
|
-
## Methods
|
|
23
|
-
|
|
24
|
-
### createWritable()
|
|
25
|
-
|
|
26
|
-
> **createWritable**(`options?`): `Promise`\<[`FileSystemWritableFileStream`](FileSystemWritableFileStream.md)\>
|
|
27
|
-
|
|
28
|
-
#### Parameters
|
|
29
|
-
|
|
30
|
-
| Parameter | Type |
|
|
31
|
-
| ------ | ------ |
|
|
32
|
-
| `options?` | [`FileSystemCreateWritableOptions`](FileSystemCreateWritableOptions.md) |
|
|
33
|
-
|
|
34
|
-
#### Returns
|
|
35
|
-
|
|
36
|
-
`Promise`\<[`FileSystemWritableFileStream`](FileSystemWritableFileStream.md)\>
|
|
37
|
-
|
|
38
|
-
***
|
|
39
|
-
|
|
40
|
-
### getFile()
|
|
41
|
-
|
|
42
|
-
> **getFile**(): `Promise`\<`File`\>
|
|
43
|
-
|
|
44
|
-
#### Returns
|
|
45
|
-
|
|
46
|
-
`Promise`\<`File`\>
|
|
47
|
-
|
|
48
|
-
***
|
|
49
|
-
|
|
50
|
-
### isSameEntry()
|
|
51
|
-
|
|
52
|
-
> **isSameEntry**(`other`): `Promise`\<`boolean`\>
|
|
53
|
-
|
|
54
|
-
#### Parameters
|
|
55
|
-
|
|
56
|
-
| Parameter | Type |
|
|
57
|
-
| ------ | ------ |
|
|
58
|
-
| `other` | [`FileSystemHandle`](FileSystemHandle.md) |
|
|
59
|
-
|
|
60
|
-
#### Returns
|
|
61
|
-
|
|
62
|
-
`Promise`\<`boolean`\>
|
|
63
|
-
|
|
64
|
-
#### Inherited from
|
|
65
|
-
|
|
66
|
-
[`FileSystemHandle`](FileSystemHandle.md).[`isSameEntry`](FileSystemHandle.md#issameentry)
|
|
67
|
-
|
|
68
|
-
***
|
|
69
|
-
|
|
70
|
-
### queryPermission()
|
|
71
|
-
|
|
72
|
-
> **queryPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
|
|
73
|
-
|
|
74
|
-
#### Parameters
|
|
75
|
-
|
|
76
|
-
| Parameter | Type |
|
|
77
|
-
| ------ | ------ |
|
|
78
|
-
| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
|
|
79
|
-
|
|
80
|
-
#### Returns
|
|
81
|
-
|
|
82
|
-
`Promise`\<`PermissionState`\>
|
|
83
|
-
|
|
84
|
-
#### Inherited from
|
|
85
|
-
|
|
86
|
-
[`FileSystemHandle`](FileSystemHandle.md).[`queryPermission`](FileSystemHandle.md#querypermission)
|
|
87
|
-
|
|
88
|
-
***
|
|
89
|
-
|
|
90
|
-
### requestPermission()
|
|
91
|
-
|
|
92
|
-
> **requestPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
|
|
93
|
-
|
|
94
|
-
#### Parameters
|
|
95
|
-
|
|
96
|
-
| Parameter | Type |
|
|
97
|
-
| ------ | ------ |
|
|
98
|
-
| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
|
|
99
|
-
|
|
100
|
-
#### Returns
|
|
101
|
-
|
|
102
|
-
`Promise`\<`PermissionState`\>
|
|
103
|
-
|
|
104
|
-
#### Inherited from
|
|
105
|
-
|
|
106
|
-
[`FileSystemHandle`](FileSystemHandle.md).[`requestPermission`](FileSystemHandle.md#requestpermission)
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemGetDirectoryOptions
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemGetDirectoryOptions
|
|
8
|
-
|
|
9
|
-
Options for getting directory handles
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
| Property | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| <a id="create"></a> `create?` | `boolean` |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemGetFileOptions
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemGetFileOptions
|
|
8
|
-
|
|
9
|
-
Options for getting file handles
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
| Property | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| <a id="create"></a> `create?` | `boolean` |
|
|
@@ -1,69 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemHandle
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemHandle
|
|
8
|
-
|
|
9
|
-
Base interface for file system handles
|
|
10
|
-
|
|
11
|
-
## Extended by
|
|
12
|
-
|
|
13
|
-
- [`FileSystemFileHandle`](FileSystemFileHandle.md)
|
|
14
|
-
- [`FileSystemDirectoryHandle`](FileSystemDirectoryHandle.md)
|
|
15
|
-
|
|
16
|
-
## Properties
|
|
17
|
-
|
|
18
|
-
| Property | Modifier | Type |
|
|
19
|
-
| ------ | ------ | ------ |
|
|
20
|
-
| <a id="kind"></a> `kind` | `readonly` | `"file"` \| `"directory"` |
|
|
21
|
-
| <a id="name"></a> `name` | `readonly` | `string` |
|
|
22
|
-
|
|
23
|
-
## Methods
|
|
24
|
-
|
|
25
|
-
### isSameEntry()
|
|
26
|
-
|
|
27
|
-
> **isSameEntry**(`other`): `Promise`\<`boolean`\>
|
|
28
|
-
|
|
29
|
-
#### Parameters
|
|
30
|
-
|
|
31
|
-
| Parameter | Type |
|
|
32
|
-
| ------ | ------ |
|
|
33
|
-
| `other` | `FileSystemHandle` |
|
|
34
|
-
|
|
35
|
-
#### Returns
|
|
36
|
-
|
|
37
|
-
`Promise`\<`boolean`\>
|
|
38
|
-
|
|
39
|
-
***
|
|
40
|
-
|
|
41
|
-
### queryPermission()
|
|
42
|
-
|
|
43
|
-
> **queryPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
|
|
44
|
-
|
|
45
|
-
#### Parameters
|
|
46
|
-
|
|
47
|
-
| Parameter | Type |
|
|
48
|
-
| ------ | ------ |
|
|
49
|
-
| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
|
|
50
|
-
|
|
51
|
-
#### Returns
|
|
52
|
-
|
|
53
|
-
`Promise`\<`PermissionState`\>
|
|
54
|
-
|
|
55
|
-
***
|
|
56
|
-
|
|
57
|
-
### requestPermission()
|
|
58
|
-
|
|
59
|
-
> **requestPermission**(`descriptor?`): `Promise`\<`PermissionState`\>
|
|
60
|
-
|
|
61
|
-
#### Parameters
|
|
62
|
-
|
|
63
|
-
| Parameter | Type |
|
|
64
|
-
| ------ | ------ |
|
|
65
|
-
| `descriptor?` | [`FileSystemHandlePermissionDescriptor`](FileSystemHandlePermissionDescriptor.md) |
|
|
66
|
-
|
|
67
|
-
#### Returns
|
|
68
|
-
|
|
69
|
-
`Promise`\<`PermissionState`\>
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemHandlePermissionDescriptor
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemHandlePermissionDescriptor
|
|
8
|
-
|
|
9
|
-
Permission descriptor for file system handles
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
| Property | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| <a id="mode"></a> `mode?` | `"readwrite"` \| `"read"` |
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
[**@fgv/ts-web-extras**](../README.md)
|
|
2
|
-
|
|
3
|
-
***
|
|
4
|
-
|
|
5
|
-
[@fgv/ts-web-extras](../README.md) / FileSystemRemoveOptions
|
|
6
|
-
|
|
7
|
-
# Interface: FileSystemRemoveOptions
|
|
8
|
-
|
|
9
|
-
Options for removing entries
|
|
10
|
-
|
|
11
|
-
## Properties
|
|
12
|
-
|
|
13
|
-
| Property | Type |
|
|
14
|
-
| ------ | ------ |
|
|
15
|
-
| <a id="recursive"></a> `recursive?` | `boolean` |
|