Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Type aliases

TermValuesBuilder

TermValuesBuilder<T>: (item: T) => any[]

describes a term values builder, taking an item and returning term values array

param

object to index

returns

array of term values to add to the index

Type parameters

  • T

Type declaration

    • (item: T): any[]
    • Parameters

      • item: T

      Returns any[]

Variables

Const INDEXER_CHARS_BOUNDARIES

INDEXER_CHARS_BOUNDARIES: " \t\n\r\u000b!\"£$%^&*()_+{}[]:@~;#?,./|¬=<>" = ' \t\n\r\v!"£$%^&*()_+{}[]:@~;#?,./|¬=<>'

word boundary chars

Const INDEXER_CHARS_CAPITAL

INDEXER_CHARS_CAPITAL: "ABCDEFGHIJKLMNOPQRSTUVWXYZ" = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ'

Capital chars

Const INDEXER_CHARS_IGNORE

INDEXER_CHARS_IGNORE: "-'`" = "-'`"

chars to ignore

Const INDEXER_CHARS_QUOTE

INDEXER_CHARS_QUOTE: "\"" = '"'

quote chars

Functions

indexExact

  • indexExact(input: any): string[]
  • index the input exactly

    Parameters

    • input: any

      input to be indexed

    Returns string[]

indexGetWords

  • indexGetWords(text: string): string[]
  • Extacts words from the text passed

    Parameters

    • text: string

      text to get words from

    Returns string[]

normalIndexOf

  • normalIndexOf(searchText: string, findText: string): number
  • Gets the index of the text ignoring diacritics

    Parameters

    • searchText: string

      text to search

    • findText: string

      text to find

    Returns number

toNormal

  • toNormal(text: string): string
  • Removes diacritics

    Parameters

    • text: string

      text to process

    Returns string

Legend

  • Variable
  • Function
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Enumeration
  • Class with type parameter

Generated using TypeDoc