Skip to content
rapid-fuzzy
Search
Ctrl
K
Cancel
GitHub
npm
Select theme
Dark
Light
Auto
Menu
Start here
Getting started
Playground
Why rapid-fuzzy?
Benchmarks
Guides
Fuzzy search
How matching works
Object search
Persistent indexes
Highlighting matches
String similarity
Choosing an algorithm
UI frameworks
Unicode and non-Latin scripts
Performance and untrusted input
Errors and edge cases
Runtimes
Node.js and SSR
Browsers and bundlers
Cloudflare Workers
Deno and Bun
Troubleshooting
Migration guides
FlexSearch
fuse.js
fuzzball
fuzzysort
leven / fastest-levenshtein
MiniSearch
string-similarity
uFuzzy
API reference
Enumerations
MatchType
Classes
FuzzyIndex
FuzzyObjectIndex
KeyedFuzzyIndex
Interfaces
HighlightOptions
HighlightRange
IndexSearchResult
KeyClosestOptions
KeyConfig
KeySearchOptions
KeySearchResult
ObjectIndexOptions
ObjectIndexSearchOptions
ObjectSearchOptions
ObjectSearchResult
SearchOptions
SearchResult
Type Aliases
KeyMatchMode
KeyPath
KeyScoreMode
NodeBuffer
Variables
__napiBindingTarget
Functions
closest
damerauLevenshtein
damerauLevenshteinBatch
damerauLevenshteinMany
damerauLevenshteinManyU32
hamming
hammingBatch
hammingMany
hammingManyU32
highlight
highlightRanges
indel
indelBatch
indelMany
indelManyU32
jaro
jaroBatch
jaroMany
jaroManyF64
jaroWinkler
jaroWinklerBatch
jaroWinklerMany
jaroWinklerManyF64
levenshtein
levenshteinBatch
levenshteinMany
levenshteinManyU32
normalizedHamming
normalizedHammingBatch
normalizedHammingMany
normalizedHammingManyF64
normalizedIndel
normalizedIndelBatch
normalizedIndelMany
normalizedIndelManyF64
normalizedLevenshtein
normalizedLevenshteinBatch
normalizedLevenshteinMany
normalizedLevenshteinManyF64
partialRatio
partialRatioBatch
partialRatioMany
partialRatioManyF64
search
searchKeys
searchObjects
sorensenDice
sorensenDiceBatch
sorensenDiceMany
sorensenDiceManyF64
tokenSetRatio
tokenSetRatioBatch
tokenSetRatioMany
tokenSetRatioManyF64
tokenSortRatio
tokenSortRatioBatch
tokenSortRatioMany
tokenSortRatioManyF64
weightedRatio
weightedRatioBatch
weightedRatioMany
weightedRatioManyF64
GitHub
npm
Select theme
Dark
Light
Auto
HighlightOptions
Options for
highlight
.
Properties
Section titled “Properties”
Property
Type
Description
escapeHtml?
boolean
HTML-escape the text of
item
(
&
,
<
,
>
,
"
and
'
), both matched and unmatched parts, before the markers are added. The markers and the callback’s return value are inserted unchanged. Defaults to
false
.