Microsoft/TypeScript

Document the Iterator, Iterable, IterableIterator types

Open

#49 526 ouverte le 13 juin 2022

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)TypeScript (6 726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Métriques du dépôt

Stars
 (48 455 stars)
Métriques de merge PR
 (Merge moyen 6j 17h) (9 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez les définitions de type existantes pour IterableIterator, Iterable et Iterator dans les fichiers lib de TypeScript et proposez des commentaires de documentation clairs expliquant leurs différences et leur utilisation.
Stack technique
typescript
Domaine
backend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90