Microsoft/TypeScript

Document the Iterator, Iterable, IterableIterator types

Open

#49.526 aperta il 13 giu 2022

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)TypeScript (6726 fork)batch import
BugDomain: lib.d.tsHelp Wanted

Metriche repository

Star
 (48.455 star)
Metriche merge PR
 (Merge medio 6g 17h) (9 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina le definizioni di tipo esistenti per IterableIterator, Iterable e Iterator nei file lib di TypeScript e proponi commenti di documentazione chiari che spieghino le loro differenze e utilizzo.
Tech stack
typescript
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
TypeScript basics
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90