ISearchResult

Interface

Results from an item or group search.

Type parameters

Properties

PropertyTypeNotes
aggregations
 optional 
{ counts: { fieldName: string; fieldValues: { count: number; value: any }[] }[] }

Aggregations will only be present on item searches when fieldCounts are requested.

number
number
string
T[]
number
number

aggregations optional

aggregations: { counts: { fieldName: string; fieldValues: { count: number; value: any }[] }[] }

Aggregations will only be present on item searches when fieldCounts are requested.

nextStart

nextStart: number

num

num: number

query

query: string

results

results: T[]

start

start: number

total

total: number

Methods

MethodReturns
nextPage()
 optional 
Promise<ISearchResult<T>>

nextPage optional

nextPage(): Promise<ISearchResult<T>>
Returns 
Promise<ISearchResult<T>>

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.