microsoft / microsoft/TypeScript
Distinguish missing and undefined also in arguments
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.4k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Suggestion
With the arrival of --strictOptionalProperties, it’s clear that the intent of ? as a modifier isn’t to add | undefined to the type but to distinguish presence from absence.
I propose the same should apply to arguments.
🔍 Search Terms
optional argument, optional arguments, optional parameter, optional parameters
✅ Viability Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code (unless behind a flag)
- 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, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
Given
function optionallyTakesAnArg(arg? : string) {
return arguments.length;
}
calling optionallyTakesAnArg() is not the same as optionallyTakesAnArg(undefined). TypeScript should be able to model this. Specifically it should forbid the second form and only allow either optionallyTakesAnArg() or optionallyTakesAnArg(stringArg).
📃 Motivating Example
This is mostly an issue when the argument is a generic type that may or may not include an explicit undefined:
function optionallyTakesAnArg<T>(arg? : T) {
if(arguments.length > 0) {
// arg passed, do stuff
doStuffWith(arg!);
} else {
// no arg passed, do something else
doOtherStuff();
}
}
💻 Use Cases
I want to model that calling optionallyTakesAnArg<string>() and optionallyTakesAnArg<string>(stringArg) both are valid but that optionallyTakesAnArg<string>(undefined) is not, whereas optionallyTakesAnArg<undefined>() and optionallyTakesAnArg<undefined>(undefined) are (but may not do the same thing).
Further, overloads should be able to distinguish between the latter two cases, e.g. for inference of return types.
This allows arguments whose type is a generic that may include undefined to be modeled correctly.
⚡️ Open issues
- Arrow functions don’t have an arguments object in scope so the only way to implement this would be with rest params and tuples, which means they, too, would need new semantics for
?. - This proposal is at odds with default arguments which always treat absent and undefined the same (
(function(a = 1) { return a })()and(function(a = 1) { return a })(undefined)both evaluate to1). - It’s also possible to model optional args using
optionallyTakesAnArg(arg : string | void), which, AFAICT currently has the same semantics asoptionallyTakesAnArg(arg? : string). I’m not sure whether this should continue to be aligned or not.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Das Issue nennt keine Dateien oder Tests. Beginne damit, die Beispiele für optionale Parameter und das aktuelle Verhalten bei Aufrufen mit ausgelassenen, undefined-, generischen, überladenen, Standard- und Restparametern zu überprüfen. Als erledigt gilt, dass das Typsystem wie vorgeschlagen zwischen Vorhandensein und Abwesenheit unterscheiden kann, ohne das Laufzeitverhalten von JavaScript zu ändern, einschließlich der aufgeführten Bedenken zu Arrow-Funktionen und Standardargumenten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- compilers
- Issue-Typ
- Feature
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 25/100