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

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 (275) hide show
  1. package/dist/packlets/crypto-utils/browserCryptoProvider.js +330 -18
  2. package/dist/packlets/crypto-utils/browserCryptoProvider.js.map +1 -1
  3. package/dist/packlets/crypto-utils/index.js +12 -0
  4. package/dist/packlets/crypto-utils/index.js.map +1 -1
  5. package/dist/packlets/file-tree/directoryHandleStore.js.map +1 -1
  6. package/dist/packlets/file-tree/fileApiTreeAccessors.js +1 -1
  7. package/dist/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  8. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js +2 -2
  9. package/dist/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -1
  10. package/dist/packlets/file-tree/httpTreeAccessors.js +74 -44
  11. package/dist/packlets/file-tree/httpTreeAccessors.js.map +1 -1
  12. package/dist/packlets/file-tree/localStorageTreeAccessors.js.map +1 -1
  13. package/dist/packlets/helpers/fileTreeHelpers.js +1 -1
  14. package/dist/packlets/helpers/fileTreeHelpers.js.map +1 -1
  15. package/dist/ts-web-extras.d.ts +141 -10
  16. package/dist/tsdoc-metadata.json +1 -1
  17. package/eslint.config.js +32 -0
  18. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts +115 -6
  19. package/lib/packlets/crypto-utils/browserCryptoProvider.d.ts.map +1 -1
  20. package/lib/packlets/crypto-utils/browserCryptoProvider.js +329 -17
  21. package/lib/packlets/crypto-utils/browserCryptoProvider.js.map +1 -1
  22. package/lib/packlets/crypto-utils/index.d.ts +13 -0
  23. package/lib/packlets/crypto-utils/index.d.ts.map +1 -1
  24. package/lib/packlets/crypto-utils/index.js +13 -0
  25. package/lib/packlets/crypto-utils/index.js.map +1 -1
  26. package/lib/packlets/file-tree/directoryHandleStore.d.ts +2 -2
  27. package/lib/packlets/file-tree/directoryHandleStore.d.ts.map +1 -1
  28. package/lib/packlets/file-tree/directoryHandleStore.js.map +1 -1
  29. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts +2 -2
  30. package/lib/packlets/file-tree/fileApiTreeAccessors.d.ts.map +1 -1
  31. package/lib/packlets/file-tree/fileApiTreeAccessors.js +1 -1
  32. package/lib/packlets/file-tree/fileApiTreeAccessors.js.map +1 -1
  33. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.d.ts.map +1 -1
  34. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js +2 -2
  35. package/lib/packlets/file-tree/fileSystemAccessTreeAccessors.js.map +1 -1
  36. package/lib/packlets/file-tree/httpTreeAccessors.d.ts +6 -0
  37. package/lib/packlets/file-tree/httpTreeAccessors.d.ts.map +1 -1
  38. package/lib/packlets/file-tree/httpTreeAccessors.js +74 -44
  39. package/lib/packlets/file-tree/httpTreeAccessors.js.map +1 -1
  40. package/lib/packlets/file-tree/localStorageTreeAccessors.js.map +1 -1
  41. package/lib/packlets/helpers/fileTreeHelpers.d.ts +1 -1
  42. package/lib/packlets/helpers/fileTreeHelpers.d.ts.map +1 -1
  43. package/lib/packlets/helpers/fileTreeHelpers.js +6 -6
  44. package/lib/packlets/helpers/fileTreeHelpers.js.map +1 -1
  45. package/package.json +16 -15
  46. package/.rush/temp/61c1d4a91d98f048b475a5bb3e6541c5d27819de.tar.log +0 -237
  47. package/.rush/temp/chunked-rush-logs/ts-web-extras.build.chunks.jsonl +0 -55
  48. package/.rush/temp/operation/build/all.log +0 -55
  49. package/.rush/temp/operation/build/log-chunks.jsonl +0 -55
  50. package/.rush/temp/operation/build/state.json +0 -3
  51. package/.rush/temp/shrinkwrap-deps.json +0 -635
  52. package/CHANGELOG.md +0 -23
  53. package/config/api-extractor.json +0 -343
  54. package/config/jest.config.json +0 -19
  55. package/config/rig.json +0 -16
  56. package/config/typedoc.json +0 -6
  57. package/dist/test/mocks/idb-keyval.js +0 -6
  58. package/dist/test/mocks/idb-keyval.js.map +0 -1
  59. package/dist/test/setupTests.js +0 -74
  60. package/dist/test/setupTests.js.map +0 -1
  61. package/dist/test/unit/browserHashProvider.test.js +0 -140
  62. package/dist/test/unit/browserHashProvider.test.js.map +0 -1
  63. package/dist/test/unit/directoryHandleStore.test.js +0 -190
  64. package/dist/test/unit/directoryHandleStore.test.js.map +0 -1
  65. package/dist/test/unit/fileApiTreeAccessors.test.js +0 -1188
  66. package/dist/test/unit/fileApiTreeAccessors.test.js.map +0 -1
  67. package/dist/test/unit/fileApiTypes.test.js +0 -472
  68. package/dist/test/unit/fileApiTypes.test.js.map +0 -1
  69. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js +0 -622
  70. package/dist/test/unit/fileSystemAccessTreeAccessors.test.js.map +0 -1
  71. package/dist/test/unit/fileTreeHelpers.test.js +0 -590
  72. package/dist/test/unit/fileTreeHelpers.test.js.map +0 -1
  73. package/dist/test/unit/httpTreeAccessors.test.js +0 -1229
  74. package/dist/test/unit/httpTreeAccessors.test.js.map +0 -1
  75. package/dist/test/unit/localStorageTreeAccessors.test.js +0 -812
  76. package/dist/test/unit/localStorageTreeAccessors.test.js.map +0 -1
  77. package/dist/test/unit/urlParams.test.js +0 -393
  78. package/dist/test/unit/urlParams.test.js.map +0 -1
  79. package/dist/test/utils/fileSystemAccessMocks.js +0 -271
  80. package/dist/test/utils/fileSystemAccessMocks.js.map +0 -1
  81. package/dist/test/utils/testHelpers.js +0 -124
  82. package/dist/test/utils/testHelpers.js.map +0 -1
  83. package/docs/@fgv/namespaces/CryptoUtils/README.md +0 -18
  84. package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserCryptoProvider.md +0 -203
  85. package/docs/@fgv/namespaces/CryptoUtils/classes/BrowserHashProvider.md +0 -63
  86. package/docs/@fgv/namespaces/CryptoUtils/functions/createBrowserCryptoProvider.md +0 -18
  87. package/docs/@fgv/namespaces/FileTreeHelpers/README.md +0 -19
  88. package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileListMetadata.md +0 -23
  89. package/docs/@fgv/namespaces/FileTreeHelpers/functions/extractFileMetadata.md +0 -23
  90. package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromDirectoryUpload.md +0 -33
  91. package/docs/@fgv/namespaces/FileTreeHelpers/functions/fromFileList.md +0 -33
  92. package/docs/@fgv/namespaces/FileTreeHelpers/functions/getOriginalFile.md +0 -25
  93. package/docs/@fgv/namespaces/FileTreeHelpers/variables/defaultFileApiTreeInitParams.md +0 -11
  94. package/docs/README.md +0 -78
  95. package/docs/classes/DirectoryHandleStore.md +0 -116
  96. package/docs/classes/FileApiTreeAccessors.md +0 -286
  97. package/docs/classes/FileSystemAccessTreeAccessors.md +0 -557
  98. package/docs/classes/HttpTreeAccessors.md +0 -508
  99. package/docs/classes/LocalStorageTreeAccessors.md +0 -520
  100. package/docs/functions/exportAsJson.md +0 -23
  101. package/docs/functions/exportUsingFileSystemAPI.md +0 -26
  102. package/docs/functions/extractDirectoryPath.md +0 -23
  103. package/docs/functions/isDirectoryHandle.md +0 -23
  104. package/docs/functions/isFileHandle.md +0 -23
  105. package/docs/functions/isFilePath.md +0 -21
  106. package/docs/functions/parseContextFilter.md +0 -22
  107. package/docs/functions/parseQualifierDefaults.md +0 -22
  108. package/docs/functions/parseResourceTypes.md +0 -22
  109. package/docs/functions/parseUrlParameters.md +0 -15
  110. package/docs/functions/safeShowDirectoryPicker.md +0 -24
  111. package/docs/functions/safeShowOpenFilePicker.md +0 -24
  112. package/docs/functions/safeShowSaveFilePicker.md +0 -24
  113. package/docs/functions/supportsFileSystemAccess.md +0 -23
  114. package/docs/interfaces/FilePickerAcceptType.md +0 -16
  115. package/docs/interfaces/FileSystemCreateWritableOptions.md +0 -15
  116. package/docs/interfaces/FileSystemDirectoryHandle.md +0 -187
  117. package/docs/interfaces/FileSystemFileHandle.md +0 -106
  118. package/docs/interfaces/FileSystemGetDirectoryOptions.md +0 -15
  119. package/docs/interfaces/FileSystemGetFileOptions.md +0 -15
  120. package/docs/interfaces/FileSystemHandle.md +0 -69
  121. package/docs/interfaces/FileSystemHandlePermissionDescriptor.md +0 -15
  122. package/docs/interfaces/FileSystemRemoveOptions.md +0 -15
  123. package/docs/interfaces/FileSystemWritableFileStream.md +0 -127
  124. package/docs/interfaces/IDirectoryHandleTreeInitializer.md +0 -17
  125. package/docs/interfaces/IFileHandleTreeInitializer.md +0 -16
  126. package/docs/interfaces/IFileListTreeInitializer.md +0 -15
  127. package/docs/interfaces/IFileMetadata.md +0 -19
  128. package/docs/interfaces/IFileSystemAccessTreeParams.md +0 -30
  129. package/docs/interfaces/IFsAccessApis.md +0 -57
  130. package/docs/interfaces/IHttpTreeParams.md +0 -32
  131. package/docs/interfaces/ILocalStorageTreeParams.md +0 -30
  132. package/docs/interfaces/IUrlConfigOptions.md +0 -27
  133. package/docs/interfaces/ShowDirectoryPickerOptions.md +0 -17
  134. package/docs/interfaces/ShowOpenFilePickerOptions.md +0 -19
  135. package/docs/interfaces/ShowSaveFilePickerOptions.md +0 -19
  136. package/docs/type-aliases/TreeInitializer.md +0 -11
  137. package/docs/type-aliases/WellKnownDirectory.md +0 -11
  138. package/docs/type-aliases/WindowWithFsAccess.md +0 -11
  139. package/docs/variables/DEFAULT_DIRECTORY_HANDLE_DB.md +0 -11
  140. package/docs/variables/DEFAULT_DIRECTORY_HANDLE_STORE.md +0 -11
  141. package/etc/ts-web-extras.api.md +0 -433
  142. package/lib/test/mocks/idb-keyval.d.ts +0 -6
  143. package/lib/test/mocks/idb-keyval.d.ts.map +0 -1
  144. package/lib/test/mocks/idb-keyval.js +0 -9
  145. package/lib/test/mocks/idb-keyval.js.map +0 -1
  146. package/lib/test/setupTests.d.ts +0 -2
  147. package/lib/test/setupTests.d.ts.map +0 -1
  148. package/lib/test/setupTests.js +0 -76
  149. package/lib/test/setupTests.js.map +0 -1
  150. package/lib/test/unit/browserHashProvider.test.d.ts +0 -2
  151. package/lib/test/unit/browserHashProvider.test.d.ts.map +0 -1
  152. package/lib/test/unit/browserHashProvider.test.js +0 -142
  153. package/lib/test/unit/browserHashProvider.test.js.map +0 -1
  154. package/lib/test/unit/directoryHandleStore.test.d.ts +0 -2
  155. package/lib/test/unit/directoryHandleStore.test.d.ts.map +0 -1
  156. package/lib/test/unit/directoryHandleStore.test.js +0 -192
  157. package/lib/test/unit/directoryHandleStore.test.js.map +0 -1
  158. package/lib/test/unit/fileApiTreeAccessors.test.d.ts +0 -2
  159. package/lib/test/unit/fileApiTreeAccessors.test.d.ts.map +0 -1
  160. package/lib/test/unit/fileApiTreeAccessors.test.js +0 -1190
  161. package/lib/test/unit/fileApiTreeAccessors.test.js.map +0 -1
  162. package/lib/test/unit/fileApiTypes.test.d.ts +0 -2
  163. package/lib/test/unit/fileApiTypes.test.d.ts.map +0 -1
  164. package/lib/test/unit/fileApiTypes.test.js +0 -474
  165. package/lib/test/unit/fileApiTypes.test.js.map +0 -1
  166. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts +0 -2
  167. package/lib/test/unit/fileSystemAccessTreeAccessors.test.d.ts.map +0 -1
  168. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js +0 -624
  169. package/lib/test/unit/fileSystemAccessTreeAccessors.test.js.map +0 -1
  170. package/lib/test/unit/fileTreeHelpers.test.d.ts +0 -2
  171. package/lib/test/unit/fileTreeHelpers.test.d.ts.map +0 -1
  172. package/lib/test/unit/fileTreeHelpers.test.js +0 -592
  173. package/lib/test/unit/fileTreeHelpers.test.js.map +0 -1
  174. package/lib/test/unit/httpTreeAccessors.test.d.ts +0 -2
  175. package/lib/test/unit/httpTreeAccessors.test.d.ts.map +0 -1
  176. package/lib/test/unit/httpTreeAccessors.test.js +0 -1231
  177. package/lib/test/unit/httpTreeAccessors.test.js.map +0 -1
  178. package/lib/test/unit/localStorageTreeAccessors.test.d.ts +0 -2
  179. package/lib/test/unit/localStorageTreeAccessors.test.d.ts.map +0 -1
  180. package/lib/test/unit/localStorageTreeAccessors.test.js +0 -814
  181. package/lib/test/unit/localStorageTreeAccessors.test.js.map +0 -1
  182. package/lib/test/unit/urlParams.test.d.ts +0 -2
  183. package/lib/test/unit/urlParams.test.d.ts.map +0 -1
  184. package/lib/test/unit/urlParams.test.js +0 -395
  185. package/lib/test/unit/urlParams.test.js.map +0 -1
  186. package/lib/test/utils/fileSystemAccessMocks.d.ts +0 -53
  187. package/lib/test/utils/fileSystemAccessMocks.d.ts.map +0 -1
  188. package/lib/test/utils/fileSystemAccessMocks.js +0 -277
  189. package/lib/test/utils/fileSystemAccessMocks.js.map +0 -1
  190. package/lib/test/utils/testHelpers.d.ts +0 -51
  191. package/lib/test/utils/testHelpers.d.ts.map +0 -1
  192. package/lib/test/utils/testHelpers.js +0 -133
  193. package/lib/test/utils/testHelpers.js.map +0 -1
  194. package/rush-logs/ts-web-extras.build.cache.log +0 -3
  195. package/rush-logs/ts-web-extras.build.log +0 -55
  196. package/src/index.browser.ts +0 -24
  197. package/src/index.ts +0 -47
  198. package/src/packlets/crypto-utils/browserCryptoProvider.ts +0 -311
  199. package/src/packlets/crypto-utils/browserHashProvider.ts +0 -73
  200. package/src/packlets/crypto-utils/index.ts +0 -29
  201. package/src/packlets/file-api-types/index.ts +0 -366
  202. package/src/packlets/file-tree/directoryHandleStore.ts +0 -136
  203. package/src/packlets/file-tree/fileApiTreeAccessors.ts +0 -528
  204. package/src/packlets/file-tree/fileSystemAccessTreeAccessors.ts +0 -519
  205. package/src/packlets/file-tree/httpTreeAccessors.ts +0 -448
  206. package/src/packlets/file-tree/index.ts +0 -32
  207. package/src/packlets/file-tree/localStorageTreeAccessors.ts +0 -430
  208. package/src/packlets/helpers/fileTreeHelpers.ts +0 -107
  209. package/src/packlets/helpers/index.ts +0 -28
  210. package/src/packlets/url-utils/index.ts +0 -28
  211. package/src/packlets/url-utils/urlParams.ts +0 -245
  212. package/src/test/mocks/idb-keyval.ts +0 -5
  213. package/src/test/setupTests.ts +0 -87
  214. package/src/test/unit/browserHashProvider.test.ts +0 -155
  215. package/src/test/unit/browserHashProvider.test.ts.bak +0 -376
  216. package/src/test/unit/directoryHandleStore.test.ts +0 -251
  217. package/src/test/unit/fileApiTreeAccessors.test.ts +0 -1387
  218. package/src/test/unit/fileApiTypes.test.ts +0 -587
  219. package/src/test/unit/fileSystemAccessTreeAccessors.test.ts +0 -885
  220. package/src/test/unit/fileTreeHelpers.test.ts +0 -694
  221. package/src/test/unit/httpTreeAccessors.test.ts +0 -1571
  222. package/src/test/unit/localStorageTreeAccessors.test.ts +0 -1014
  223. package/src/test/unit/urlParams.test.ts +0 -464
  224. package/src/test/utils/fileSystemAccessMocks.ts +0 -353
  225. package/src/test/utils/testHelpers.ts +0 -155
  226. package/temp/build/typescript/ts_8nwakTlr.json +0 -1
  227. package/temp/coverage/base.css +0 -224
  228. package/temp/coverage/block-navigation.js +0 -87
  229. package/temp/coverage/crypto-utils/browserCryptoProvider.ts.html +0 -1018
  230. package/temp/coverage/crypto-utils/browserHashProvider.ts.html +0 -304
  231. package/temp/coverage/crypto-utils/index.html +0 -131
  232. package/temp/coverage/favicon.png +0 -0
  233. package/temp/coverage/file-tree/directoryHandleStore.ts.html +0 -493
  234. package/temp/coverage/file-tree/fileApiTreeAccessors.ts.html +0 -1669
  235. package/temp/coverage/file-tree/fileSystemAccessTreeAccessors.ts.html +0 -1642
  236. package/temp/coverage/file-tree/httpTreeAccessors.ts.html +0 -1429
  237. package/temp/coverage/file-tree/index.html +0 -176
  238. package/temp/coverage/file-tree/localStorageTreeAccessors.ts.html +0 -1375
  239. package/temp/coverage/helpers/fileTreeHelpers.ts.html +0 -406
  240. package/temp/coverage/helpers/index.html +0 -116
  241. package/temp/coverage/index.html +0 -161
  242. package/temp/coverage/lcov-report/base.css +0 -224
  243. package/temp/coverage/lcov-report/block-navigation.js +0 -87
  244. package/temp/coverage/lcov-report/crypto-utils/browserCryptoProvider.ts.html +0 -1018
  245. package/temp/coverage/lcov-report/crypto-utils/browserHashProvider.ts.html +0 -304
  246. package/temp/coverage/lcov-report/crypto-utils/index.html +0 -131
  247. package/temp/coverage/lcov-report/favicon.png +0 -0
  248. package/temp/coverage/lcov-report/file-tree/directoryHandleStore.ts.html +0 -493
  249. package/temp/coverage/lcov-report/file-tree/fileApiTreeAccessors.ts.html +0 -1669
  250. package/temp/coverage/lcov-report/file-tree/fileSystemAccessTreeAccessors.ts.html +0 -1642
  251. package/temp/coverage/lcov-report/file-tree/httpTreeAccessors.ts.html +0 -1429
  252. package/temp/coverage/lcov-report/file-tree/index.html +0 -176
  253. package/temp/coverage/lcov-report/file-tree/localStorageTreeAccessors.ts.html +0 -1375
  254. package/temp/coverage/lcov-report/helpers/fileTreeHelpers.ts.html +0 -406
  255. package/temp/coverage/lcov-report/helpers/index.html +0 -116
  256. package/temp/coverage/lcov-report/index.html +0 -161
  257. package/temp/coverage/lcov-report/prettify.css +0 -1
  258. package/temp/coverage/lcov-report/prettify.js +0 -2
  259. package/temp/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  260. package/temp/coverage/lcov-report/sorter.js +0 -210
  261. package/temp/coverage/lcov-report/url-utils/index.html +0 -116
  262. package/temp/coverage/lcov-report/url-utils/urlParams.ts.html +0 -820
  263. package/temp/coverage/lcov.info +0 -3597
  264. package/temp/coverage/prettify.css +0 -1
  265. package/temp/coverage/prettify.js +0 -2
  266. package/temp/coverage/sort-arrow-sprite.png +0 -0
  267. package/temp/coverage/sorter.js +0 -210
  268. package/temp/coverage/url-utils/index.html +0 -116
  269. package/temp/coverage/url-utils/urlParams.ts.html +0 -820
  270. package/temp/test/jest/haste-map-7492f1b44480e0cdd1f220078fb3afd8-c8dd6c3430605adeb2f1cadf4f75e791-8c9336785555d572065b28c111982ba4 +0 -0
  271. package/temp/test/jest/jest-transform-cache-7492f1b44480e0cdd1f220078fb3afd8-79ef2876fae7ca75eedb2aa53dc48338/d6/package_d6e3b0fa94752e16b0b2a2777739b973 +0 -53
  272. package/temp/test/jest/perf-cache-7492f1b44480e0cdd1f220078fb3afd8-da39a3ee5e6b4b0d3255bfef95601890 +0 -1
  273. package/temp/ts-web-extras.api.json +0 -8850
  274. package/temp/ts-web-extras.api.md +0 -433
  275. 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` |