microsoft / microsoft/TypeScript
Flexibility of template literal types for enums
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the issue's proposed interaction between template literal types and enum key/value pairs. The payload names no files, tests, or entry points, and the syntax and semantics remain speculative. Done would require a settled design for enum permutations and a clear implementation and validation plan.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100