vue-docgen-cli/lib/getSources.d.ts

Generate documentation markdown files from VueJs components using the vue-docgen-api.

import { FSWatcher } from 'chokidar';
import { parseMulti, DocGenOptions } from 'vue-docgen-api';
/**
 *
 * @param components glob or globs to watch
 * @param cwd option to pass chokidar
 * @param getDocFileName a function to go from component to doc file
 */
export default function getSources(components: string | string[], ignore: string[], cwd: string, getDocFileName: (componentPath: string) => string | string[] | false, propsParser: typeof parseMulti, optionsApi?: DocGenOptions): Promise<{
    watcher: FSWatcher;
    docMap: {
        [filepath: string]: string;
    };
    componentFiles: string[];
}>;