Gjsify LogoGjsify Logo

Hierarchy

  • FuzzyMutableIndex

Index

Constructors

Properties

name: string

Methods

  • begin_bulk_insert(): void
  • Start a bulk insertion. fuzzy is not ready for searching until dzl_fuzzy_mutable_index_end_bulk_insert() has been called.

    This allows for inserting large numbers of strings and deferring the final sort until dzl_fuzzy_mutable_index_end_bulk_insert().

    Returns void

  • contains(key: string): boolean
  • end_bulk_insert(): void
  • insert(key: string, value: object): void
  • Inserts a string into the fuzzy matcher.

    Parameters

    • key: string

      A UTF-8 encoded string.

    • value: object

      A value to associate with key.

    Returns void

  • DzlFuzzyMutableIndex searches within fuzzy for strings that fuzzy match needle. Only up to max_matches will be returned.

    TODO: max_matches is not yet respected.

    Parameters

    • needle: string

      The needle to fuzzy search for.

    • max_matches: number

      The max number of matches to return.

    Returns FuzzyMutableIndexMatch[]

  • remove(key: string): void
  • unref(): void
  • Decrements the reference count of fuzzy by one. When the reference count reaches zero, the structure will be freed.

    Returns void

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method