microsoft / microsoft/TypeScript

Type guards can't deal with unknown type as default

Open
#37,905 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

We can't know the failures of type inference in type guards because of this problem. Maybe a is any[] should also return unknown[].

TypeScript Version: 3.7.x-dev.20200410

Search Terms:

Code

declare function f(a: any): a is any[];
declare function g(a: any): a is unknown[];
declare const a: readonly number[];

f(a) && a; // any[]
g(a) && a; // not unknown[]

Expected behavior:
a's type narrowed by g is unknown[].
Actual behavior:
a's type narrowed by g is readonly number[] & unknown[].

Playground Link: https://www.typescriptlang.org/play/?ts=3.9.0-dev.20200410&ssl=1&ssc=1&pln=6&pc=11#code/CYUwxgNghgTiAEAzArgOzAFwJYHtVIAooAueKVATwEpSp4sBnMygbQF0BuAKFElgRTpseeAHMitSjTL0maANaocAd1TtuvaHHhg8DDGVJwowPBArxUyALYAjEDHVcuiIlXgAyD2W7io7rx8gA

Related Issues: #17002

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

Reproduce the narrowing behavior in the linked TypeScript Playground using the declarations for f, g, and readonly number[] a, then inspect the type-guard narrowing logic. Done means that g(a) narrows a to unknown[] as expected, with the behavior covered by a regression test; related issue #17002 may provide context.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.