microsoft / microsoft/TypeScript
Add type definitions for Files And Directories API
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
"Files And Directories API"
FileSystemFileEntry
Suggestion
Add types for the Files And Directories API: https://wicg.github.io/entries-api/
Specifically:
FileSystemEntryFileSystemDirectoryEntryFileSystemDirectoryReaderFileSystemFileEntryFileSystem
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Files And Directories API specification at https://wicg.github.io/entries-api/ and the existing TypeScript declaration patterns. Done means adding types for FileSystemEntry, FileSystemDirectoryEntry, FileSystemDirectoryReader, FileSystemFileEntry, and FileSystem without changing JavaScript runtime behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100