Class SearchService

Hierarchy

BaseService
- SearchService

Constructors

constructor

new SearchService(): SearchService
Returns SearchService

Inherited from BaseService.constructor

Properties

`Protected` baseUrl

baseUrl: string = ...

queryStringParams

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

Type declaration

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

searchUrl

searchUrl: string = ...

Methods

addFacetValue

addFacetValue(field: string, value: string): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

bindComponents

bindComponents(searchResponse: SearchResponse): void
Parameters
- searchResponse: SearchResponse
Returns void

bindFacetsListComponent

bindFacetsListComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindLandingPageComponent

bindLandingPageComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindModifiedQueryComponent

bindModifiedQueryComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindPageSizeComponent

bindPageSizeComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindPaginationComponent

bindPaginationComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindQuerySuggestionsComponent

bindQuerySuggestionsComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSearchFieldComponent

bindSearchFieldComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSearchResultsComponent

bindSearchResultsComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSearchResultsListComponent

bindSearchResultsListComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSelectedFacetsComponent

bindSelectedFacetsComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindSortingComponent

bindSortingComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindTabsComponent

bindTabsComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

bindZoneComponent

bindZoneComponent(searchResponse: undefined | SearchResponse): void
Parameters
- searchResponse: undefined | SearchResponse
Returns void

excludeFacetValue

excludeFacetValue(field: string, value: string): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

`Protected` generateGuid

generateGuid(): string
Returns string

Inherited from BaseService.generateGuid

getRequestFromUrl

getRequestFromUrl(): SearchRequest
Returns SearchRequest

`Protected` getUrl

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

Inherited from BaseService.getUrl

`Protected` getVisitId

getVisitId(): string
Returns string

Inherited from BaseService.getVisitId

`Protected` getVisitorId

getVisitorId(): string
Returns string

Inherited from BaseService.getVisitorId

`Protected` httpPost

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

Inherited from BaseService.httpPost

includeFacetValue

includeFacetValue(field: string, value: string): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

paginate

paginate(page: number): Promise<SearchResponse>
Parameters
- page: number
Returns Promise<SearchResponse>

query

query(query?: string, selectedFacets?: undefined | SelectedFacets, disableSpellcheck?: boolean): Promise<void | SearchResponse>
Parameters
- Optional query: string
- selectedFacets: undefined | SelectedFacets = undefined
- disableSpellcheck: boolean = false
Returns Promise<void | SearchResponse>

removeFacetValue

removeFacetValue(field: string, value: string): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

search

search(searchRequest: SearchRequest): Promise<SearchResponse>
Parameters
- searchRequest: SearchRequest
Returns Promise<SearchResponse>

searchWithin

searchWithin(value: string): Promise<SearchResponse>
Parameters
- value: string
Returns Promise<SearchResponse>

selectTab

selectTab(value?: string): Promise<SearchResponse>
Parameters
- Optional value: string
Returns Promise<SearchResponse>

setFacetValue

setFacetValue(field: string, value: string): Promise<SearchResponse>
Parameters
- field: string
- value: string
Returns Promise<SearchResponse>

setPageSize

setPageSize(pageSize: number): Promise<SearchResponse>
Parameters
- pageSize: number
Returns Promise<SearchResponse>

`Protected` setSeoElements

setSeoElements(searchResponse: SearchResponse): void
Parameters
- searchResponse: SearchResponse
Returns void

sort

sort(value?: string): Promise<SearchResponse>
Parameters
- Optional value: string
Returns Promise<SearchResponse>

`Protected` stripHtml

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

Inherited from BaseService.stripHtml

`Protected` triggerBindEvent

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

Inherited from BaseService.triggerBindEvent

`Protected` triggerEvent

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

Inherited from BaseService.triggerEvent