Class BaseService`Abstract`

Hierarchy

BaseService

Index

Constructors

Properties

baseUrl fieldMappings queryStringParams searchUrl variantFieldMappings

Accessors

Methods

generateGuid getApiHeaders getFullUrl getHeaders getNumber getString getUrl getValue getVariants getVisitId getVisitorId httpPost stripHtml triggerBindEvent triggerEvent

Constructors

constructor

new BaseService(): BaseService
Returns BaseService

Properties

`Protected` `Abstract` baseUrl

baseUrl: string

`Protected` fieldMappings

fieldMappings: ServiceFieldMappings

queryStringParams

queryStringParams: {
    disableSpellcheck: string;
    page: string;
    pageSize: string;
    query: string;
    requestType: string;
    searchWithin: string;
    sort: string;
} = ...

Type declaration

disableSpellcheck: string
page: string
pageSize: string
query: string
requestType: string
searchWithin: string
sort: string

searchUrl

searchUrl: string = ...

`Protected` variantFieldMappings

variantFieldMappings: ServiceVariantFieldMappings

Accessors

`Protected` onSearchPage

get onSearchPage(): boolean
Returns boolean

Methods

`Protected` generateGuid

generateGuid(): string
Returns string

`Protected` getApiHeaders

getApiHeaders(): Headers
Returns headers with X-HawkSearch-ClientGuid, X-Forwarded-For, and User-Agent for API calls.

Returns Headers

`Protected` getFullUrl

getFullUrl(url, prefix): undefined | string
Parameters
- url: undefined | string
- prefix: undefined | string
Returns undefined | string

`Protected` getHeaders

getHeaders(): Headers
Returns Headers

`Protected` getNumber

getNumber(data, fieldMappings, defaultValue?): undefined | number
Parameters
- data: object
- fieldMappings: string[]
- Optional defaultValue: number
Returns undefined | number

`Protected` getString

getString(data, fieldMappings, defaultValue?): undefined | string
Parameters
- data: object
- fieldMappings: string[]
- Optional defaultValue: string
Returns undefined | string

`Protected` getUrl

getUrl(data, fieldMappings, prefix?): undefined | string
Parameters
- data: object
- fieldMappings: string[]
- Optional prefix: string
Returns undefined | string

`Protected` getValue

getValue(data, fieldMappings): undefined | string[]
Parameters
- data: object
- fieldMappings: string[]
Returns undefined | string[]

`Protected` getVariants

getVariants(document): {
items: undefined | ItemVariant[];
selectedItem?: ItemVariant;
}
Parameters
- document: RawVariantDocument
Returns {
items: undefined | ItemVariant[];
selectedItem?: ItemVariant;
}
- items: undefined | ItemVariant[]
- Optional selectedItem?: ItemVariant

getVisitId

getVisitId(): string
Returns string

getVisitorId

getVisitorId(): string
Returns string

`Protected` httpPost

httpPost<T>(relativeUrl, body?, customHeaders?, isAbsoluteUrl?): Promise<T>
Type Parameters
- T
Parameters
- relativeUrl: string
- Optional body: any
- Optional customHeaders: any
- Optional isAbsoluteUrl: boolean
Returns Promise<T>

`Protected` stripHtml

stripHtml(input): string
Parameters
- input: string
Returns string

`Protected` triggerBindEvent

triggerBindEvent<T>(component, data, filter?): void
Type Parameters
- T
Parameters
- component: keyof HawkSearchComponents
- data: T
- Optional filter: string
Returns void

`Protected` triggerEvent

triggerEvent<T>(name, data): void
Type Parameters
- T
Parameters
- name: string
- data: T
Returns void