microsoft / microsoft/TypeScript
Type Math.min & Math.max using generic
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Go
- Sterne
- 111k
- Forks
- 14.3k
- Ø Merge
- 1 T. 19 Std.
- Gemergte PRs (30 T.)
- 117
Beschreibung
Search Terms
- Math.min generic
- Math.max generic
Suggestion
Currently, Math.min is typed as:
min(...values: number[]): number;
However, I would like to change the definition to:
min<T extends number>(...values: [T, ...T[]]): T;
min(): number; // Because this will return Infinity
Because Math.min should never return things that aren't its input. (Except when non-number is passed in, then it'll return NaN. But that's impossible with this typing.)
(Okay, there's another case: if no value is passed in, it'll return Infinity. Unfortunately, there's no literal type for Infinity so we can't type that correctly. And AFAIK there's no way to force at least 1 parameter with rest args. Updated: there is, using tuple type: [T, ...T[]]. Proposal updated. Still, it would be nice to have literal Infinity type.)
(The same applies with Math.max, except Infinity is now -Infinity)
Use Cases
Let's say I have this type:
type TBankNoteValues = 1 | 5 | 10 | 20 | 50 | 100;
And I want to know what is the highest-value banknote I have in the array. I could use Math.max to find that out. But with the current typing, the return value isn't guaranteed to be TBankNoteValues.
let values: TBankNoteValues[] = [50, 100, 20];
let maxValues = Math.max(...values); // number
And now I can't pass maxValues to a function that expects TBankNoteValues anymore.
Examples
type TBankNoteValues = 1 | 5 | 10 | 20 | 50 | 100;
let values: TBankNoteValues[] = [50, 100, 20];
let maxValues = Math.max(...values);
// Current type: number
// Expected type: TBankNoteValues
Checklist
My suggestion meets these guidelines:
- This wouldn't be a breaking change in existing TypeScript/JavaScript code
Shouldn't be any. Anything that expects the old signature, TypeScript should just inferTtonumber.- Now that I think about it, this make the return type of the function narrows down. So, it could make type inference on a variable declaration changes unexpectedly. An explicit type annotation should fix this.
- 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
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
Beginne damit, das im verlinkten TypeScript Playground enthaltene Banknotenbeispiel zu reproduzieren und die im Issue beschriebenen Deklarationen von Math.min und Math.max zu überprüfen. Vergleiche die vorgeschlagenen generischen Tupelsignaturen mit dem bestehenden Verhalten von TypeScript, einschließlich Aufrufen ohne Argumente; abgeschlossen ist die Aufgabe, wenn das Design validiert und seine Kompatibilitätsauswirkungen geklärt sind.
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
- 30/100