microsoft / microsoft/TypeScript

Suggesion: Allow recursive/self-references in `satisfies` constraint

Ouverte
#54,367 6 commentaires 5 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Domain: Something Else Possible Improvement
Langage dominant
Go
Étoiles
111k
Forks
14.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Suggestion

🔍 Search Terms

satisfies keyword, recursion, recursive, constraint, self referential

✅ Viability Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code

    It would only make previously rejected type assertions possible as it only widens the set of valid type restrictions.

  • This wouldn't change the runtime behavior of existing JavaScript code

    satisfies only exists during type checking and does not in generated JavaScript

  • This could be implemented without emitting different JS based on the types of the expressions

    As above

  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)

    As above

  • This feature would agree with the rest of TypeScript's Design Goals.

    The same is already possible using a constrained identity function

⭐ Suggestion

It is currently not possible to reference the type of a variable that the satisfies constraint is applied on. Enabling this functionality should not be hard, as the same behavior can be recreated using a constrained identity function, see below. This would enable more precise verification of structures by the type checker.

📃 Motivating Example

// I define a (very simplified) state machine by the following type:
type States<S extends string> = Record<S, S>;

// I can then define a map of machine names to their states records:
const myMachines1 = {
  alan: {
    a: "b",
    b: "c",
    c: "c",
  },
  turing: {
    x: "y",
    y: "x",
  },
} satisfies Record<string, States<string>>;

// Problem: This is possible, though should be invalid:
const myMachines2 = {
  foo: {
    a: "x",
  },
  bar: {
    x: "a",
  }
} satisfies Record<string, States<string>>;

// Solution 1: Identity function with self-referential generic:
function defineMachines<T extends {
  [name in keyof T]: States<keyof T[name] & string>;
}>(machines: T) {
  return machines;
}

// Valid:
const myMachines3 = defineMachines({
  alan: {
    a: "b",
    b: "c",
    c: "c",
  },
  turing: {
    x: "y",
    y: "x",
  },
});

// Errors:
const myMachines4 = defineMachines({
  foo: {
    a: "x",
  },
  bar: {
    x: "a",
  }
});

// Solution 2: The same behavior should be achievable using the new `satisfies` keyword:
const myMachines5 = {
  foo: {
    a: "x",
  },
  bar: {
    x: "a",
  }
} satisfies {
  [name in keyof typeof myMachines5]: States<keyof typeof myMachines5[name] & string>;
};
// But errors: Block-scoped variable 'myMachines5' used before its declaration.

💻 Use Cases

As seen in the example above, this allows for a more precise control over (nested) type restrictions. It is already possible to self-reference type definitions, so why shouldn't this also be possible for variable declarations? The satisfies keyword does not modify the type itself to my knowledge.

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 les exemples motivants de satisfies et comparez l’autoréférence rejetée avec la solution fondée sur une fonction identité contrainte. Déterminez comment les contraintes récursives devraient se comporter pour les déclarations de variables, puis vérifiez que les maps valides de machines à états sont acceptées et que les références croisées invalides sont rejetées sans modifier la sortie à l’exécution.

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
30/100

Recevez les nouvelles issues par e-mail

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