microsoft / microsoft/TypeScript

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

Ouverte Adaptée aux débutants
#63,710 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Domain: lib.d.ts Possible Improvement
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

⚙ Compilation target

ES2015+

⚙ Library

lib.es2015.collection.d.ts

Missing / Incorrect Definition

ReadonlyMap<K, V> lacks documentation for forEach, get, has and size.

Hovering these members in an editor shows no description, unlike the corresponding members of Map<K, V>. The documentation should ideally be copied from regular Map<K, V> for consistency, exactly as was done for ReadonlySet<T> 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
declare const m: ReadonlyMap<string, number>;

// 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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Ouvrez lib.es2015.collection.d.ts et comparez les membres documentés de Map<K, V> avec forEach, get, has et size sur ReadonlyMap<K, V>. Vérifiez la cohérence de la modification de la documentation de ReadonlySet de #63481/#63483. C’est terminé lorsque les info-bulles de l’éditeur affichent des descriptions pour les quatre membres de ReadonlyMap correspondant à la documentation de Map correspondante.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
90/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.