Class BaseService`Abstract`

Hierarchy (View Summary)

BaseService

Index

Constructors

Properties

baseUrl fieldMappings queryStringParams searchUrl variantFieldMappings

Accessors

Methods

generateGuid getApiHeaders getFullUrl getHeaders getNumber getString getUrl getValue 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;
} = ...

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: string | undefined,
prefix: string | undefined,
): string | undefined
Parameters
- url: string | undefined
- prefix: string | undefined
Returns string | undefined

`Protected`getHeaders

getHeaders(): Headers
Returns Headers

`Protected`getNumber

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

`Protected`getString

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

`Protected`getUrl

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

`Protected`getValue

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

getVisitId

getVisitId(): string
Returns string

getVisitorId

getVisitorId(): string
Returns string

`Protected`httpPost

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

`Protected`stripHtml

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

`Protected`triggerBindEvent

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

`Protected`triggerEvent

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