vitepress-jsdoc/dist/commonjs/parsers/file.d.ts

A bridge between Vitepress and JSDoc-style commented codebases for hassle-free documentation.

import { type PluginOptions, type DirectoryFile, type ParseReturn, type FolderData, type ParsePromiseResult } from '../interfaces.js';
export declare const parseAndWriteFiles: (lsFolder: FolderData, options: PluginOptions) => Promise<ParsePromiseResult[]>;
/**
 * Parses the content of a directory file based on its extension and configuration.
 *
 * @param {DirectoryFile} file - The file object representing the directory file to be parsed.
 * @param {PluginOptions} options - The plugin options providing configuration for the parsing.
 *
 * @returns {Promise<object|undefined>} A promise that resolves with the parsed content of the file, or undefined if the file is a directory or has no associated parser.
 */
export declare const parseDirectoryFile: (file: DirectoryFile, options: PluginOptions) => Promise<ParseReturn | undefined>;
//# sourceMappingURL=file.d.ts.map