Beignet API reference
    Preparing search index...

    Type Alias SearchIndexDef<TDocument>

    Provider-neutral index definition.

    type SearchIndexDef<TDocument extends SearchDocumentBase = SearchDocument> = {
        displayedAttributes?: readonly SearchField<TDocument>[];
        filterableAttributes?: readonly SearchField<TDocument>[];
        kind: "search-index";
        metadata?: Record<string, unknown>;
        name: string;
        primaryKey: SearchField<TDocument>;
        searchableAttributes?: readonly SearchField<TDocument>[];
        sortableAttributes?: readonly SearchField<TDocument>[];
    }

    Type Parameters

    Index
    displayedAttributes?: readonly SearchField<TDocument>[]
    filterableAttributes?: readonly SearchField<TDocument>[]
    kind: "search-index"
    metadata?: Record<string, unknown>
    name: string
    primaryKey: SearchField<TDocument>
    searchableAttributes?: readonly SearchField<TDocument>[]
    sortableAttributes?: readonly SearchField<TDocument>[]