JSDoc @typedef not being used in other files

Question

In my file lib/server.js I have the following code:

/**
 * My Test Server
 * 
 * @typedef  {Object}   My.Server
 * @prop     {String}   name
 */
function Server() {
    this.name = 'zever';
}

When I reference this @typedef in the same file, it works:

However, when I use the @typedef in another file in the same project, I get nothing:

(And yes, I tried the jsdoc on a single line, too)

What is going wrong here?

Possible duplicate of [How to "import" a typedef from one file to another in JSDoc using Node.js?](https://stackoverflow.com/questions/49836644/how-to-import-a-typedef-from-one-file-to-another-in-jsdoc-using-node-js) — Alexis Tyler, Aug 26 '19 at 05:43

score 1 · Answer 1 · answered Nov 07 '18 at 14:50

1

You need to import your definition in the other file:

 /**
 @typedef {import('./my-new-type').MyNewType} MyNewType
 * */

answered Nov 07 '18 at 14:50

Pavel Polyakov

1 Answers1