Skip to main content

Interface: SearchIndexConfig<SearchField, FilterFields>

schema.SearchIndexConfig

The configuration for a search index.

Type parameters

NameType
SearchFieldextends string
FilterFieldsextends string

Properties

searchField

searchField: SearchField

The field to index for full text search.

This must be a field of type string.

Defined in

schema/index.ts:84


filterFields

Optional filterFields: FilterFields[]

Additional fields to index for fast filtering when running search queries.

Defined in

schema/index.ts:89