microsoft / microsoft/TypeScript

`ReadonlyMap` lacks documentation for `forEach`, `get`, `has` and `size`

Aperta Adatta ai principianti
#63,710 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Domain: lib.d.ts Possible Improvement
Lingua principale
Go
Stelle
111k
Fork
14.3k
Merge medio
2g 4h
PR unite (30g)
132

Descrizione

### ⚙ Compilation target

ES2015+

### ⚙ Library

lib.es2015.collection.d.ts

### Missing / Incorrect Definition

`ReadonlyMap` lacks documentation for `forEach`, `get`, `has` and `size`.

Hovering these members in an editor shows no description, unlike the corresponding members of `Map`. The documentation should ideally be copied from regular `Map` for consistency, exactly as was done for `ReadonlySet` in #63481 (fixed by #63483).

Note: the `ReadonlyMap` members declared in lib.es2015.iterable.d.ts (`entries`, `keys`, `values` and `[Symbol.iterator]`) are already documented; only the four members declared in lib.es2015.collection.d.ts lack documentation.

### Sample Code

```ts
declare const m: ReadonlyMap;

// Hover any of these: no documentation is shown
m.get("a");
m.has("a");
m.size;
m.forEach(v => console.log(v));
```

### Documentation Link

_No response_

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Apri lib.es2015.collection.d.ts e confronta i membri documentati di Map con forEach, get, has e size su ReadonlyMap. Verifica la coerenza della modifica alla documentazione di ReadonlySet di #63481/#63483. Il lavoro è completato quando gli hover dell’editor mostrano descrizioni per tutti e quattro i membri di ReadonlyMap corrispondenti alla documentazione di Map.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
90/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.