Module Selectors

Index

Functions

Functions

area

area(state: State): string

- Defined in core/selectors.ts:15
Returns the applied area.

Parameters
- state: State
Returns string

autocomplete

autocomplete(state: State): Autocomplete

- Defined in core/selectors.ts:309
Returns the current autocomplete object.

Parameters
- state: State
Returns Autocomplete

autocompleteCategoryField

autocompleteCategoryField(state: State): string

- Defined in core/selectors.ts:321
Returns the set autocomplete category field navigationId.

Parameters
- state: State
Returns string

autocompleteCategoryValues

autocompleteCategoryValues(state: State): string[]

- Defined in core/selectors.ts:327
Returns the current values for the autocomplete category field.

Parameters
- state: State
Returns string[]

autocompleteNavigations

autocompleteNavigations(state: State): Navigation[]

- Defined in core/selectors.ts:339
Returns the current autocomplete navigations.

Parameters
- state: State
Returns Navigation[]

autocompleteProducts

autocompleteProducts(state: State): Product[]

- Defined in core/selectors.ts:345
Returns the current autocomplete products.

Parameters
- state: State
Returns Product[]

autocompleteQuery

autocompleteQuery(state: State): string

- Defined in core/selectors.ts:315
Returns the currently typed in autocomplete query.

Parameters
- state: State
Returns string

autocompleteSuggestions

autocompleteSuggestions(state: State): Suggestion[]

- Defined in core/selectors.ts:333
Returns the current autocomplete suggestions.

Parameters
- state: State
Returns Suggestion[]

autocompleteTemplate

autocompleteTemplate(state: State): Template

- Defined in core/selectors.ts:351
Returns the current autocomplete template.

Parameters
- state: State
Returns Template

availableNavigations

availableNavigations(state: State): Navigation[]

- Defined in core/selectors.ts:249
Returns the available navigations.

Parameters
- state: State
Returns Navigation[]

availablePastPurchaseNavigations

availablePastPurchaseNavigations(state: State): Navigation[]

- Defined in core/selectors.ts:460
Returns the available navigations.

Parameters
- state: State
Returns Navigation[]

collection

collection(state: State): string

- Defined in core/selectors.ts:67
Returns the current selected collection.

Parameters
- state: State
Returns string

collectionIndex

collectionIndex(state: State, name: string): number

- Defined in core/selectors.ts:73
Returns the index of the given collection.

Parameters
- state: State
- name: string
Returns number

collections

collections(state: State): Selectable<Collection>

- Defined in core/selectors.ts:61
Returns the collections object.

Parameters
- state: State
Returns Selectable<Collection>

config

config(state: State): Configuration

- Defined in core/selectors.ts:363
Returns the current session config

Parameters
- state: State
Returns Configuration

currentQuery

currentQuery(state: State): string

- Defined in core/selectors.ts:45
Returns the corrected query if it exists, otherwise returns the original query.

Parameters
- state: State
Returns string

defaultCollection

defaultCollection(state: State): string

- Defined in core/selectors.ts:53
Returns the name of the default collection

Parameters
- state: State
Returns string

details

details(state: State): Details

- Defined in core/selectors.ts:207
Returns the current details object.

Parameters
- state: State
Returns Details

didYouMean

didYouMean(state: State): string[]

- Defined in core/selectors.ts:33
Returns the didYouMean array

Parameters
- state: State
Returns string[]

fields

fields(state: State): string[]

- Defined in core/selectors.ts:21
Returns the requested fields.

Parameters
- state: State
Returns string[]

findProduct

findProduct(state: State, productId: string): Product

- Defined in core/selectors.ts:166
Returns the product with the given id

Parameters
- state: State
- productId: string
Returns Product

getLimitedCountDisplay

getLimitedCountDisplay(count: number): string

- Defined in core/selectors.ts:573
Helper function to display record count limited by the max records we can return from the database.

Parameters
- count: number
Returns string

getSelected

getSelected(allNavigations: Navigation[]): SelectedRefinement[]

- Defined in core/selectors.ts:562
Helper function to get selected navigations from an array of navigations.

Parameters
- allNavigations: Navigation[]
Returns SelectedRefinement[]

