microsoft / microsoft/TypeScript
Unions of assertion functions do not act as assertion functions
Open
Nobody has claimed this yet.
Bug
Domain: This-Typing
Help Wanted
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.4k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔎 Search Terms
narrowing, assertion function
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about everything
⏯ Playground Link
💻 Code
class box<T> {
constructor(public value: T){}
check(): this is box<string> {
return typeof this.value == 'string';
}
assert(): asserts this is box<string> {
if (typeof this.value != 'string') throw new Error();
}
private test() {
this.assert();
// type correctly narrowed
this.value.substring(0);
}
}
function make() : box<string> | box<number> {
return new box('a');
}
function assert(b: box<string> | box<number>): asserts b is box<string> {
if (typeof b.value != 'string') throw new Error();
}
const b = make();
if (b.check()) {
// type correctly narrowed
b.value.substring(0);
}
b.assert();
// type not narrowed (substring does not exist on type 'string | number')
b.value.substring(0);
assert(b);
// type correctly narrowed
b.value.substring(0);
🙁 Actual behavior
Type is not narrowed after method call
🙂 Expected behavior
I expected the type to be narrowed after method call since it is narrowed within other methods or when using a function external to the type.
Additional information about the issue
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked TypeScript Playground reproduction and compare the narrowing produced by b.check(), b.assert(), and the external assert(b) call. Investigate why the method call does not narrow the union, then verify that the method assertion behaves consistently with the external assertion while preserving the existing successful cases.
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
- Clearly specified
- Newbie friendliness
- 35/100