apisurf/lib/types/PackageDiff.d.ts

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

import { BreakingChange } from './BreakingChange.js';
import { Change } from './Change.js';
/**
 * Represents the differences found in a single package's API surface.
 */
export interface PackageDiff {
    /** Package name from package.json */
    name: string;
    /** File system path to the package directory */
    path: string;
    /** Changes that would require a major version bump */
    breakingChanges: BreakingChange[];
    /** Changes that would require a minor version bump */
    nonBreakingChanges: Change[];
}