apisurf/lib/types/InspectResult.d.ts

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

import { ApiSurface } from './ApiSurface.js';
/**
 * Result of inspecting a package's API surface.
 */
export interface InspectResult {
    /** Name of the inspected package */
    packageName: string;
    /** Version of the inspected package */
    version: string;
    /** Repository URL from package.json */
    repositoryUrl?: string;
    /** Map of entry points to their API surfaces (main export is keyed as 'main') */
    apiSurfaces: Map<string, ApiSurface>;
    /** Summary message */
    summary: string;
    /** Whether the package was successfully analyzed */
    success: boolean;
    /** Any errors encountered during analysis */
    errors?: string[];
}