apisurf/lib/types/BreakingChange.d.ts

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

/**
 * Represents a breaking change that would require a major version bump.
 */
export interface BreakingChange {
    /** Category of breaking change that occurred */
    type: 'export-removed' | 'export-renamed' | 'file-moved' | 'export-path-removed' | 'type-changed' | 'property-removed' | 'parameter-changed';
    /** Human-readable description of the change */
    description: string;
    /** The original state before the change */
    before: string;
    /** The new state after the change (if applicable) */
    after?: string;
}