microsoft / microsoft/TypeScript

Correct typing when using the index signature of an Enum

Open
#31,285 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

In Discussion Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

enum index signature

Suggestion

Imagine a non const enum (which can be accessed using properties and it's index signature).

enum example { ONE = 1, TWO = 2, THREE = 3 }

const a = example.ONE;
console.log(a); // Prints 1

const aName = example[a]; // Type of aName is string and should be "ONE" | "TWO" | "THREE". Or even "ONE" since a is const
console.log(aName); // Prints "ONE";

The implicit type of aName is string and should be "ONE" | "TWO" | "THREE" since those are the only possible values. Or even "ONE" since a is a constant.

Use Cases

More control over the values of a variable.

Examples

See above

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.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reproducing the enum index-signature example from the issue and inspect the type-checking entry points that determine the type of example[a]. Compare the inferred result with the requested union of enum member names, including whether the constant value should narrow it to "ONE". Done means the intended type is inferred without changing emitted JavaScript and the relevant type-checking tests pass.

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
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.