Skip to main content

@auvious/common / ApiSearchResult

Class: ApiSearchResult

This structure is based on the solr data received from the http service.

Hierarchy​

Implements​

Table of contents​

Constructors​

Properties​

Constructors​

constructor​

• new ApiSearchResult(args): ApiSearchResult

Parameters​

NameType
argsany

Returns​

ApiSearchResult

Overrides​

ApiResourceModel.constructor

Properties​

content​

• content: IApiSearchResultContent[]

An array of solr documents as setup in the solr service's schema.

Implementation of​

IApiSearchResult.content

numberOfElements​

• numberOfElements: number

alias for the content.length property.

Implementation of​

IApiSearchResult.numberOfElements

page​

• page: IApiSearchResultPage

holds page related data.

Implementation of​

IApiSearchResult.page

sort​

• sort: string

Describes the sorting policy of the data retrieved.

Implementation of​

IApiSearchResult.sort

totalElements​

• totalElements: number

the total elements related to the searchable that was queried. only a portion of those(numberOfElements) exist in this content.

Implementation of​

IApiSearchResult.totalElements

EMPTY​

▪ Static Readonly EMPTY: ApiSearchResult