microsoft / microsoft/TypeScript
Add alternative to `extends` that performs shallow excess property checking
Personne n'a encore pris cette issue.
- Langage dominant
- Go
- Étoiles
- 111k
- Forks
- 14.4k
- Merge moyen
- 1 j 19 h
- PR mergées (30 j)
- 117
Description
Search Terms
excess property check exact strict extends
Suggestion
I'm proposing an extends! operator that does excess property checking.
Use Cases
I specifically would like this for testing types. It would be helpful for having a check like
expectTypeOf<{a: 1, b: 1}>().toBeAssignableTo<{a?: 1}>();
Also for type-checking props of React components, TypeScript uses excess property checking:
<Component propExists propDoesntExist />
^^^^^^^^^^^^^^^
so it's not enough to just check Props extends React.ComponentProps<Component> ? true : false to determine TypeScript would give a type error in this scenario.
I'm currently approximating this by doing something similar to:
Props extends React.ComponentProps<Component>
? keyof Props extends keyof React.ComponentProps<Component>
? true
: false
: false;
Examples
// `true`
type Example1 = {a: 1, b: 1} extends {a?: 1} ? true : false;
// `false`
type Example2 = {a: 1, b: 1} extends! {a?: 1} ? true : false;
// `true`
type Example3 = {a: 1} extends! {a?: 1} ? true : false;
// Type 'keyof T' cannot be used to index type 'U'.(2536)
type Example1<T, U> = T extends U ? U[keyof T] : never;
^^^^^^^
// Okay
type Example2<T, U> = T extends! U ? U[keyof T] : never;
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
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Commencez par les exemples de extends! de la proposition et par le comportement existant de la vérification des propriétés excédentaires décrit pour les tests de types et les props des composants React. Définissez la sémantique prévue de l’opérateur et ses cas limites, puis vérifiez que les exemples distinguent l’assignabilité ordinaire de la vérification superficielle des propriétés excédentaires.
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é
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 35/100