Microsoft/TypeScript

Document the Iterator, Iterable, IterableIterator types

Open

#49.526 geöffnet am 13. Juni 2022

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (6.726 Forks)batch import
BugDomain: lib.d.tsHelp Wanted

Repository-Metriken

Stars
 (48.455 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 6T 17h) (9 gemergte PRs in 30 T)

Beschreibung

lib Update Request

Configuration Check

My compilation target is ES2020 and my lib is the default.

Missing / Incorrect Definition

IterableIterator, Iterable, Iterator

Sample Code

While working on some VS Code api, we realized we don't understand what an IterableIterator is compared to Iterable. It would be helpful to document these interfaces because they are used in the stdlib and for any code authors who may be using them too

const m = new Map();
m.entries() // look at type here

Documentation Link

Unsure

Contributor Guide

Research-Richtung
Untersuchen Sie die vorhandenen Typdefinitionen für IterableIterator, Iterable und Iterator in den TypeScript Lib Dateien und schlagen Sie klare Dokumentationskommentare vor, die deren Unterschiede und Verwendung erklären.
Tech Stack
typescript
Domain
backend
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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
TypeScript basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90