jsdoc-tests/dist/index.d.ts

A JSDoc test tool for documentation-driven quality

/**
 * `jsdoc-test` entry function for test a source file with some jsdoc testing code.
 *
 * @param path {string} - A source file path.
 * @param dirname {string} - A path to execute the test, recommend `__dirname` with nodejs.
 * @param execute {(path: string) => unknown} - A execution method, recommend `require` with nodejs.
 *
 * @example
 *
 * ```ts
 * import { jsdocTests } from '../src';
 *
 * jsdocTests('../src/index.ts', __dirname);
 * ```
 */
export declare const jsdocTests: (path: string, dirname?: string) => Promise<void>;