apisurf/lib/types/Change.d.ts

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

/**
 * Represents a non-breaking change that would require a minor version bump.
 */
export interface Change {
    /** Category of non-breaking change that occurred */
    type: 'export-added' | 'export-modified' | 'file-added' | 'property-added' | 'parameter-added' | 'type-updated';
    /** Human-readable description of the change */
    description: string;
    /** Additional details about the change */
    details: string;
}