Circle V2 API Docs
    Preparing search index...

    Type Alias FuzzyMatch

    type FuzzyMatch = {
        exact: boolean;
        matched: boolean;
        similarity: number;
        wordEnd: number | null;
        wordStart: number | null;
    }
    Index

    Properties

    exact: boolean

    True when the match came from the exact (normalized substring) pass rather than the fuzzy window scan.

    matched: boolean

    Whether the needle was located — an exact hit, or a fuzzy window at or above the threshold.

    similarity: number

    1 for an exact hit, otherwise the best window's Sørensen–Dice similarity; 0 when the fuzzy pass was skipped or the needle was too short to score.

    wordEnd: number | null
    wordStart: number | null

    Word-index range of the located text in the normalized haystack; null when unmatched.