Module SearchAdapter

Index

Functions

Functions

Const augmentProducts

augmentProducts(results: Results): object[]

- Defined in flux-capacitor/src/core/adapters/search.ts:206
Parameters
- results: Results
Returns object[]

Const combineNavigations

combineNavigations(__namedParameters: object): Navigation[]

- Defined in flux-capacitor/src/core/adapters/search.ts:129
Parameters
- __namedParameters: object
  - available: Navigation[]
  - selected: Navigation[]
Returns Navigation[]

Const extractAllMeta

extractAllMeta(product: Product | Record): any

- Defined in flux-capacitor/src/core/adapters/search.ts:203
Parameters
- product: Product | Record
Returns any

Const extractData

extractData(products: ProductWithMetadata[]): Product[]

- Defined in flux-capacitor/src/core/adapters/search.ts:200
Parameters
- products: ProductWithMetadata[]
Returns Product[]

Const extractNavigation

extractNavigation(navigation: Navigation): Navigation

- Defined in flux-capacitor/src/core/adapters/search.ts:43
Parameters
- navigation: Navigation
Returns Navigation

Const extractNavigationSort

extractNavigationSort(sort: SortType): Sort

- Defined in flux-capacitor/src/core/adapters/search.ts:34
Parameters
- sort: SortType
Returns Sort

Const extractPage

extractPage(state: State, totalRecords: number, current?: number, pageSize?: number): Page

- Defined in flux-capacitor/src/core/adapters/search.ts:183
Parameters
- state: State
- totalRecords: number
- Optional current: number
- Optional pageSize: number
Returns Page

Const extractQuery

extractQuery(__namedParameters: object): Query

- Defined in flux-capacitor/src/core/adapters/search.ts:27
Parameters
- __namedParameters: object
  - corrected: string
  - didYouMean: string[]
  - original: string
  - related: string[]
  - rewrites: string[]
Returns Query

Const extractRecordCount

extractRecordCount(recordCount: number): number

- Defined in flux-capacitor/src/core/adapters/search.ts:179
Parameters
- recordCount: number
Returns number

Const extractRefinement

extractRefinement(__namedParameters: object): ValueRefinement | RangeRefinement

- Defined in flux-capacitor/src/core/adapters/search.ts:30
Parameters
- __namedParameters: object
  - high: number
  - low: number
  - total: number
  - type: "Range" & "Value"
  - value: string
Returns ValueRefinement | RangeRefinement

Const extractTemplate

extractTemplate(template?: Template): Template

- Defined in flux-capacitor/src/core/adapters/search.ts:172
Parameters
- Default value template: Template = <any>{ zones: [] }
Returns Template

Const extractZone

extractZone(zone: Zone): Zone

- Defined in flux-capacitor/src/core/adapters/search.ts:151
Parameters
- zone: Zone
Returns Zone

Const filterExcludedRefinements

filterExcludedRefinements(refinements: Refinement[]): Refinement[]

- Defined in flux-capacitor/src/core/adapters/search.ts:115
Parameters
- refinements: Refinement[]
Returns Refinement[]

Const filterNavigations

filterNavigations(navigations: Navigation[]): Navigation[]

- Defined in flux-capacitor/src/core/adapters/search.ts:119
Parameters
- navigations: Navigation[]
Returns Navigation[]

Const mergeSelectedRefinements

mergeSelectedRefinements(available: Navigation, selected: Navigation): void

- Defined in flux-capacitor/src/core/adapters/search.ts:69
Parameters
- available: Navigation
- selected: Navigation
Returns void

Const pruneRefinements

pruneRefinements(navigations: Navigation[], storeSection: string, state: State): Navigation[]

- Defined in flux-capacitor/src/core/adapters/search.ts:88
Parameters
- navigations: Navigation[]
- storeSection: string
- state: State
Returns Navigation[]

Const refinementsMatch

refinementsMatch(lhs: Refinement, rhs: Refinement | SelectedRefinement, type?: string): boolean

- Defined in flux-capacitor/src/core/adapters/search.ts:60
Parameters
- lhs: Refinement
- rhs: Refinement | SelectedRefinement
- Default value type: string = rhs.type
Returns boolean

Generated using TypeDoc