ISearchResult

Interface

Results from an item or group search.

Type parameters

Properties

PropertyTypeNotes
{ 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
Interface Property
aggregations: { counts: { fieldName: string; fieldValues: { count: number; value: any }[] }[] }

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

Type declaration

    nextStart

    Interface Property
    nextStart: number

    num

    Interface Property
    num: number

    query

    Interface Property
    query: string

    results

    Interface Property
    results: T[]

    start

    Interface Property
    start: number

    total

    Interface Property
    total: number

    Methods

    MethodReturns
    Promise<ISearchResult<T>>

    nextPage

    optional
    Interface Method
    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.