hasMoreRefinements

hasMoreRefinements(state: State, navigationId: string): boolean

- Defined in core/selectors.ts:279
Returns true if the navigation based on the given navigationId has more refinements.

Parameters
- state: State
- navigationId: string
Returns boolean

infiniteScroll

infiniteScroll(state: State): InfiniteScroll

- Defined in core/selectors.ts:85
Returns the current infinite scroll object.

Parameters
- state: State
Returns InfiniteScroll

isPastPurchaseRefinementDeselected

isPastPurchaseRefinementDeselected(state: State, navigationId: string, index: number): boolean

- Defined in core/selectors.ts:473
Finds the past purchase refinement based on the given navigationId and index and returns true if it is not selected, false otherwise.

Parameters
- state: State
- navigationId: string
- index: number
Returns boolean

isPastPurchaseRefinementSelected

isPastPurchaseRefinementSelected(state: State, navigationId: string, index: number): boolean

- Defined in core/selectors.ts:482
Finds the past purchase refinement based on the given navigationId and index and returns true if it is selected, false otherwise.

Parameters
- state: State
- navigationId: string
- index: number
Returns boolean

isRefinementDeselected

isRefinementDeselected(state: State, navigationId: string, index: number): boolean

- Defined in core/selectors.ts:262
Finds the refinement based on the given navigationId and index and returns true if it is not selected, false otherwise.

Parameters
- state: State
- navigationId: string
- index: number
Returns boolean

isRefinementSelected

isRefinementSelected(state: State, navigationId: string, index: number): boolean

- Defined in core/selectors.ts:271
Finds the refinement based on the given navigationId and index and returns true if it is selected, false otherwise.

Parameters
- state: State
- navigationId: string
- index: number
Returns boolean

location

location(state: State): Geolocation

- Defined in core/selectors.ts:357
Returns the current session location.

Parameters
- state: State
Returns Geolocation

navigation

navigation(state: State, navigationId: string): Navigation

- Defined in core/selectors.ts:230
Returns the navigation object for the given navigationId.

Parameters
- state: State
- navigationId: string
Returns Navigation

navigationSort

navigationSort(state: State): Navigation[]

- Defined in core/selectors.ts:255
Returns the navigation sort.

Parameters
- state: State
Returns Navigation[]

navigations

navigations(state: State): Navigation[]

- Defined in core/selectors.ts:242
Returns the navigations.

Parameters
- state: State
Returns Navigation[]

navigationsObject

navigationsObject(state: State): Indexed<Navigation> & object

- Defined in core/selectors.ts:236
Returns the navigations object.

Parameters
- state: State
Returns Indexed<Navigation> & object

page

page(state: State): number

- Defined in core/selectors.ts:111
Returns the current page number.

Parameters
- state: State
Returns number

pageObject

pageObject(state: State): Page

- Defined in core/selectors.ts:79
Returns the current page object.

Parameters
- state: State
Returns Page

pageSize

pageSize(state: State): number

- Defined in core/selectors.ts:97
Returns the current selected page size.

Parameters
- state: State
Returns number

pageSizeIndex

pageSizeIndex(state: State): number

- Defined in core/selectors.ts:105
Returns the index of the selected page size.

Parameters
- state: State
Returns number

pageSizes

pageSizes(state: State): SelectableList<number>

- Defined in core/selectors.ts:91
Returns the page sizes object.

Parameters
- state: State
Returns SelectableList<number>

pastPurchaseAllRecordCount

pastPurchaseAllRecordCount(state: State): number

- Defined in core/selectors.ts:426
Returns the past purchase record count

Parameters
- state: State
Returns number

pastPurchaseCurrentRecordCount

pastPurchaseCurrentRecordCount(state: State): number

- Defined in core/selectors.ts:429
Parameters
- state: State
Returns number

pastPurchaseNavigation

pastPurchaseNavigation(state: State, navigationId: string): Navigation

- Defined in core/selectors.ts:447
Returns the past purchase navigation object for the given navigationId.

Parameters
- state: State
- navigationId: string
Returns Navigation

pastPurchaseNavigations

