Module Adapter

Index

Type aliases

Override

Functions

Type aliases

Override

Override: function

Type declaration

- (config: Configuration): GenericTransformer<T>
- Parameters
  - config: Configuration
  Returns GenericTransformer<T>

Functions

augmentProducts

augmentProducts(results: Results): object[]

- Defined in core/adapters/search.ts:197
Parameters
- results: Results
Returns object[]

autocompleteProductsOverrides

autocompleteProductsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:194
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

autocompleteSuggestionsOverrides

autocompleteSuggestionsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:191
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

clampPageSize

clampPageSize(page: number, pageSize: number): number

- Defined in core/adapters/request.ts:6
Parameters
- page: number
- pageSize: number
Returns number

collectionOverrides

collectionOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:197
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

combineNavigations

combineNavigations(__namedParameters: object): Navigation[]

- Defined in core/adapters/search.ts:120
Parameters
- __namedParameters: object
  - available: Navigation[]
  - selected: Navigation[]
Returns Navigation[]

detailsOverrides

detailsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:200
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

extractAllMeta

extractAllMeta(product: Product | Record): any

- Defined in core/adapters/search.ts:194
Parameters
- product: Product | Record
Returns any

extractArea

extractArea(config: Configuration, defaultValue?: string): string
extractArea(config: Configuration): string

- Defined in core/adapters/configuration.ts:46
Parameters
- config: Configuration
- Optional defaultValue: string
Returns string
- Defined in core/adapters/autocomplete.ts:15
Parameters
- config: Configuration
Returns string

extractAutocompleteArea

extractAutocompleteArea(config: Configuration): string

- Defined in core/adapters/configuration.ts:49
Parameters
- config: Configuration
Returns string

extractAutocompleteCollection

extractAutocompleteCollection(config: Configuration): string

- Defined in core/adapters/configuration.ts:73
Parameters
- config: Configuration
Returns string

extractAutocompleteHoverAutoFill

extractAutocompleteHoverAutoFill(config: Configuration): boolean

- Defined in core/adapters/configuration.ts:85
Parameters
- config: Configuration
Returns boolean

extractAutocompleteLanguage

extractAutocompleteLanguage(config: Configuration): string

- Defined in core/adapters/configuration.ts:61
Parameters
- config: Configuration
Returns string

extractAutocompleteNavigationCount

extractAutocompleteNavigationCount(config: Configuration): number

- Defined in core/adapters/configuration.ts:82
Parameters
- config: Configuration
Returns number

extractAutocompleteNavigationLabels

extractAutocompleteNavigationLabels(config: Configuration): object

- Defined in core/adapters/configuration.ts:147
Parameters
- config: Configuration
Returns object
- [field: string]: string

extractAutocompleteProductArea

extractAutocompleteProductArea(config: Configuration): string

- Defined in core/adapters/configuration.ts:52
Parameters
- config: Configuration
Returns string

extractAutocompleteProductCount

extractAutocompleteProductCount(config: Configuration): number

- Defined in core/adapters/configuration.ts:79
Parameters
- config: Configuration
Returns number

extractAutocompleteProductLanguage

extractAutocompleteProductLanguage(config: Configuration): string

- Defined in core/adapters/configuration.ts:64
Parameters
- config: Configuration
Returns string

extractAutocompleteSuggestionCount

extractAutocompleteSuggestionCount(config: Configuration): number

- Defined in core/adapters/configuration.ts:76
Parameters
- config: Configuration
Returns number

extractCategoryValues

extractCategoryValues(__namedParameters: object, category: string): any

- Defined in core/adapters/autocomplete.ts:49
Parameters
- __namedParameters: object
  - additionalInfo: object
- category: string
Returns any

extractCollection

extractCollection(config: Configuration): string

- Defined in core/adapters/configuration.ts:70
extract current collection from config

Parameters
- config: Configuration
Returns string

extractCollections

extractCollections(config: Configuration, defaultValue: string): Selectable<Collection>

- Defined in core/adapters/configuration.ts:103
Parameters
- config: Configuration
- defaultValue: string
Returns Selectable<Collection>

extractData

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

- Defined in core/adapters/search.ts:191
Parameters
- products: ProductWithMetadata[]
Returns Product[]

extractFields

extractFields(config: Configuration): string[]

