# Options

# Basic Options

# isCaseSensitive

  • Type: boolean
  • Default: false

Indicates whether comparisons should be case sensitive.

# includeScore

  • Type: boolean
  • Default: false

Whether the score should be included in the result set. A score of 0indicates a perfect match, while a score of 1 indicates a complete mismatch.

# includeMatches

  • Type: boolean
  • Default: false

Whether the matches should be included in the result set. When true, each record in the result set will include the indices of the matched characters. These can consequently be used for highlighting purposes.

# minMatchCharLength

  • Type: number
  • Default: 1

Only the matches whose length exceeds this value will be returned. (For instance, if you want to ignore single character matches in the result, set it to 2).

# shouldSort

  • Type: boolean
  • Default: true

Whether to sort the result list, by score.

# findAllMatches

  • Type: boolean
  • Default: false

When true, the matching function will continue to the end of a search pattern even if a perfect match has already been located in the string.

# keys

  • Type: Array
  • Default: []

List of keys that will be searched. This supports nested paths, weighted search, searching in arrays of strings and objects.

# Fuzzy Matching Options

# location

  • Type: number
  • Default: 0

Determines approximately where in the text is the pattern expected to be found.

# threshold

  • Type: number
  • Default: 0.6

At what point does the match algorithm give up. A threshold of 0.0 requires a perfect match (of both letters and location), a threshold of 1.0 would match anything.

# distance

  • Type: number
  • Default: 100

Determines how close the match must be to the fuzzy location (specified by location). An exact letter match which is distance characters away from the fuzzy location would score as a complete mismatch. A distance of 0 requires the match be at the exact location specified. A distance of 1000 would require a perfect match to be within 800 characters of the location to be found using a threshold of 0.8.

TIP

To better understand how location, threshold, and distance work together, read our Scoring Theory.

# Advanced Options

# useExtendedSearch beta

  • Type: boolean
  • Default: false

When true, it enables the use of unix-like search commands. See example.

# getFn

  • Type: Function
  • Default: (obj: T, path: string) => string[] | string

The function to use to retrieve an object's value at the provided path (i.e, key). The default will search nested paths.

WARNING

There aren't many cases where you'd want to use your own getFn.