Home Reference Source
import {SearchResults} from '~/models/Search.js'
public class | source

SearchResults

Represents categories or list of results.

Constructor Summary

Public Constructor
public

constructor(search: Search, results: Map, areMore: boolean)

Represents group of search results

Member Summary

Public Members
public
public

Method Summary

Public Methods
public

Checks if category has more

public

Iterates by category.

public

Checks if category is empty

public

Returns results for a category

public

* results()

Iterates by item

public

* resultsByCategory(): [SearchCategory, SearchResult[]]

Iterates category/result pairs

Public Constructors

public constructor(search: Search, results: Map, areMore: boolean) source

Represents group of search results

Params:

NameTypeAttributeDescription
search Search
results Map

From MultiIndexSearch

areMore boolean

Public Members

public areMore: boolean source

Public Methods

public areMoreResultsForCategory(category: SearchCategory): boolean source

Checks if category has more

Params:

NameTypeAttributeDescription
category SearchCategory

Return:

boolean

If more results exist

public * categories(): SearchCategory source

Iterates by category.

Return:

SearchCategory

public categoryHasResultsForCategory(category: SearchCategory): boolean source

Checks if category is empty

Params:

NameTypeAttributeDescription
category SearchCategory

Return:

boolean

public getResultsForCategory(category: SearchCategory): SearchResult[] source

Returns results for a category

Params:

NameTypeAttributeDescription
category SearchCategory

Return:

SearchResult[]

public * results() source

Iterates by item

public * resultsByCategory(): [SearchCategory, SearchResult[]] source

Iterates category/result pairs

Return:

[SearchCategory, SearchResult[]]