import {MultiIndexSearch} from '~/models/Search.js'

public class | source

MultiIndexSearch

A group of categories. This supports formatting for most types

Constructor Summary

Public Constructor
public	constructor(search: Search, query: string, indices: string[], opts: Object, perPage: number)

Public Members
public get	areMore: boolean If they are more.
public	search: Search

Public Methods
public	[Symbol.iterator](): SearchResults Will start at the page as incremented by `next()`.
public	formatResults(response: Object) Formats a batch result
public	async getPage(pageNumber: number): SearchResults Gets the nth page
public	async next(): SearchResults Obtains the next page

Name	Type	Attribute	Description
search	Search		The search object
query	string		Query
indices	string[]		Names of indices to iterate over
opts	Object		The options
perPage	number	optional default: 20	Amount to load per page

If they are more.

Will start at the page as incremented by next().

Formats a batch result

Name	Type	Attribute	Description
response	Object

Gets the nth page

Name	Type	Attribute	Description
pageNumber	number

Obtains the next page

SearchResults (nullable: true)