parseJsDoc.d.ts 541 B

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