Angular Modernizer
    Preparing search index...

    Interface CitationResult

    A citation with its verification result.

    interface CitationResult {
        anchors: CitationAnchor[];
        candidates?: string[];
        current?: string;
        file?: string;
        fileLength?: number;
        foundAt?: number[];
        matched?: string;
        path: string;
        planLine: number;
        ranges: [number, number][];
        status: CitationStatus;
        text: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    anchors candidates? current? file? fileLength? foundAt? matched? path planLine ranges status text

    Properties

    anchors: CitationAnchor[]

    Anchors in the order they are tried.

    candidates?: string[]

    For missing-file: files with the same name or stem; for ambiguous: the matches.

    current?: string

    Current text of the first cited line, whitespace collapsed, at most 100 characters.

    file?: string

    Resolved file relative to the root, when exactly one file matched.

    fileLength?: number

    For out-of-range: number of lines of the file.

    foundAt?: number[]

    For moved: lines where the anchor is now, nearest first, at most 5.

    matched?: string

    Anchor that decided the status (prefix anchors end in *).

    path: string

    Path as written in the plan.

    planLine: number

    1-based line of the plan.

    ranges: [number, number][]

    Cited line ranges, [start, end], 1-based and inclusive.

    status: CitationStatus

    Verification result.

    text

    text: string

    Citation text as written, e.g. x.ts:12-20.

    Settings

    Member Visibility

    On This Page

    Properties