Angular Modernizer
    Preparing search index...

    Interface SearchCodebaseOutput

    Output of the search-codebase tool.

    interface SearchCodebaseOutput {
        coverage: SearchCoverage & { hint?: string; tsConfigPath: string };
        results: SearchResult[];
        summary: string;
        totalCount: number;
        warnings?: string[];
    }
    Index

    Properties

    coverage results summary totalCount warnings?

    Properties

    coverage: SearchCoverage & { hint?: string; tsConfigPath: string }

    Which files the search covered, including the tsconfig used.

    Type Declaration

    • Optionalhint?: string

      Present when 0 hits were found: why that does not prove absence.

    • tsConfigPath: string

      The tsconfig whose program was searched.

    results: SearchResult[]

    Matches, at most maxResults (default 100).

    summary: string

    Short text summary of the matches.

    totalCount: number

    Number of returned matches.

    warnings?: string[]

    Conditions that can make the result incomplete (unresolved library imports).

    Settings

    Member Visibility

    On This Page

    Properties