@squawk
    Preparing search index...

    Interface SearchField<F>

    One searchable field extracted from an item: a label identifying the field and the text to match against.

    interface SearchField<F extends string = string> {
        name: F;
        text: string;
    }

    Type Parameters

    • F extends string = string

      The field-name type. Defaults to string, but callers that pass a string-literal union get that union narrowed through to FuzzyMatch.field.

    Index

    Properties

    name text

    Properties

    name: F

    Stable identifier for the field (for example 'name' or 'identifier'). Reported back as FuzzyMatch.field so callers know which field produced the match.

    text

    text: string

    The field's text value to score the query against.

    Settings

    Member Visibility

    On This Page

    Properties