Interface SearchResultProperties

Schema for the result of a query search operation.

interface SearchResultProperties {
    bookmark?: string;
    by?: string;
    counts?: JsonObject;
    ranges?: JsonObject;
    rows?: SearchResultRow[];
    total_rows: number;
}

Properties

bookmark? by? counts? ranges? rows? total_rows

Properties

Optional bookmark

bookmark?: string

Opaque bookmark token used when paginating results.

Optional by

by?: string

Grouped search matches.

Optional counts

counts?: JsonObject

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

Optional ranges

ranges?: JsonObject

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

Optional rows

rows?: SearchResultRow[]

Array of row objects.

total_rows

total_rows: number

Number of total rows.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc