Skip to main content

Interface: SearchFilterFinalizer<Document, SearchIndexConfig>

server.SearchFilterFinalizer

Builder to define equality expressions as part of a search filter.

See SearchFilterBuilder.

Type parameters

NameType
Documentextends GenericDocument
SearchIndexConfigextends GenericSearchIndexConfig

Hierarchy

Methods

eq

eq<FieldName>(fieldName, value): SearchFilterFinalizer<Document, SearchIndexConfig>

Restrict this query to documents where doc[fieldName] === value.

Type parameters

NameType
FieldNameextends string

Parameters

NameTypeDescription
fieldNameFieldNameThe name of the field to compare. This must be listed in the search index's filterFields.
valueFieldTypeFromFieldPath<Document, FieldName>The value to compare against.

Returns

SearchFilterFinalizer<Document, SearchIndexConfig>

Defined in

server/search_filter_builder.ts:66