Skip to content

prepareFuzzySearch

Official

Construct a fuzzy search callback that runs on a target string. Performance may be an issue if you are running the search for more than a few thousand times. If performance is a problem, consider using prepareSimpleSearch instead.

Import:

import { prepareFuzzySearch } from 'obsidian';

Signature:

function prepareFuzzySearch(query: string): (text: string) => SearchResult | null

Parameters:

ParameterTypeDescription
querystringthe fuzzy query.

Returns: (text: string) => SearchResult | null — fn - the callback export function to apply the search on or null if the query is empty.