Angular Modernizer
    Preparing search index...

    Interface VerifyCitationsOutput

    Output of the verify-citations tool.

    interface VerifyCitationsOutput {
        citations?: VerifiedCitation[];
        counts: Record<CitationStatus, number>;
        needsAttention: number;
        plans: { citations: number; needsAttention: number; plan: string }[];
        projectRoot: string;
        summary: string;
        total: number;
        truncated: boolean;
    }
    Index

    Properties

    citations? counts needsAttention plans projectRoot summary total truncated

    Properties

    citations?: VerifiedCitation[]

    Citations that need attention first, then the others, each in plan order.

    counts: Record<CitationStatus, number>

    Number of citations per status.

    needsAttention: number

    Citations with status moved, anchor-missing, out-of-range, missing-file or ambiguous.

    plans: { citations: number; needsAttention: number; plan: string }[]

    Citation counts per plan.

    Type Declaration

    • citations: number

      Number of citations in the plan.

    • needsAttention: number

      Citations of the plan that need attention.

    • plan: string

      Plan file relative to projectRoot.

    projectRoot: string

    Absolute repository root the citations resolve from.

    summary: string

    Short text with the counts and the citations that need attention.

    total: number

    Number of citations in all plans.

    truncated: boolean

    true when maxResults cut the citation list.

    Settings

    Member Visibility

    On This Page

    Properties