microsoft / microsoft/TypeScript

Flexibility of template literal types for enums

Ouverte
#41,649 2 commentaires 3 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

Search Terms

template literal type enum permutations

Suggestion

Typescript 4.1 brought template literal types, which make it simple to express all the possibilities of permutations of unions of string types concatenated together. It would be cool if there was some equivalent syntax for expressing enum key/value pairs with the same level of expressivity that template literal types provide.

Use Cases

However, my codebase right now uses enums for these kinds of string types, so if I want to express a bunch of permutations of possible values with an enum, I can't really leverage template literal types in this case.

Examples

this is just some syntax I'm making up, I don't know how this would work especially for dealing with keys and values separately:

enum Color {
  RED,
  BLUE
}
enum Shape {
  SQUARE,
  CIRCLE
}
enum ColoredShape {
  [`${keyof Color}_${keyof Shape}`]
}

console.log(ColoredShape.RED_SQUARE, ColoredShape.BLUE_CIRCLE)

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.
    • I think?

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 examiner l’interaction proposée dans l’issue entre les template literal types et les paires clé/valeur d’enum. Le payload ne mentionne aucun fichier, test ou point d’entrée, et la syntaxe et la sémantique restent spéculatives. La tâche ne serait considérée comme terminée qu’une fois qu’une conception arrêtée des permutations d’enum ainsi qu’un plan clair d’implémentation et de validation seraient définis.

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é
À clarifier
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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