microsoft / microsoft/TypeScript

filter noUncheckedIndexedAccess with own property check

Ouverte
#41,848 2 commentaires 9 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Search Terms

ownProperty

hasOwnProperty

noUncheckedIndexedAccess

type check

Suggestion

noUncheckedIndexedAccess is a great feature. However, ts reports that object can be undefined even with hasOwnProperty check.

I suggest that a hasOwnProperty check makes unchecked indexed accesses checked, and return the checked value.

Use Cases

const obj: {[key: string]: string} = {};
// do something with obj
const key = "someKey";
if (Object.prototype.hasOwnProperty.call(obj, key)) {
  console.log(obj[key].length); // TS2532: Object is possibly 'undefined'.
}

Since only string values are allowed in obj, the only case such value is undefined is when the key does not exist on obj. The value of obj[key] can only be string. However, typescript still reports type of obj[key] being string | undefined.

Examples

const obj: {[key: string]: string} = {};
// do something with obj
const key = "someKey";
if (Object.prototype.hasOwnProperty.call(obj, key)) {
  console.log(obj[key].length); // no problem, since obj[key] has correct type string
}

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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

Commencez par le reproducer TypeScript fourni et examinez la manière dont le type checker traite noUncheckedIndexedAccess et Object.prototype.hasOwnProperty.call. Confirmez le diagnostic actuel, puis déterminez si l’accès indexé peut être raffiné sans modifier le JavaScript généré ; le travail est considéré comme terminé lorsque l’exemple passe le type check avec une couverture de régression pour ce comportement.

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

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

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