UNPKG

1.15 kBTypeScriptView Raw
1import * as bt from '@babel/types';
2import { NodePath } from 'ast-types/lib/node-path';
3import Documentation, { DocBlockTags, EventDescriptor, ParamTag, ParamType } from '../Documentation';
4export interface TypedParamTag extends ParamTag {
5 type: ParamType;
6}
7/**
8 * Extracts events information from a VueJs component
9 * wether it's a class based component or an option based one
10 *
11 * @param documentation
12 * @param path
13 * @param astPath
14 */
15export default function eventHandler(documentation: Documentation, path: NodePath, astPath: bt.File): Promise<void>;
16/**
17 * Extracts events information from an
18 * object-style VueJs component `emits` option
19 *
20 * @param documentation
21 * @param path
22 */
23export declare function eventHandlerEmits(documentation: Documentation, path: NodePath): void;
24/**
25 * Extracts events information from an
26 * object-style VueJs component `methods` option
27 *
28 * @param documentation
29 * @param path
30 */
31export declare function eventHandlerMethods(documentation: Documentation, path: NodePath): void;
32export declare function setEventDescriptor(eventDescriptor: EventDescriptor, jsDoc: DocBlockTags): EventDescriptor;