microsoft / microsoft/TypeScript

filter noUncheckedIndexedAccess with own property check

Offen
#41,848 2 Kommentare 9 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Awaiting More Feedback Suggestion
Vorherrschende Sprache
Go
Sterne
111k
Forks
14.4k
Ø Merge
1 T. 19 Std.
Gemergte PRs (30 T.)
117

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit dem bereitgestellten TypeScript-Reproducer und untersuchen Sie, wie noUncheckedIndexedAccess und Object.prototype.hasOwnProperty.call vom Type Checker behandelt werden. Bestätigen Sie die aktuelle Diagnose und bestimmen Sie anschließend, ob der indizierte Zugriff eingegrenzt werden kann, ohne das erzeugte JavaScript zu ändern; als abgeschlossen gilt die Aufgabe, wenn das Beispiel mit einer Regressionstestabdeckung für dieses Verhalten den Type Check besteht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
compilers
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.