microsoft / microsoft/TypeScript

switch (typeof something) isn't seen as exhaustive

Open
#56,786 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Domain: check: Control Flow Help Wanted Possible Improvement
Dominant language
Go
Stars
111k
Forks
14.4k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔎 Search Terms
  • typeof
  • switch
  • narrow
  • type guard
🕗 Version & Regression Information
  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about Type Guards
⏯ Playground Link

https://www.typescriptlang.org/play?ts=5.3.2#code/GYVwdgxgLglg9mABBAFgUwgawIIBtcA8AKgHwAUAznALZpQoxgDmAXIkQJRtGIDeAUIkQUA7jCipEZKAE8ADmjjBhNOg2Yc+gocgCGFNIgBEYENQBGaAE5GW2oRH2Gj5mE0ZRb9vQePm4cLhoumBeOj7OFDIWgWE6jr5G4AAmaMCMaMlxDk7GoJCwCNkRxnDmAFYYnnbhCZFQVoxMxUJWdCBWSFS09E0A3NoAvvyDQA

💻 Code
function checkAll<T>(something: T): T {
  switch (typeof something) {
    case "number":
    case "bigint":
    case "boolean":
    case "symbol":
    case "undefined":
    case "function":
    case "object":
    case "string":
      return something;
  }
}
🙁 Actual behavior

This emits the TS error: "Function lacks ending return statement and return type does not include 'undefined'.(2366)"

🙂 Expected behavior

No error, since all possible results of typeof are handled.

Additional information about the issue

It seems to only be an issue when the function argument is generic. It works if I switch the return type and parameter types to any, but I'm not sure that's a fair comparison.

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 running the provided TypeScript Playground reproduction and compare the generic function with the any version. Trace how typeof narrowing and switch exhaustiveness are handled for generic types, then add a regression test showing that all typeof cases satisfy the return type without TS2366.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.