vue-docgen-api/dist/main.d.ts

Toolbox to extract information from Vue component files for documentation generation purposes.

import Documentation, { ComponentDoc, PropDescriptor, SlotDescriptor, EventDescriptor, MethodDescriptor, ExposeDescriptor, BlockTag, Param, Tag, ParamTag, ParamType } from './Documentation';
import type { ParseOptions, DocGenOptions } from './types';
import * as ScriptHandlers from './script-handlers';
import * as TemplateHandlers from './template-handlers';
import getDoclets from './utils/getDoclets';
import getProperties from './script-handlers/utils/getProperties';
import getDocblock from './utils/getDocblock';
export { ScriptHandlers };
export { TemplateHandlers };
export { getDoclets };
export { getProperties };
export { getDocblock };
export { TemplateParserOptions } from './parse-template';
export { ScriptHandler, TemplateHandler } from './parse';
export { ComponentDoc, DocGenOptions, ParseOptions, Documentation, BlockTag, PropDescriptor, SlotDescriptor, EventDescriptor, MethodDescriptor, ExposeDescriptor, Param, Tag, ParamTag, ParamType };
export { cleanName, getDefaultExample } from 'vue-inbrowser-compiler-independent-utils';
/**
 * Parse the component at filePath and return props, public methods, events and slots
 * @param filePath absolute path of the parsed file
 * @param opts
 */
export declare function parse(filePath: string, opts?: DocGenOptions | {
    [alias: string]: string;
}): Promise<ComponentDoc>;
/**
 * Parse all the components at filePath and returns an array of their
 * props, public methods, events and slot
 * @param filePath absolute path of the parsed file
 * @param opts
 */
export declare function parseMulti(filePath: string, opts?: DocGenOptions): Promise<ComponentDoc[]>;
/**
 * Parse the `source` assuming that it is located at `filePath` and return props, public methods, events and slots
 * @param source source code to be parsed
 * @param filePath absolute path of the parsed file
 * @param opts
 */
export declare function parseSource(source: string, filePath: string, opts?: DocGenOptions | {
    [alias: string]: string;
}): Promise<ComponentDoc>;