Class Index

constructor

• new Index(n?, sentinel?, normalise?): Index

• Parameters

  • n: number = 2

    n-gram width
  • sentinel: string = '\n'

    https://en.wikipedia.org/wiki/Sentinel_value|sentinel character – added to term on add and has to ensure that whole terms on index are checked.
  • normalise: NormaliseFunction = Index.normalise

    normalises search terms, defaults to static Index.normalise

  Returns Index

Readonlyn

Readonlysentinel

add

• add(term, key?): void

• Add a term into index by key

  Parameters

  • term: string
  • Optionalkey: Indexable

  Returns void

  Remarks

  It is recommended to use strings as keys, as currently using numbers might be slow.

  Throws

  RangeError if term is shorter than n

all

• all(): object

• Returns whole index as an object

  Returns object

has

• has(term): boolean

• Does the index has term?

  Parameters

  • term: string

  Returns boolean

  Throws

  RangeError if term is shorter than n

lengths

• lengths(): Lengths

• Lengths of all the terms in the index

  Returns Lengths

locations

• locations(term): Locations

• Search by term and return locations where this term occurs

  Parameters

  • term: string

  Returns Locations

  Throws

  RangeError if term is shorter than n

normalise

• normalise(term): string

• Normalise a term

  Calls the normalisation function given on constructor, and checks that term length is at least index length.

  Parameters

  • term: string

  Returns string

  Throws

  RangeError if term is shorter than n

search

• search(term): Indexable[]

• Search by term and return indices of matching terms

  Parameters

  • term: string

  Returns Indexable[]

  Throws

  RangeError if term is shorter than n

size

• size(): number

• Size of the index (number of terms in the index)

  Returns number

Staticfrom

• from(terms, ...args): Index

• Create index from terms

  Terms can be an array of terms or an object mapping ids to terms

  Parameters

  • terms: Terms
  • Rest...args: [number?, string?, NormaliseFunction?]

  Returns Index

Staticnormalise

• normalise(term): string

• Collapse and trim whitespace, then lowercase the input

  Parameters

  • term: string

  Returns string

StaticupdateDescription

• updateDescription(description, id, pos): {}

• Parameters

  • description: StringDescription
  • id: Indexable
  • pos: number

  Returns {}