- Defined in core/adapters/configuration.ts:55
Parameters
- config: Configuration
Returns string[]

extractINav

extractINav(config: Configuration): INav

- Defined in core/adapters/configuration.ts:154
Parameters
- config: Configuration
Returns INav

extractIndexedState

extractIndexedState(state: string | object): object

- Defined in core/adapters/configuration.ts:94
Parameters
- state: string | object
Returns object
- allIds: string[]
- selected: string

extractLanguage

extractLanguage(config: Configuration): string
extractLanguage(config: Configuration): string

- Defined in core/adapters/configuration.ts:58
Parameters
- config: Configuration
Returns string
- Defined in core/adapters/autocomplete.ts:9
Parameters
- config: Configuration
Returns string

extractLocation

extractLocation(config: Configuration): false | Location

- Defined in core/adapters/configuration.ts:166
Parameters
- config: Configuration
Returns false | Location

extractMaxRefinements

extractMaxRefinements(config: Configuration): number

- Defined in core/adapters/configuration.ts:151
Parameters
- config: Configuration
Returns number

extractNavigation

extractNavigation(navigation: Navigation): Navigation

- Defined in core/adapters/search.ts:44
Parameters
- navigation: Navigation
Returns Navigation

extractNavigationSort

extractNavigationSort(sort: SortType): Sort

- Defined in core/adapters/search.ts:35
Parameters
- sort: SortType
Returns Sort

extractNavigationsPinned

extractNavigationsPinned(config: Configuration): string[]

- Defined in core/adapters/configuration.ts:157
Parameters
- config: Configuration
Returns string[]

extractPage

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

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

extractPageSizes

extractPageSizes(config: Configuration, defaultValue: number): SelectableList<number>

- Defined in core/adapters/configuration.ts:114
Parameters
- config: Configuration
- defaultValue: number
Returns SelectableList<number>

extractPastPurchaseProductCount

extractPastPurchaseProductCount(config: Configuration): number

- Defined in core/adapters/configuration.ts:174
Parameters
- config: Configuration
Returns number

extractProductArea

extractProductArea(config: Configuration): string

- Defined in core/adapters/autocomplete.ts:18
Parameters
- config: Configuration
Returns string

extractProductLanguage

extractProductLanguage(config: Configuration): string

- Defined in core/adapters/autocomplete.ts:12
Parameters
- config: Configuration
Returns string

extractQuery

extractQuery(__namedParameters: object): Query

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

extractRealTimeBiasingExpiry

extractRealTimeBiasingExpiry(config: Configuration): number

- Defined in core/adapters/configuration.ts:183
Parameters
- config: Configuration
Returns number

extractRecordCount

extractRecordCount(recordCount: number): number

- Defined in core/adapters/search.ts:170
Parameters
- recordCount: number
Returns number

extractRefinement

extractRefinement(__namedParameters: object): ValueRefinement | RangeRefinement
extractRefinement(field: string, refinement: Refinement): SelectedRefinement

- Defined in core/adapters/search.ts:31
Parameters
- __namedParameters: object
  - high: number
  - low: number
  - total: number
  - type: "Range" & "Value"
  - value: string
Returns ValueRefinement | RangeRefinement
- Defined in core/adapters/request.ts:15
Parameters
- field: string
- refinement: Refinement
Returns SelectedRefinement

extractRefinementsPinned

extractRefinementsPinned(config: Configuration): Pinned

- Defined in core/adapters/configuration.ts:160
Parameters
- config: Configuration
Returns Pinned

extractRefinementsSort

extractRefinementsSort(config: Configuration): true | false | string[]

- Defined in core/adapters/configuration.ts:163
Parameters
- config: Configuration
Returns true | false | string[]

extractSaytCategoriesForFirstMatch

extractSaytCategoriesForFirstMatch(config: Configuration): boolean

- Defined in core/adapters/configuration.ts:144
Parameters
- config: Configuration
Returns boolean

extractSaytCategoryField

extractSaytCategoryField(config: Configuration): string

- Defined in core/adapters/configuration.ts:141
Parameters
- config: Configuration
Returns string

extractSecuredPayload

extractSecuredPayload(config: Configuration): SecuredPayload

- Defined in core/adapters/configuration.ts:169
Parameters
- config: Configuration
Returns SecuredPayload

