charton

Appearance

charton API

charton API / @chart-on/core / index / SearchItem

Interface: SearchItem ​

Defined in: packages/core/src/util/text-match.ts:2

Text a search ranks with matchScore: a label, an id, other words that find it, and a description.

Properties ​

description? ​

optional description?: string

Defined in: packages/core/src/util/text-match.ts:10

Also searched, ranked last.

id ​

id: string

Defined in: packages/core/src/util/text-match.ts:4

Matched like a keyword: exactly, by prefix, and in the all-words tier.

keywords? ​

optional keywords?: readonly string[]

Defined in: packages/core/src/util/text-match.ts:8

Other words that find the item, e.g. abbreviations or aliases.

label ​

label: string

Defined in: packages/core/src/util/text-match.ts:6

The name shown, ranked first.