Add type definitions for Files And Directories API

[fr0]

Search Terms

"Files And Directories API"
FileSystemFileEntry

Suggestion

Add types for the Files And Directories API: https://wicg.github.io/entries-api/

Specifically:

• FileSystemEntry
• FileSystemDirectoryEntry
• FileSystemDirectoryReader
• FileSystemFileEntry
• FileSystem

Use Cases

Handling drag/drop of multiple files and/or folders, and gleaning extra information about the dropped files (which is what the API provides).

Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

[weswigham]

PRs welcomed. You can find more information about contributing lib.d.ts fixes at https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md#contributing-libdts-fixes.

[p85]

newcomer here.
in which file would i put the type definitions?

[saschanaz]

Adding this would only partially help Firefox which even does have some wrong method signatures. All others implement it with webkit prefix attached.

[HolgerJeromin]

This API is IMO not ready for including in TS:
https://github.com/microsoft/TSJS-lib-generator#when-should-a-dom-api-be-included-here

This specification was published by the Web Platform Incubator Community Group. It is not a W3C Standard nor is it on the W3C Standards Track.

[fernap3]

FWIW I drafted the declarations based on the current state of https://wicg.github.io/native-file-system.

https://github.com/fernap3/native-file-system-types/blob/master/native-file-system.d.ts

Happy to receive feedback if anyone wants to contribute.

[gnusiva]

looks like there are official types available.
https://www.npmjs.com/package/@types/wicg-file-system-access

[youk]

https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wicg-file-system-access

[HenningCash]

Just stumbled across this issue. The initial request of this issues asks for types for the non-standard "File and Directory Entries API". @types/wicg-file-system-access are types for the "File System Access API". (And be warned, there is also a third obsolete W3C draft for JS file system access)

Currently, there are more browsers supporting the entries-api than the native-file-system API:
https://caniuse.com/mdn-api_filesystementry
https://caniuse.com/mdn-api_filesystemhandle
It's still undecided whether Firefox will implement the native file system API: https://mozilla.github.io/standards-positions/#native-file-system.
atm Firefox only supports the non-standardized Entries API, even if access to it is prefixed with webkit*: https://developer.mozilla.org/en-US/docs/Web/API/File_and_Directory_Entries_API/Firefox_support

So... this is the short summary of JS file-system APIs in early 2021.

⚠️ Edit:
DefinitelyTyped now also provides types for the Entries API:
https://www.npmjs.com/package/@types/wicg-entries-api
https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/wicg-entries-api

[jonkoops]

I think this issue can be closed, this is now part of the DOM types so should be fully supported.