如何记录参数对象的函数定义

时间:2017-11-16 02:46:45

标签: javascript visual-studio jsdoc

当该参数是包含属性(whoah)的属性时,如何记录类的参数。

示例:

class MyClass {
    /**
     * @param {Object} options - configuration for the class
     * @param {Function} options.onSuccess - a callback function which has two arguments A and B
     * @memberof MyClass
     */
    constructor(options) {...}
}

如何定义某人应该像这样使用这个类,其中onSuccess传递两个参数,A和B(其中A可能是具有其他属性的对象等)。

var instance = new MyClass({
    onSuccess: (A, B) => {...}
});

我使用的是Visual Studio Code,它显示没有找到定义。这有可能还是太多层次?

1 个答案:

答案 0 :(得分:0)

我不确定ab的类型是什么,或者函数是否返回void。但这里有一些选择:

interface MyClassArgs {
    onSuccess: (a, b) => void;
}

class MyClass {
    constructor(options: MyClassArgs) { }
}

或者

class MyClass {
    constructor(options: { onSuccess: (a, b) => void }) { }
}