Overloads Are Not Generated as Expected When Using @Overload Tag to Declare Overloads of Functions Assigned to a Prototype

[philippfromme]

Bug Report

When using the @overload tag to declare overloads of functions assigned to a prototype (e.g. Foo.prototype.bar) the overloads are not generated as expected. However, for functions that are not assigned to a prototype it works.

🔎 Search Terms

overload

🕗 Version & Regression Information

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

⏯ Playground Link

Playground link with relevant code

💻 Code

Type declarations are generated for the following code:

export function Foo() {}

/**
 * @overload
 * @param {string} a
 *
 * @return {void}
 */

/**
 * @overload
 * @param {number} a
 * @param {string} b
 *
 * @return {void}
 */

/**
 * @param {string|number} a
 * @param {string} [b]
 *
 * @return {void}
 */
Foo.prototype.bar = function(a, b) {}

🙁 Actual behavior

export function Foo(): void;
export class Foo {
    /**
     * @overload
     * @param {string} a
     *
     * @return {void}
     */
    /**
     * @overload
     * @param {number} a
     * @param {string} b
     *
     * @return {void}
     */
    /**
     * @param {string|number} a
     * @param {string} [b]
     *
     * @return {void}
     */
    bar(a: string | number, b?: string): void;
}

🙂 Expected behavior

export function Foo(): void;
export class Foo {
    /**
     * @overload
     * @param {string} a
     *
     * @return {void}
     */
    /**
     * @overload
     * @param {number} a
     * @param {string} b
     *
     * @return {void}
     */
    /**
     * @param {string|number} a
     * @param {string} [b]
     *
     * @return {void}
     */
    bar(a: string): void;

    bar(a: number, b?: string): void;
}

Compare this to generating type declarations for the following code:

/**
 * @overload
 * @param {string} a
 *
 * @return {void}
 */

/**
 * @overload
 * @param {number} a
 * @param {string} b
 *
 * @return {void}
 */

/**
 * @param {string|number} a
 * @param {string} [b]
 *
 * @return {void}
 */
export function bar(a, b) {}

Result:

export function bar(a: string): void;
export function bar(a: number, b: string): void;