fuzzy-rater/build/fuzzyRate/_types/IFuzzyTransitionData.d.ts

Tooling for fuzzily rating text according to some query

export declare type IFuzzyTransitionData = {
    /**
     * The type of transition
     * - insert: Matches a character that wasn't in the query
     * - skip: Skips a character that was in the query
     * - match: Matches a character in the text with the character in the query
     * - replace: Replaces a query character for another character
     * - ignore: Any text before or after a query match
     * - restart: Restarts the search to find another match
     */
    type: "insert" | "skip" | "match" | "replace" | "ignore" | "restart";
    /**
     * The query character that was skipped or matched, or replaced. Inserted/ignored characters are only defined by remaining transitions, so we don't statically know the character
     */
    character?: string;
    /** The current position in the query string */
    index: number;
};
//# sourceMappingURL=IFuzzyTransitionData.d.ts.map