extractSkip

extractSkip(page: number, pageSize: number): number

- Defined in core/adapters/request.ts:9
Parameters
- page: number
- pageSize: number
Returns number

extractSort

extractSort(__namedParameters: object): Sort

- Defined in core/adapters/request.ts:12
Parameters
- __namedParameters: object
  - descending: boolean
  - field: string
Returns Sort

extractSorts

extractSorts(config: Configuration): SelectableList<Sort>

- Defined in core/adapters/configuration.ts:127
Parameters
- config: Configuration
Returns SelectableList<Sort>

extractSuggestions

extractSuggestions(__namedParameters: object, query: string, category: string, labels: object, config: Configuration): Suggestions

- Defined in core/adapters/autocomplete.ts:22
Parameters
- __namedParameters: object
  - result: any
- query: string
- category: string
- labels: object
  - [key: string]: string
- config: Configuration
Returns Suggestions

extractTemplate

extractTemplate(template?: Template): Template

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

extractZone

extractZone(zone: Zone): Zone

- Defined in core/adapters/search.ts:142
Parameters
- zone: Zone
Returns Zone

filterExcludedRefinements

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

- Defined in core/adapters/search.ts:106
Parameters
- refinements: Refinement[]
Returns Refinement[]

filterNavigations

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

- Defined in core/adapters/search.ts:110
Parameters
- navigations: Navigation[]
Returns Navigation[]

initialState

initialState(config: Configuration): Partial<State>

- Defined in core/adapters/configuration.ts:15
Parameters
- config: Configuration
Returns Partial<State>

isAutocompleteAlphabeticallySorted

isAutocompleteAlphabeticallySorted(config: Configuration): boolean

- Defined in core/adapters/configuration.ts:88
Parameters
- config: Configuration
Returns boolean

isAutocompleteMatchingFuzzily

isAutocompleteMatchingFuzzily(config: Configuration): boolean

- Defined in core/adapters/configuration.ts:91
Parameters
- config: Configuration
Returns boolean

isRealTimeBiasEnabled

isRealTimeBiasEnabled(config: Configuration): boolean

- Defined in core/adapters/configuration.ts:180
Parameters
- config: Configuration
Returns boolean

mergeRefinements

mergeRefinements(__namedParameters: object, state: State): object

- Defined in core/adapters/refinements.ts:9
Parameters
- __namedParameters: object
  - navigation: object
    - navigationId: string
    - original: (ValueRefinement | RangeRefinement)[]
- state: State
Returns object
- navigationId: string
- refinements: (ValueRefinement | RangeRefinement)[]
- selected: any[]

mergeSelectedRefinements

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

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

mergeSuggestions

mergeSuggestions(suggestions: Array<object>, recommendations: RecommendationsResponse): object[]

- Defined in core/adapters/autocomplete.ts:52
Parameters
- suggestions: Array<object>
- recommendations: RecommendationsResponse
Returns object[]

pastPurchaseAutocompleteOverrides

pastPurchaseAutocompleteOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:206
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

pastPurchaseOverrides

pastPurchaseOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:209
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

pruneRefinements

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

- Defined in core/adapters/search.ts:88
Parameters
- navigations: Navigation[]
- state: State
Returns Navigation[]

recommendationsIdsOverrides

recommendationsIdsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:215
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

recommendationsNavigationsOverrides

recommendationsNavigationsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:212
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

recommendationsProductsOverrides

recommendationsProductsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:218
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

recommendationsSuggestionsOverrides

recommendationsSuggestionsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:221
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

refinementsMatch

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

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

refinementsOverrides

refinementsOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:203
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

searchOverrides

searchOverrides(config: Configuration): function

- Defined in core/adapters/configuration.ts:188
Parameters
- config: Configuration
Returns function
- - (...arg: T[]): T
  - Parameters
    - Rest ...arg: T[]
    Returns T

shouldAddPastPurchaseBias

shouldAddPastPurchaseBias(config: Configuration): boolean

- Defined in core/adapters/configuration.ts:177
Parameters
- config: Configuration
Returns boolean

termsMatch

termsMatch(lhs: string, rhs: string): boolean

- Defined in core/adapters/autocomplete.ts:55
Parameters
- lhs: string
- rhs: string
Returns boolean

Generated using TypeDoc