인수 객체의 함수 정의를 문서화하는 방법

Question

클래스의 인수가 함수 (와우) 인 속성을 포함하는 속성 일 때 어떻게 문서화 할 수 있습니까?

예 :

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) {...} 
} 

누군가가 (A 다른 특성을 가진 개체 수 있습니다, 등)는 onSuccess는 두 개의 인수, A와 B를 통과 같은이 클래스를 사용한다고 정의 할 수있는 방법

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

Visual Studio 코드를 사용하고 있는데 정의가 없습니다. 이것이 가능합니까 아니면 너무 많은 수준입니까?

Answer 1

a 및 b의 형식이 무엇인지, 또는이 함수가 void을 반환하는지 알 수 없습니다. 그러나 여기에 몇 가지 옵션은 다음과 같습니다

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

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

또는

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