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 (6,726 forks)batch import
Domain: lib.d.tsHelp WantedIn DiscussionSuggestion

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

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

Research direction
Investigate the existing TypeScript lib.d.ts files, particularly the DOM APIs. Study the WICG entries api spec and implement the type definitions for the listed interfaces, ensuring they match the TypeScript coding style and declaration patterns.
Tech stack
typescript
Domain
toolingdeveloper 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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70