Beignet API reference
Preparing search index...
@beignet/core
search
SearchIndexDef
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
TDocument
extends
SearchDocumentBase
=
SearchDocument
Index
Properties
displayed
Attributes?
filterable
Attributes?
kind
metadata?
name
primary
Key
searchable
Attributes?
sortable
Attributes?
Properties
Optional
displayed
Attributes
displayedAttributes
?:
readonly
SearchField
<
TDocument
>
[]
Optional
filterable
Attributes
filterableAttributes
?:
readonly
SearchField
<
TDocument
>
[]
kind
kind
:
"search-index"
Optional
metadata
metadata
?:
Record
<
string
,
unknown
>
name
name
:
string
primary
Key
primaryKey
:
SearchField
<
TDocument
>
Optional
searchable
Attributes
searchableAttributes
?:
readonly
SearchField
<
TDocument
>
[]
Optional
sortable
Attributes
sortableAttributes
?:
readonly
SearchField
<
TDocument
>
[]
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
displayed
Attributes
filterable
Attributes
kind
metadata
name
primary
Key
searchable
Attributes
sortable
Attributes
Beignet API reference
Loading...
Provider-neutral index definition.