SearchIndexBuilder
Defined in: builder/search.ts:48
Extends
Section titled “Extends”Type Parameters
Section titled “Type Parameters”TTypes
Section titled “TTypes”TTypes extends AppBuilderTypes = AppBuilderTypes
Properties
Section titled “Properties”
readonlyprn:string
Defined in: builder/index.ts:32
Inherited from
Section titled “Inherited from”
readonlyunion:UnionBuilder
Defined in: builder/search.ts:49
Methods
Section titled “Methods”addTemplate()
Section titled “addTemplate()”addTemplate<
TTemplate>(template,handler):this
Defined in: builder/search.ts:59
Adds this template to the index. The handler converts the
item to text and facets. The text is concatenated for term-based
searches. The facets are used for facet-based queries.
Supplying a handler for a template that’s already been added will replace the previous handler.
Type Parameters
Section titled “Type Parameters”TTemplate
Section titled “TTemplate”TTemplate extends TemplateBuilder
Parameters
Section titled “Parameters”template
Section titled “template”TTemplate
handler
Section titled “handler”SearchIndexHandler<ExtractReadItem<TTemplate["prn"], TTypes>>
Returns
Section titled “Returns”this
setDescription()
Section titled “setDescription()”setDescription(
description):this
Defined in: builder/index.ts:33
Parameters
Section titled “Parameters”description
Section titled “description”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”toDefinition()
Section titled “toDefinition()”toDefinition():
SearchIndexDefinition
Defined in: builder/search.ts:67
Emit this builder as a definition.
Returns
Section titled “Returns”SearchIndexDefinition