Beignet API reference
Preparing search index...
@beignet/core
search
SearchResults
Type Alias SearchResults<TDocument>
Search result payload.
type
SearchResults
<
TDocument
extends
SearchDocumentBase
>
=
{
facets
?:
Record
<
string
,
Record
<
string
,
number
>
>
;
hits
:
TDocument
[]
;
page
:
SearchResultPage
;
processingTimeMs
?:
number
;
query
:
string
;
}
Type Parameters
TDocument
extends
SearchDocumentBase
Index
Properties
facets?
hits
page
processing
Time
Ms?
query
Properties
Optional
facets
facets
?:
Record
<
string
,
Record
<
string
,
number
>
>
hits
hits
:
TDocument
[]
page
page
:
SearchResultPage
Optional
processing
Time
Ms
processingTimeMs
?:
number
query
query
:
string
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
facets
hits
page
processing
Time
Ms
query
Beignet API reference
Loading...
Search result payload.