pastPurchaseNavigations(state: State): Navigation[]

- Defined in core/selectors.ts:453
Returns the past purchase navigations.

Parameters
- state: State
Returns Navigation[]

pastPurchaseNavigationsObject

pastPurchaseNavigationsObject(state: State): Indexed<Navigation>

- Defined in core/selectors.ts:441
Returns the past purchase navigations object.

Parameters
- state: State
Returns Indexed<Navigation>

pastPurchasePage

pastPurchasePage(state: State): number

- Defined in core/selectors.ts:496
Returns the past purchase page number

Parameters
- state: State
Returns number

pastPurchasePageObject

pastPurchasePageObject(state: State): Page

- Defined in core/selectors.ts:490
Returns the current past purchase page object.

Parameters
- state: State
Returns Page

pastPurchasePageSize

pastPurchasePageSize(state: State): number

- Defined in core/selectors.ts:514
Returns the current selected page size.

Parameters
- state: State
Returns number

pastPurchasePageSizeIndex

pastPurchasePageSizeIndex(state: State): number

- Defined in core/selectors.ts:522
Returns the index of the selected page size.

Parameters
- state: State
Returns number

pastPurchasePageSizes

pastPurchasePageSizes(state: State): SelectableList<number>

- Defined in core/selectors.ts:508
Returns the page sizes object.

Parameters
- state: State
Returns SelectableList<number>

pastPurchaseProducts

pastPurchaseProducts(state: State): object[]

- Defined in core/selectors.ts:411
Returns the past purchase product data

Parameters
- state: State
Returns object[]

pastPurchaseProductsBySku

pastPurchaseProductsBySku(state: State): object

- Defined in core/selectors.ts:375
Returns the SKUs of previously purchased products.

Parameters
- state: State
Returns object

pastPurchaseProductsWithMetadata

pastPurchaseProductsWithMetadata(state: State): ProductWithMetadata[]

- Defined in core/selectors.ts:201
Returns the current products extended with metadata

Parameters
- state: State
Returns ProductWithMetadata[]

pastPurchaseQuery

pastPurchaseQuery(state: State): string

- Defined in core/selectors.ts:435
Returns the past purchase query string

Parameters
- state: State
Returns string

pastPurchaseSelectedRefinements

pastPurchaseSelectedRefinements(state: State): (SelectedValueRefinement | SelectedRangeRefinement)[]

- Defined in core/selectors.ts:466
Returns all selected refinements for the past purchase page

Parameters
- state: State
Returns (SelectedValueRefinement | SelectedRangeRefinement)[]

pastPurchaseSort

pastPurchaseSort(state: State): SelectableList<PastPurchaseSort>

- Defined in core/selectors.ts:528
Returns the sort list for past purchases

Parameters
- state: State
Returns SelectableList<PastPurchaseSort>

pastPurchaseSortSelected

pastPurchaseSortSelected(state: State): PastPurchaseSort

- Defined in core/selectors.ts:534
Returns the currently selected sort for past purchases

Parameters
- state: State
Returns PastPurchaseSort

pastPurchaseTotalPages

pastPurchaseTotalPages(state: State): number

- Defined in core/selectors.ts:502
Returns the last page index, ie number of pages

Parameters
- state: State
Returns number

pastPurchases

pastPurchases(state: State): PastPurchaseProduct[]

- Defined in core/selectors.ts:399
Returns all the past purchase skus

Parameters
- state: State
Returns PastPurchaseProduct[]

products

products(state: State): Product[]

- Defined in core/selectors.ts:154
Returns the current products

Parameters
- state: State
Returns Product[]

productsLoaded

productsLoaded(state: State): boolean

- Defined in core/selectors.ts:160
Returns a boolean indicating whether products are loaded

Parameters
- state: State
Returns boolean

productsWithMetadata

productsWithMetadata(state: State): ProductWithMetadata[]

- Defined in core/selectors.ts:195
Returns the current products extended with metadata

Parameters
- state: State
Returns ProductWithMetadata[]

productsWithPastPurchase

productsWithPastPurchase(state: State, idField: string): object[]

- Defined in core/selectors.ts:179
Returns products with past purchases metadata.

