UNPKG

541 BTypeScriptView Raw
1type JsDocType = JsDocBaseType | JsDocElementsType;
2interface JsDocBaseType {
3 name: string;
4}
5interface JsDocElementsType extends JsDocBaseType {
6 elements: JsDocType[];
7}
8interface JsDocProperty {
9 description: string | null;
10 type: JsDocType | null;
11}
12interface JsDocParam extends JsDocProperty {
13 name: string;
14 optional?: boolean;
15}
16interface JsDoc {
17 description: string | null;
18 params: JsDocParam[];
19 returns: JsDocProperty | null;
20}
21export default function parseJsDoc(docblock: string): JsDoc;
22export {};