vue-docgen-api/dist/utils/documentRequiredComponents.d.ts

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

import { ImportedVariableSet } from './resolveRequired';
import type { ParseOptions } from '../types';
import Documentation from '../Documentation';
/**
 * Document all components in varToFilePath in documentation
 * Instead of giving it only one component file, here we give it a whole set of variable -> file
 *
 * @param documentation if omitted (undefined), it will return all docs in an array
 * @param varToFilePath variable of object to document
 * @param originObject to build the origin flag
 * @param opt parsing options
 */
export default function documentRequiredComponents(parseFile: (opt: ParseOptions, documentation?: Documentation) => Promise<Documentation[]>, documentation: Documentation | undefined, varToFilePath: ImportedVariableSet, originObject: 'extends' | 'mixin' | undefined, opt: ParseOptions): Promise<Documentation[]>;