apisurf/lib/types/DiffResult.d.ts

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

import { PackageDiff } from './PackageDiff.js';
import { SemverImpact } from './SemverImpact.js';
/**
 * Result of analyzing API surface differences between package versions.
 */
export interface DiffResult {
    /** Whether any breaking changes were detected across all packages */
    hasBreakingChanges: boolean;
    /** Detailed differences found in each analyzed package */
    packages: PackageDiff[];
    /** Human-readable summary of the analysis results */
    summary: string;
    /** Semantic versioning impact assessment */
    semverImpact: SemverImpact;
    /** NPM package name (only present in NPM analysis mode) */
    npmPackage?: string;
    /** Starting version that was analyzed (only present in NPM analysis mode) */
    fromVersion?: string;
    /** Target version that was analyzed (only present in NPM analysis mode) */
    toVersion?: string;
    /** Repository URL from package.json (only present in NPM analysis mode) */
    repositoryUrl?: string;
}