Microsoft/TypeScript

Document the Iterator, Iterable, IterableIterator types

Open

#49,526 opened on Jun 13, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Repository metrics

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

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

Contributor guide

Research direction
Examine the existing type definitions for IterableIterator, Iterable, and Iterator in the TypeScript lib files, and propose clear documentation comments explaining their differences and usage.
Tech stack
typescript
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
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
TypeScript basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90