mergePages

Function

When multiple data sources underly a paginated search, the search implementation should be able to search at the appropriate starting point for each source for a given paged set of results. This function merges an array of page states for each source, denoted by their label, into a base64- encoded cursor string that the implementation can use for the next set of results.

  • mergePages(pages: IDataPageNextStart[]) : string

Parameters

Parameter Type Default Notes
pages Required IDataPageNextStart[]

an array of page states denoted by their label and the starting point for the next page

Returns

a base64-encoded cursor string to use when obtaining next page of results.

string

Function defined in packages/search/src/util/merge-pagination/merge.ts:23