Microsoft/TypeScript

Confusing error when destructuring and overwriting with a wrong type

Open

#44,165 opened on May 19, 2021

View on GitHub
 (4 comments) (1 reaction) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
BugDomain: Error MessagesHelp Wanted

Description

Bug Report

I noticed it because I put the spread at the bottom instead of top, but I had a hard time finding my mistake because of this. It's easy to spot if the object is small like in this example, but in my case the error and the spread was separated by multiple lines. Any other suggested error would be much clearer, but this confused me very much.

🔎 Search Terms

destructuring, spread, error reporting

🕗 Version & Regression Information

  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about destructuring, spread, error reporting

⏯ Playground Link

Playground link with relevant code

💻 Code

interface Test {
  foo: boolean;
}

interface LesserTest {
  foo?: boolean | null;
}

const bar: LesserTest = {
  foo: null
}

const barWrong: Test = {
  foo: true, // Type 'boolean | null' is not assignable to type 'boolean'.
  ...bar
}

// Type '{ foo?: boolean | null | undefined; }' is not assignable to type 'Test'. - such error would be much better
const barRight: Test = {
  ...bar
}

🙁 Actual behavior

The same property will be overwritten with a wrong type, but the error is reported in a wrong place, where the type is correct.

🙂 Expected behavior

The error should be reported on the destructured variable where the type is wrong or in the main variable barWrong.

I also noticed that if those types would match we get an error 'foo' is specified more than once, so this usage will be overwritten. which is also much better.

Contributor guide