Type Alias PaginatedSearchResults<SearchResult>

The type of object a component that uses the LisPaginatedSearchMixin mixin expects back when it performs a search.

type PaginatedSearchResults<SearchResult> = {
    errors?: string[];
    hasNext?: boolean;
    numPages?: number;
    numResults?: number;
    pageSize?: number;
    results: SearchResult[];
}

Type Parameters

SearchResult
The type to expect in the results array of a paginated search results object.

Index

Properties

errors? hasNext? numPages? numResults? pageSize? results

Properties

`Optional`errors

errors?: string[]

`Optional`hasNext

hasNext?: boolean

`Optional`numPages

numPages?: number

`Optional`numResults

numResults?: number

`Optional`pageSize

pageSize?: number

results

results: SearchResult[]