[PROPOSAL] Support @augments/@extends attached to an Object types

Search Terms

jsdoc extends object

Suggestion

Support @augments/@extends attached to an Object types.

Actually, *Storm IDEs are following it, on intellisense but tsc complains by

JSDoc '@augments' is not attached to a class.

Use Cases

Provide a way to type the derivating (merged) result of any objects to a single one.

Examples

    /**
     * @typedef Obj
     * @type {Object}
     */
    
    /**
     * @typedef Properties
     * @type {Object}
     */
    
    /**
     * @typedef Return
     * @type {Object}
     * @augments Obj
     * @augments Properties
     */
    
    /**
     * @type {Obj} obj
     */
    const obj = {
      /**
       * @param {Properties} [properties]
       * @returns {Return}
       */
      derivate ({ ...properties } = {}) {
        return { ...this, ...properties }
      }
    }

Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code

• This wouldn't change the runtime behavior of existing JavaScript code

• This could be implemented without emitting different JS based on the types of the expressions

• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)

• This feature would agree with the rest of TypeScript's Design Goals.

ソースファイルやテストは指定されていません。まず、提供された JavaScript の例を tsc で再現し、typedefs に対する JSDoc @augments/@extends の処理を追跡します。object typedefs が報告された診断なしにこれらのタグを受け入れ、意図したマージ済みの型を生成すれば完了です。