Class SearchFilter

constructor

• new SearchFilter(config?: SearchFilterConfiguration): SearchFilter

  Parameters

  • config: SearchFilterConfiguration = {}

    Configuration object for initializing the SearchFilter.

  Returns SearchFilter

callback

query

rgx

StaticOPERATORS

bind

• bind(html: HTMLElement): void

  Bind the SearchFilter controller to an HTML application

  Parameters

  • html: HTMLElement

  Returns void

filter

• filter(event: KeyboardEvent | null, query: string): void

  Perform a filtering of the content by invoking the callback function

  Parameters

  • event: KeyboardEvent | null

    The triggering keyboard event

  • query: string

    The input search string

  Returns void

unbind

• unbind(): void

  Release all bound HTML elements and reset the query.

  Returns void

StaticcleanQuery

• cleanQuery(query: string): string

  Clean a query term to standardize it for matching. See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize

  Parameters

  • query: string

    An input string which may contain leading/trailing spaces or diacritics

  Returns string

  A cleaned string of ASCII characters for comparison

StaticevaluateFilter

• evaluateFilter(obj: object, filter: FieldFilter): boolean

  Test whether a given object matches a provided filter

  Parameters

  • obj: object

    An object to test against

  • filter: FieldFilter

    The filter to test

  Returns boolean

  Whether the object matches the filter

StatictestQuery

• testQuery(rgx: RegExp, value: string): boolean

  A helper method to test a value against a precomposed regex pattern.

  Parameters

  • rgx: RegExp

    The regular expression to test

  • value: string

    The value to test against

  Returns boolean

  Does the query match?