Import JSDOC documentation from another file

Question

How can I import the documentation for class foo in File B?

// FileA.js
/** This is a class */
class foo { }

export default objectThatContainsFoo // foo isn't directly exported

// FileB.js
/** @typdef {--IMPORT DOCUMENTATION FOR foo--} foo */

/**
 * @param {foo} foo - This is a foo
 */
function bar(foo) { return true }

Brother58697 · Accepted Answer · 2022-06-24 06:20:07Z

1

So one way that ended up working for me is to make a quick typedef in the source file that can then be imported.

// FileA.js

/** @typedef {foo} foo */

/** This is a class */
class foo { }

export default objectThatContainsFoo // foo isn't directly exported

// FileB.js
/** @typdef {import("FilaA.js").foo} foo */

/**
 * @param {foo} foo - This is a foo
 */
function bar(foo) { return true }

Now foo's properties and descriptions can be seen in FileB

answered Jun 24, 2022 at 6:20

Brother58697

3,2082 gold badges8 silver badges22 bronze badges

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

1 Answer 1