/**
 * Convenience function for scanning examples with minimal boilerplate.
 *
 * Wraps the full config discovery pipeline:
 * `findConfigFile` → `loadConfig` → `resolveConfig` → `scanExamples`
 */
import type { ResolvedConfig } from '../types/index.js';
import type { ScanResult } from './types.js';
/**
 * Options for the convenience `scan()` function.
 */
export interface ScanOptions<T = Record<string, unknown>> {
    /** Working directory to search for config. Defaults to process.cwd() */
    root?: string;
    /** Pre-built config — skips file discovery + loading */
    config?: ResolvedConfig<T>;
}
/**
 * Scan for examples using automatic config discovery.
 *
 * This is the simplest entry point for programmatic scanning.
 * It discovers the nearest config file, loads it, resolves plugins,
 * and runs the scanner — all in one call.
 *
 * @example
 * ```typescript
 * import { scan } from 'functional-examples';
 *
 * // Auto-discover config from cwd
 * const result = await scan();
 *
 * // Discover config from a specific directory
 * const result = await scan({ root: '/path/to/project' });
 *
 * // Skip discovery and use a pre-resolved config
 * const result = await scan({ config: myResolvedConfig });
 * ```
 */
export declare function scan<TMetadata = Record<string, unknown>>(options?: ScanOptions<TMetadata>): Promise<ScanResult<TMetadata>>;
//# sourceMappingURL=scan.d.ts.map