Parameters
- state: State
  
  Store state.
- idField: string
Returns object[]
- The field for the past purchase key

query

query(state: State): string

- Defined in core/selectors.ts:27
Returns the current original query.

Parameters
- state: State
Returns string

rangeNavigationMax

rangeNavigationMax(state: State, navigationId: any): number

- Defined in core/selectors.ts:218
Returns the maximum value for the given range navigation.

Parameters
- state: State
- navigationId: any
Returns number

rangeNavigationMin

rangeNavigationMin(state: State, navigationId: any): number

- Defined in core/selectors.ts:224
Returns the minimum value for the given range navigation.

Parameters
- state: State
- navigationId: any
Returns number

realTimeBiasesAllIds

realTimeBiasesAllIds(state: State): BiasKey[]

- Defined in core/selectors.ts:393
Returns the entire allIds object from biasing

Parameters
- state: State
Returns BiasKey[]

realTimeBiasesById

realTimeBiasesById(state: State): BiasById

- Defined in core/selectors.ts:387
Returns the entire byId object from biasing

Parameters
- state: State
Returns BiasById

realTimeBiasesHydrated

realTimeBiasesHydrated(state: State): any

- Defined in core/selectors.ts:543
Returns whether or not biasing has been rehydrated from localstorage

Parameters
- state: State
Returns any

recommendationsProducts

recommendationsProducts(state: State): Product[]

- Defined in core/selectors.ts:369
Returns the current recommendations product suggestions.

Parameters
- state: State
Returns Product[]

recordCount

recordCount(state: State): number

- Defined in core/selectors.ts:303
Returns the current record count.

Parameters
- state: State
Returns number

refinementCrumb

refinementCrumb(state: State, navigationId: string, index: number): object

- Defined in core/selectors.ts:287
Returns the refinement object for the given navigationId and index.

Parameters
- state: State
- navigationId: string
- index: number
Returns object
- field: string
- high: any
- low: any
- range: boolean
- value: any

relatedQueries

relatedQueries(state: State): string[]

- Defined in core/selectors.ts:39
Returns the related queries array

Parameters
- state: State
Returns string[]

saytPastPurchases

saytPastPurchases(state: State): ProductWithMetadata[]

- Defined in core/selectors.ts:405
Returns the past purchases for the sayt window

Parameters
- state: State
Returns ProductWithMetadata[]

selectedRefinements

selectedRefinements(state: State): (SelectedValueRefinement | SelectedRangeRefinement)[]

- Defined in core/selectors.ts:213
Returns the current selected refinements.

Parameters
- state: State
Returns (SelectedValueRefinement | SelectedRangeRefinement)[]

skip

skip(state: State, pagesize: number): number

- Defined in core/selectors.ts:142
Returns the request skip needed for the current page and given page size.

Parameters
- state: State
- pagesize: number
Returns number

sort

sort(state: State): Sort

- Defined in core/selectors.ts:128
Returns the current selected sort.

Parameters
- state: State
Returns Sort

sortIndex

sortIndex(state: State): number

- Defined in core/selectors.ts:136
Returns the index of the current selected sort.

Parameters
- state: State
Returns number

sorts

sorts(state: State): SelectableList<Sort>

- Defined in core/selectors.ts:122
Returns the sorts object.

Parameters
- state: State
Returns SelectableList<Sort>

template

template(state: State): Template

- Defined in core/selectors.ts:148
Returns the template.

Parameters
- state: State
Returns Template

totalPages

totalPages(state: State): number

- Defined in core/selectors.ts:117
Returns the last page index, ie number of pages

Parameters
- state: State
Returns number

uiTagState

uiTagState(state: State, tagName: string, id: string): any

- Defined in core/selectors.ts:556
Returns the ui state for the tag with the given tagName and id.

Parameters
- state: State
- tagName: string
- id: string
Returns any

uiTagStates

uiTagStates(state: State, tagName: string): object

- Defined in core/selectors.ts:550
Returns the ui state for the all of the tags with the given tagName.

Parameters
- state: State
- tagName: string
Returns object
- [tagId: number]: any
- Optional global?: any

Generated using TypeDoc