Interface HighlightResult

Result of highlighting a query: markup plus how the query is interpreted.

interface HighlightResult {
    html: string;
    state: HighlightState;
    message?: string;
}

Properties

html: string

Token-wrapped, HTML-escaped markup of the raw query (round-trips to the input).

Whether the query is plain, a valid advanced query, or an invalid one.

message?: string

Human-readable reason, present only when state is "error".