Microsoft/TypeScript

Add type definitions for Files And Directories API

Open

#29,548 opened on Jan 23, 2019

View on GitHub
 (9 comments) (20 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
Domain: lib.d.tsHelp WantedIn DiscussionSuggestion

Description

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.

Contributor guide

Tech stack
typescript
Domain
frontenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript type systemFiles and Directories API spec
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Start by reading the specification at https://wicg.github.io/entries api/ to understand the interface. Then examine existing type definitions in the TypeScript repository under src/lib/ to mimic the style. The issue requests definitions for FileSystemEntry, FileSystemDirectoryEntry, FileSystemDirectoryReader, FileSystemFileEntry, and FileSystem. No linked PRs exist, so this is a fresh task.