JSDoc: @inheritDoc disregards optionality of parameters from parent class method

[jumpinjackie]

TypeScript Version: 3.8.3

Search Terms: inheritDoc optionality jsdoc

Code

A conceptual example of JSDoc-annotated ES6 classes I'm generating d.ts definitions for

class Base {
  /**
   * @abstract
   * @param {Array<import("./Layer.js").default>} [opt_array] Array of layers (to be
   *     modified in place).
   * @return {Array<import("./Layer.js").default>} Array of layers.
   */
  getLayersArray(opt_array) {
    return abstract();
  }
}

class Derived extends Base {
  /**
   * @inheritDoc
   */
  getLayersArray(opt_array) {
      return [];
  }
}

Expected behavior:

TypeScript to transpile this to something resembling this

declare class Base {
    /**
     * @abstract
     * @param {Array<import("./Layer.js").default>} [opt_array] Array of layers (to be
     *     modified in place).
     * @return {Array<import("./Layer.js").default>} Array of layers.
     */
    getLayersArray(opt_array?: any[]): any[];
}
declare class Derived extends Base {
    /**
     * @inheritDoc
     */
    getLayersArray(opt_array?: any): any[];
}

Actual behavior:

The optionality specifier is lost on Derived.getLayersArray

declare class Base {
    /**
     * @abstract
     * @param {Array<import("./Layer.js").default>} [opt_array] Array of layers (to be
     *     modified in place).
     * @return {Array<import("./Layer.js").default>} Array of layers.
     */
    getLayersArray(opt_array?: any[]): any[];
}
declare class Derived extends Base {
    /**
     * @inheritDoc
     */
    getLayersArray(opt_array: any): any[];
}

Playground Link:

https://www.typescriptlang.org/play/?useJavaScript=true#code/MYGwhgzhAEBCkFNoG8CwAoa0D0AqXGW0u0AAmAEYQAuATmMNYViaQA5j0C2KAgrfQCeAHgCWXNgHta1ABQAiAHTYAMmEEJaigFYR5ASkUATBADMwAVxDUAfAF9oAbUltqAfU5CAutH5DokqbQ4Bq0MLLUktAUCMzERFhckkaipqIIRtCiAHbQbODACIZxrLQI1Ba0uch+6mIS0nJKquqaOnqGJuZWtg61ggFBIZoQiiXYzADm5WqhEP2yLu6e6voocdBlFVXQlDT0jLL6ANzMdhjn6BigkDAAIpqiAG4Z0AgAHtQI2UYw8BBINCYHD4EpkHIAC0e1DukmA4ymM1aYQWSw8AlW62BCS2lVyji8p2BlzsQA

Related Issues:

EDIT: In the original ES6 example, the class Derived didn't actually extend Base which led to the possibility I may have submitted an invalid report. Fixing the code sample and re-running the playground with the updated example ES6 code showed the problem to still persist. Code sample in this issue and playground link have been updated.

[weswigham]

AFAIK we don't actually semantically recognize @inheritDoc.

[krishpranav]

Hi, is this still open?