apisurf/lib/types/DiffOptions.d.ts

Analyze API surface changes between npm package versions to catch breaking changes

/**
 * Configuration options for analyzing API surface differences.
 */
export interface DiffOptions {
    /** Base git branch or commit to compare from */
    base: string;
    /** Target git branch or commit to compare to (defaults to current branch) */
    head?: string;
    /** Pattern to filter which packages to analyze */
    packages?: string;
    /** Output format for the diff results */
    format: 'console' | 'json' | 'md' | 'html' | 'report';
    /** NPM package name to analyze (enables NPM mode instead of git mode) */
    npmPackage?: string;
    /** Starting version for NPM package comparison */
    fromVersion?: string;
    /** Target version for NPM package comparison */
    toVersion?: string;
    /** NPM registry URL to use for package downloads */
    registry?: string;
    /** File path to write detailed API surface logs */
    logfile?: string;
    /** Enable verbose output with before/after details for changes */
    verbose?: boolean;
}