SheetXL - v1.0.2
    Preparing search index...

    Interface GrepResult

    The result of a grep.

    interface GrepResult {
        cellCount: number;
        fields: readonly GrepField[];
        matches: readonly GrepMatch[];
        objectCount: number;
        output: GrepOutput;
        pattern: string;
        scope: string;
        sheets: readonly GrepSheetMatches[];
        sheetsMatched: number;
        sheetsSearched: number;
        truncated: boolean;
    }
    Index
    cellCount fields matches objectCount output pattern scope sheets sheetsMatched sheetsSearched truncated
    cellCount: number

    Cells that produced a match. A hyperlink or number format block counts all of its cells, and a cell also matching in another field is counted again.

    fields: readonly GrepField[]
    matches: readonly GrepMatch[]
    objectCount: number

    Shapes, charts and names that produced at least one match.

    output: GrepOutput
    pattern: string

    Echoed back so a rendering carries its own scope.

    scope: string

    Resolved human-readable scope, e.g. Sheet1!A1:D847 or workbook.

    sheets: readonly GrepSheetMatches[]

    Per-sheet counts, in search order — only sheets with at least one match appear.

    sheetsMatched: number

    Sheets that produced at least one match.

    sheetsSearched: number

    Sheets that were actually entered by the search.

    When GrepArgs.maxCount cuts the search short, sheets never entered are not counted — "searched" is a claim, and it is only made about work that happened.

    truncated: boolean

    True when GrepArgs.maxCount cut the search short — a further matching cell was actually found past the cap, never inferred from the count alone.

    Elision is explicit and never silent, so the renderer must surface this.

    Settings
    Member Visibility

    On This Page
    Properties