microsoft / microsoft/TypeScript

Type narrowing for awaited values

Open
#30,551 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Search Terms

promise, type narrowing, await

Suggestion

The type narrowing that occurs inside if statements, should work with awaited values

Though generally speaking a type is used for values that are already

Examples

type A = {
  kind: 'a'
  a: string
}

type B = {
  kind: 'b'
  b: string
}

let data: A | B

async function valueTest() {
  if ((await data.kind) === 'a') {
    // 'data' hasn't been narrowed to type 'A'
    data.a // Error
  }

  // Works fine without await
  if (data.kind === 'a') {
    data.a // Okay
  }
}

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

No implementation files or tests are named. Start by reproducing the TypeScript example with a discriminated union and an awaited property check, then trace how control-flow type narrowing handles the await expression. Done means the subsequent data.a access is accepted when the awaited kind is 'a', without changing emitted JavaScript.

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.