How to document a Module that Exports an Instance of a Class with JSDoc

Question

I'm working on a Javascript project where the default export (i.e. what you get when you require the module) is an instance of a class that extends a class.

For example:

/**
 * @module my-module-name
 */

/**
 * Private so documentation doesn't mention DefaultRouter
 * @private
 */
class DefaultRouter extends Router {
    /**
     * Extra method docs
     */
    extreMethod() {}
}
export default new DefaultRouter();

The documentation for this (ideally) would include the Router class (as that's available to developers) and show the API surface for the module as including docs for the extended class Router as well as the extraMethod.

I can get extraMethod docs showing up by using @alias module:my-module-name.extraMethod but I can't find a clean way to expose the Router methods.

How can I do this in a simpler way, e.g. with some @ tag?

Matt Gaunt · Accepted Answer · 2017-11-03 21:04:50Z

3

After playing around a little, I found the @borrows tag that seems to work how I wanted it to.

/**
 * @module my-module-name
 * @borrows module:my-module-name.Router#methodName as methodName
 */

answered Nov 3, 2017 at 21:04

Matt Gaunt

9,8613 gold badges41 silver badges58 bronze badges

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

Collectives™ on Stack Overflow

How to document a Module that Exports an Instance of a Class 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