Microsoft/TypeScript

Document the Iterator, Iterable, IterableIterator types

Open

#49.526 aberto em 13 de jun. de 2022

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (6.726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Métricas do repositório

Stars
 (48.455 stars)
Métricas de merge de PR
 (Mesclagem média 6d 17h) (9 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Examine as definições de tipo existentes para IterableIterator, Iterable e Iterator nos arquivos lib do TypeScript e proponha comentários de documentação claros explicando suas diferenças e uso.
Pilha de tecnologia
typescript
Domain
backend
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
TypeScript basics
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90