doxdox-core/dist/loader.d.ts

Core package for doxdox.

/**
 * Load plugin from package directory.
 *
 *     const plugin = await loadPluginFromPackagePath('./doxdox-parser-jsdoc');
 *
 * @param {string} [path] Directory containing a plugin package.
 * @return {Promise<T | null>} Plugin default method.
 * @public
 */
export declare const loadPluginFromPackagePath: <T>(path: string) => Promise<T | null>;
/**
 * Load plugin from path.
 *
 *     const plugin = await loadPluginFromFile('./doxdox-renderer-json/dist/index.js');
 *
 * @param {string} [path] Plugin file path.
 * @return {Promise<T | null>} Plugin default method.
 * @public
 */
export declare const loadPluginFromFile: <T>(path: string) => Promise<T | null>;
/**
 * Load plugin from file or directory.
 *
 *     const plugin = await loadPlugin([process.cwd()], null, './renderer.js');
 *     const plugin = await loadPlugin(['../node_modules'], 'doxdox-renderer-', 'json');
 *
 * @param {string[]} [directories] Root directories to load plugin from.
 * @param {string} [prefix] Optional prefix to attach to the pathOrPackage.
 * @param {string} [pathOrPackage] Path or package name.
 * @return {Promise<T | null>} Plugin default method.
 * @public
 */
export declare const loadPlugin: <T>(directories: string[], prefix: string | null, pathOrPackage: string) => Promise<T | null>;