Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "types"

Index

Interfaces

Type aliases

Type aliases

AutocompleteOptions

AutocompleteOptions: { highlight?: undefined | false | true; language?: undefined | string; prefixThreshold?: undefined | number }

Type declaration

  • Optional highlight?: undefined | false | true

    Indicates whether the prefix should be highlighted in the result or not.

  • Optional language?: undefined | string

    The language to use for the autocomplete requests. If left empty, all languages will be used.

  • Optional prefixThreshold?: undefined | number

    The number of characters that have to be typed before the autocomplete function sends the first request. The default value is 0.

DidYouMeanClasses

DidYouMeanClasses: { element: string[]; wrapper: string[] }

Type declaration

  • element: string[]
  • wrapper: string[]

FacetConfig

FacetConfig: { baseName: string; multiSelect: boolean }

Type declaration

  • baseName: string
  • multiSelect: boolean

FacetCount

FacetCount: { count: number; filterQuery: string; value: FacetValue }

Type declaration

  • count: number
  • filterQuery: string
  • value: FacetValue

FacetData

FacetData: { counts: FacetCount[]; name: string }

Type declaration

FacetValue

FacetValue: string | number | boolean

FetchClientOptions

FetchClientOptions: { autocomplete?: undefined | false | true; customParams?: URLParam[]; searchTerm?: undefined | string }

Defines the URL-building behaviour of the FetchClient

Type declaration

  • Optional autocomplete?: undefined | false | true
  • Optional customParams?: URLParam[]
  • Optional searchTerm?: undefined | string

GroupByField

GroupByField: { groups: GroupByValue[]; matches: number; name: string }

Type declaration

GroupByValue

GroupByValue: { numRows: number; results: Result[]; value: string }

Type declaration

  • numRows: number
  • results: Result[]
  • value: string

Highlighting

Highlighting: {}

Contains all the keys that were marked with highlighting in the SmartSearch backend

Type declaration

  • [k: string]: string[]

HighlightingData

HighlightingData: {}

Type declaration

PaginationClasses

PaginationClasses: { currentPage: string[]; nextButton: string[]; pageButton: string[]; pagination: string[]; prevButton: string[] }

Type declaration

  • currentPage: string[]
  • nextButton: string[]
  • pageButton: string[]
  • pagination: string[]
  • prevButton: string[]

PaginationData

PaginationData: { pageCount: number; pageNumber: number; pageSize: number }

Type declaration

  • pageCount: number
  • pageNumber: number
  • pageSize: number

PaginationParams

PaginationParams: DynamicPaginationParams | StaticPaginationParams

RenderDidYouMeanFunction

RenderDidYouMeanFunction: (value: string) => string

Type declaration

    • (value: string): string

    • Parameters

      • value: string

      Returns string

RenderPaginationFunction

RenderPaginationFunction: (value: string) => string

Type declaration

    • (value: string): string

    • Parameters

      • value: string

      Returns string

RequestParameters

RequestParameters: {}

Type declaration

  • [key: string]: string[]

Result

Result: { id: string; link: string; title: string[] }

Type declaration

  • [key: string]: string | number | string[] | number[]
  • id: string
  • link: string
  • title: string[]

SearchResultClasses

SearchResultClasses: { element: string[]; wrapper: string[] }

Type declaration

  • element: string[]
  • wrapper: string[]

SmartSearchOptions

SmartSearchOptions: { apiEndpoint?: undefined | string; autocompleteOptions?: AutocompleteOptions; customParams?: URLParam[] }

Type declaration

  • Optional apiEndpoint?: undefined | string

    Set this option if the api is not reachable under the default endpoint for some reason. This string gets attached directly to the hostname. Make sure it starts with a slash. Be sure to check out the examples at the start page of this api-documentation. Default is API_ENDPOINT

  • Optional autocompleteOptions?: AutocompleteOptions
  • Optional customParams?: URLParam[]

    Custom URL parameters to be used in every request. This includes pagination, facet filtering and autocomplete.

SmartSearchResponse

SmartSearchResponse: { __paginationData?: PaginationData; didYouMean: string[]; explainData: object; facetConfigs: FacetConfig[]; facets: FacetData[]; fragSize: number; groups: GroupByField[]; highlighting: HighlightingData; numRows: number; requestParameters: {}; responseTime: number; results: Result[]; rows: number }

Type declaration

TemplateFunction

TemplateFunction: (data: Result, highlights: Highlighting) => string

Type declaration

URLParam

URLParam: {}

Type declaration

  • [key: string]: string

Generated using TypeDoc