The result of a string match function.

interface IMatchResult {
    indices: number[];
    score: number;
}

Properties

Properties

indices: number[]

The indices of the matched characters in the source text.

The indices will appear in increasing order.

score: number

A score which indicates the strength of the match.

The documentation of a given match function should specify whether a lower or higher score is a stronger match.