Skip to content

charton API


charton API / @chart-on/ui / index / matchRank

Function: matchRank() ​

matchRank(def, query, options?): number | null

Defined in: core/src/indicators/search.ts:18

How well def matches query (lower is better, see matchTiers), or null when it does not: matchScore with typos (rsl finds RSI) of its name, aliases, id and description, then its category. options.name is the name shown, e.g. in the chart's language; the definition's own name then counts as an alias.

Parameters ​

def ​

IndicatorDef

query ​

string

options? ​

name? ​

string

Returns ​

number | null