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

Properties

cellCount fields matches objectCount output pattern scope sheets sheetsMatched sheetsSearched truncated

Properties

cellCount

cellCount: number

Distinct cells that produced at least one match.

fields

fields: readonly GrepField[]

matches

matches: readonly GrepMatch[]

objectCount

objectCount: number

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

output

output: GrepOutput

pattern

pattern: string

Echoed back so a rendering carries its own scope.

scope

scope: string

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

sheets

sheets: readonly GrepSheetMatches[]

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

sheetsMatched

sheetsMatched: number

Sheets that produced at least one match.

sheetsSearched

sheetsSearched: number

Sheets that were actually entered by the search.

Remarks

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

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.

Remarks

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

Interface GrepResult

Index

Properties

Properties

cellCount

fields

matches

objectCount

output

pattern

scope

sheets

sheetsMatched

sheetsSearched

Remarks

truncated

Remarks

Settings

On This Page