Microsoft/TypeScript

Add type definitions for Files And Directories API

Offen

#29.548 geöffnet am 23.01.2019

Auf GitHub ansehenContributor Guide
 (9 Kommentare) (20 Reaktionen) (0 zugewiesene Personen)TypeScript (13.395 Forks)batch import
Domain: lib.d.tsHelp WantedIn DiscussionSuggestion

Repository-Metriken

Stars
 (108.860 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Beginnen Sie mit dem Lesen der Spezifikation unter https://wicg.github.io/entries api/, um die Schnittstelle zu verstehen. Untersuchen Sie dann die vorhandenen Typdefinitionen im TypeScript Repository unter src/lib/, um den Stil nachzuahmen. Das Issue fordert Definitionen für FileSystemEntry, FileSystemDirectoryEntry, FileSystemDirectoryReader, FileSystemFileEntry und FileSystem. Es gibt keine verknüpften PRs, daher handelt es sich um eine neue Aufgabe.
Tech Stack
typescript
Domain
toolingdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
TypeScriptGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70