IndexedResult | hain Documentation

IndexedResult is used as a return value for Indexer

Indexer is used for synchronous searching items.

Both primaryText and secondaryText are used for user query matching. primaryText has higher priority. secondaryText has lower priority.

Properties

group: string

Result grouping name, default is group of package.json

Optional

icon: string

Icon URL, default is icon of package.json. See Icon URL Format

Optional

id: any

An identifier (recommended to be unique), used as argument to execute(), default is undefined

Optional

payload: any

Extra information, used as second argument to execute(), default is undefined

Optional

preview: boolean

Whether it has HTML Preview, default is false; used with render().

Optional

primaryText: string

Title text for item.

redirect: string

Redirection query, default is undefined

Optional

secondaryText: string

Description text for item.