Class SearchResult

Schema for the result of a query search operation.

Constructors

constructor

Properties

bookmark? by? counts? groups? ranges? rows? totalRows

Methods

deserialize serialize

Constructors

constructor

Properties

Optional bookmark

bookmark?: string

Opaque bookmark token used when paginating results.

Optional by

by?: string

Grouped search matches.

Optional counts

counts?: {
    [key: string]: JsonObject;
}

The counts facet syntax returns the number of query results for each unique value of each named field.

Type declaration

Optional groups

groups?: SearchResultProperties[]

Array of grouped search matches.

Optional ranges

ranges?: {
    [key: string]: JsonObject;
}

The range facet syntax reuses the standard Lucene syntax for ranges to return counts of results that fit into each specified category.

Type declaration

Optional rows

rows?: SearchResultRow[]

Array of row objects.

totalRows

totalRows: number

Number of total rows.

Methods

Static deserialize

Static serialize

Settings

Member Visibility

Theme

On This Page

constructorbookmarkbycountsgroupsrangesrowstotalRowsdeserializeserialize