Как можно ссылаться на модуль как параметр в JSDocs - PullRequest
0 голосов
/ 27 августа 2018

Имеется такой модуль, как:

/** Config module
 * @module Config
 */
export default class Config {
...

Как указать ссылку на модуль Config при указании в качестве параметра?

/**
 * Foo
 * @module Foo
 */
export default class Foo {
    /**
     * Create a new instance
     * @constructor
     * @param {Config} config - the config
     */
    constructor(config) {
        this.config = config;
    }

Я не могу получить Config для регистрации в качестве ссылки

1 Ответ

0 голосов
/ 28 августа 2018

Простой префикс с module:

См. Ниже

/**
 * Foo
 * @module Foo
 */
export default class Foo {
    /**
     * Create a new instance
     * @constructor
     * @param {module:Config} config - the config
     */
    constructor(config) {
        this.config = config;
    }
...