microsoft / microsoft/TypeScript

Conditional types don't work with Mapped types when you extend enum keys

Open
#27,022 0 comments 0 reactions 1 assignee View on GitHub

@weswigham is already working on this.

Since Sep 21, 2018.

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

Description

TypeScript Version: 3.0.3, 3.1.0-dev.20180907

Search Terms:
mapped, conditional, enum, extends
Code

enum Commands {
  one = "one",
  two = "two",
  three = "three"
}

const SpecialCommandsObj = {
  [Commands.one]: Commands.one,
  [Commands.two]: Commands.two,
};

// a and b are correct
type a = Commands.one extends keyof typeof SpecialCommandsObj ? null : any; // null - ok
type b = Commands.three extends keyof typeof SpecialCommandsObj ? null : any; // any - ok

interface CommandAction {
  execute(element: any): any;
}

interface SpecialCommandAction {
  execute(element: null): any;
}

type CommandsActions = {
    [Key in keyof typeof Commands]:  Key extends keyof typeof SpecialCommandsObj ? SpecialCommandAction : CommandAction
};

const Actions: CommandsActions = {
  [Commands.one]: {
      // ERROR
    execute: (element) => {} // ELEMENT IS ANY, NOT NULL
  },
  [Commands.two]: {
      // ERROR
    execute: (element) => {} // ELEMENT IS ANY, NOT NULL
  },
  [Commands.three]: {
    execute: (element) => {}
  },
}

Expected behavior:
In the Actions object the argument of the execute method for Commands.one and Commands.two should be of type null, not any
Actual behavior:
element is always any,

type inference for type a and b are fine so it only occurs when you use mapped types

it works if you don't use enums as keys in SpecialCommandObj. Swap your SpecialCommandsObj with this one and it will start working

const SpecialCommandsObj = {
  "one": Commands.one,
  "two": Commands.two,
};

Playground Link: https://bit.ly/2QmdTIo

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.