Skip to main content

Interface: SearchHit

One search result, with the matched ranges of its label for highlighting.

Properties​

column?​

column?: string;

Column name for kind 'column'.


id​

id: string;

Node id for tables/groups/notes, table id for columns, enum id, view name.


kind​

kind: SearchKind;

label​

label: string;

Text shown in a result list, e.g. "orders.user_id", "billing (view)".


ranges​

ranges: [number, number][];

UTF-16 [start, end) ranges of label that matched, for highlighting.


score​

score: number;