引数オブジェクトの関数定義を文書化する方法

Question

クラスの引数は、その引数が関数（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 2つの引数、AとBを渡し、このようなこのクラスを使うべきであると定義することができますどのように

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

私はVisual Studio Codeを使用していますが、定義が見つかりません。これは可能ですか、それとも深すぎますか？

Answer 1

aとbの型が何であるか、または関数がvoidを返すかどうかわかりません。しかし、ここでいくつかのオプションがあります：

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

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

それとも

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