Microsoft/TypeScript

Diagnostic for incompatible overload signature doesn't explain why

Open

#48,186 opened on Mar 9, 2022

View on GitHub
 (1 comment) (6 reactions) (0 assignees)TypeScript (6,726 forks)batch import
BugDomain: Error MessagesHelp Wanted

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Bug Report

🔎 Search Terms

function incompatible overload implementation signature assignability TS2394

🕗 Version & Regression Information

  • This is the behavior in every version I tried, and I reviewed the FAQ for entries about function overloads

⏯ Playground Link

Playground link with relevant code

💻 Code

function example(overloaded: string): string;
function example(actual: number, option?: boolean): string {
  return `${actual}${option}`;
}

🙁 Actual behavior

A single line of error message that doesn't indicate which parameter or return type is the issue.

function example(overloaded: string): string;
//       ~~~~~~~
// Error: This overload signature is not compatible with its implementation signature.

🙂 Expected behavior

Can we elaborate on that error message with the first assignability issue?

Bikeshedding on the error message specifics welcome...

function example(overloaded: string): string;
//       ~~~~~~~
// Error: This overload signature is not compatible with its implementation signature.
//   Overload parameter 'overload: string' is not assignable to implementation parameter 'actual: number'.

Contributor guide