@timlassiter11/yatl
    Preparing search index...

    Interface YatlFieldSearchOptions<T>

    interface YatlFieldSearchOptions<T extends object = UnspecifiedRecord> {
        field: NestedKeyOf<T>;
        getter?: (row: T, key: NestedKeyOf<T>) => unknown;
        searchTokenizer?: TokenizerCallback;
        tokenize?: boolean;
    }

    Type Parameters

    Index

    Properties

    field getter? searchTokenizer? tokenize?

    Properties

    field: NestedKeyOf<T>

    The field within each item to search

    getter?: (row: T, key: NestedKeyOf<T>) => unknown
    searchTokenizer?: TokenizerCallback

    A function for tokenizing this column's data. Fallback to the main table tokenizer if not provided.

    tokenize?: boolean

    Whether the column's data should be tokenized for searching. If set and the searchTokenizer for this column exists, that will be used. Otherwise the table's searchTokenizer will be used.

    Settings

    Member Visibility

    On This Page

    Properties