How to document a JS class in Typescript with JSDoc

Question

I have a codebase that I'm looking to slowly migrate to Typescript. This means I create classes the non-ES6 way using util.inherits from Node, and would like to use JSDoc type annotations rather than converting to Typescript at this time.

But I'm having a problem typing classes:

var util = require("util");

function Base() {
}

/**
 * @constructor
 * @param {string} arg
 */
function Thing(arg) {
    Thing.super_.call(this);

    this.x = arg;
}

util.inherits(Thing, Base);

var thing = new Thing("test");

When running Typescript gives the following output:

$ tsc --noEmit --allowJs --checkJs .\test.js
test.js:11:15 - error TS2339: Property 'super_' does not exist on type 'typeof Thing'.

11         Thing.super_.call(this);
                 ~~~~~~

Is there a way to document the super_ property created by inherits using JSDoc?

Matt McCutchen · Accepted Answer · 2018-08-28 18:02:32Z

2

This seems to work:

/** @type {typeof Base} */
Thing.super_;

answered Aug 28, 2018 at 18:02

Matt McCutchen

31.4k3 gold badges76 silver badges82 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

How to document a JS class in Typescript with JSDoc

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related