Class Facet

Hierarchy

Facet

Index

Constructors

constructor

Properties

config
data

Accessors

Methods

Constructors

constructor

new Facet(searchClient: FetchClient, data: FacetData, config: FacetConfig): Facet

- Defined in lib/facet.ts:21
Parameters
- searchClient: FetchClient
  
  The fetch client to send the HTTP requests.
- data: FacetData
  
  The possible values to filter this searchTerm by.
- config: FacetConfig
  
  The facets configured in the prepared search.
Returns Facet

Properties

config

config: FacetConfig

The facets configured in the prepared search.

data

data: FacetData

The possible values to filter this searchTerm by.

Accessors

counts

get counts(): FacetCount[]

- Defined in lib/facet.ts:47
Returns FacetCount[]

An array containing the possible values for this facet that can be used in the filter function as well as the number of search results that would be returned if you filtered by value.

displayName

get displayName(): string | undefined

- Defined in lib/facet.ts:55
Returns string | undefined

filterClient

get filterClient(): FetchClient

- Defined in lib/facet.ts:51
Returns FetchClient

name

get name(): string

- Defined in lib/facet.ts:39
Returns string

selectedValues

get selectedValues(): FacetValue[] | undefined

- Defined in lib/facet.ts:59
Returns FacetValue[] | undefined

type

get type(): string | undefined

- Defined in lib/facet.ts:63
Returns string | undefined

Methods

customFilter

customFilter(filterValues: FacetValue[], ...customParams: URLParam[]): Promise<Page>

- Defined in lib/facet.ts:114
Filters the search results for this search term using the facet values passed to this function. Allows for the additional usage of custom parameters

Parameters
- filterValues: FacetValue[]
  
  The facet values to be filtered. Must be an array.
- Rest ...customParams: URLParam[]
  
  Additional parameter objects. The key will be the parameter name, the value its value. If the parameters already exist (because you added them as configuration options) they will be overwritten and then deleted.
Returns Promise<Page>

filter

filter(...filterValues: FacetValue[]): Promise<Page>

- Defined in lib/facet.ts:126
Filters the search results for this search term using the facette values passed to this function.

throws

When selected values are not allowed or multiple selections are not allowed.

Parameters
- Rest ...filterValues: FacetValue[]
  
  The facet values to be filtered.
Returns Promise<Page>

getFilterParamName

getFilterParamName(): string

- Defined in lib/facet.ts:72
Returns string

getQueryParam

getQueryParam(value: FacetValue): URLParam

- Defined in lib/facet.ts:67
Parameters
- value: FacetValue
Returns URLParam

getSelectedParameters

getSelectedParameters(): URLParam[]

- Defined in lib/facet.ts:76
Returns URLParam[]

isValueAllowed

isValueAllowed(value: FacetValue): boolean

- Defined in lib/facet.ts:80
Parameters
- value: FacetValue
Returns boolean

reset

reset(): Facet

- Defined in lib/facet.ts:101
Resets all selected values in this facet. For resetting a single facet we recommend calling filter with no parameters instead.

Returns Facet

The resetted facet.

setDisplayName

setDisplayName(name: string): Facet

- Defined in lib/facet.ts:90
Parameters
- name: string
Returns Facet

setSelectedValues

setSelectedValues(...values: string[]): Facet

- Defined in lib/facet.ts:85
Parameters
- Rest ...values: string[]
Returns Facet

Generated using TypeDoc