Microsoft/TypeScript

JsDoc with overloads and different generics results in wrong dts output

Open

#59 980 ouverte le 16 sept. 2024

Voir sur GitHub
 (1 commentaire) (1 réaction) (0 assignés)TypeScript (6 726 forks)batch import
BugDomain: JSDocHelp Wanted

Métriques du dépôt

Stars
 (48 455 stars)
Métriques de merge PR
 (Merge moyen 6j 17h) (9 PRs mergées en 30 j)

Description

🔎 Search Terms

javascript jsdoc dts overload

🕗 Version & Regression Information

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

⏯ Playground Link

https://www.typescriptlang.org/play/?ts=5.6.2&filetype=js#code/PQKhFgCgAIWgBALgUwLYAcA2BDF0DeAzogE4CWAdgOYC+0AopmshYlLAgPYBuyJmnbABN2ceOmwlsqAo2as6yJqhZsYYkskQBXEhUIEAFAEpoAXgB80bpzJCao4FCigI6hCgw48+AEadOJmwKOjkVVlEuXn5BEXdxSWlZZVVFFIj4zR09A3wTcysbOwd1J0gXMEj4Hj4BYSqJKRl8Cm1UXz40+TUOeCzdfSNTS2tbe0dnSFcGxObggE8u8J6QMuQAD3ROEkRoADNtCgBjRDJOCmhzwyVu03woAEh+vWh8kfwSkqA

💻 Code

/**
 * @template {string} Element
 * @overload
 * @param {Element} element
 * @returns {() => void}
 */

/**
 * @template {boolean} Element
 * @overload
 * @param {Element} element
 * @returns {() => void}
 */

/**
 * @overload
 * @param {number} element
 * @returns {() => void}
 */

/**
 * @param {any} element
 */
export function on(element) {
	return () => {}
}

🙁 Actual behavior

The resulting dts of the given JSDoc looks like this:

export function on<Element extends string>(element: Element): () => void;
export function on<Element extends string>(element: Element): () => void;
export function on(element: number): () => void;

As you can see the generic does extends string both times, but it should be extends boolean the second time

🙂 Expected behavior

export function on<Element extends string>(element: Element): () => void;
export function on<Element extends boolean>(element: Element): () => void;
export function on(element: number): () => void;

Additional information about the issue

No response

Guide contributeur