
Product
Introducing Socket Fix for Safe, Automated Dependency Upgrades
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
fuzzyjs is a fuzzy search algorithm in javascript.
test
Tests a query against a source using fuzzy matching
import { test } from "fuzzyjs";
test("ssjs", "Set Syntax: JavaScript");
true;
function test(query: string, source: string, opts?: TestOptions): boolean;
type TestOptions = {
caseSensitive?: boolean; // (default: false)
};
match
Matches a query against a source using fuzzy matching, returns information about the result
import { match } from 'fuzzyjs'
match('ssjav', 'Set Syntax: JavaScript')
{
match: true,
score: 22,
ranges: [
{ start: 0, stop: 1 },
{ start: 4, stop: 5 },
{ start: 12, stop: 15 }
]
}
function match(query: string, source: string, opts?: MatchOptions): MatchResult;
type MatchOptions = {
caseSensitive?: boolean;
strategy?: ScoreStrategy; // (default: defaultStrategy, see below)
withScore?: boolean; // (default: true)
};
type MatchResult = {
match: boolean;
score: number; // only if `withScore` is true, else undefined
ranges: MatchRange[];
};
surround
Surround parts of the string that matched with prefix and suffix
import { match, surround } from "fuzzyjs";
const result = match("ssjav", "Set Syntax: JavaScript");
surround("Set Syntax: JavaScript", {
result,
prefix: "<strong>",
suffix: "</strong>",
});
("<strong>S</strong>et <strong>S</strong>yntax: <strong>Jav</strong>aScript");
function surround(source: string, options: SurroundOptions): string;
type SurroundOptions = {
result: {
ranges: MatchRange[];
};
prefix?: string; // (default: '')
suffix?: string; // (default: '')
};
filter
Can be used as a Array.prototype.filter callback.
import { filter as fuzzy } from "fuzzyjs";
const sources = [
"Set Syntax: JavaScript",
"Set Syntax: CSS",
"Set Syntax: HTML",
];
sources.filter(fuzzy("ssjs", { iterator: (item) => item }));
["Set Syntax: JavaScript"];
const sources = [
{ name: { foo: "Set Syntax: JavaScript" } },
{ name: { foo: "Set Syntax: CSS" } },
{ name: { foo: "Set Syntax: HTML" } },
];
sources.filter(fuzzy("ssjs", { iterator: (source) => source.name.foo }));
[{ name: { foo: "Set Syntax: JavaScript" } }];
function filter<TItem>(
query: string,
options: FilterOptions<TItem>
): (source: TItem) => boolean;
type FilterOptions<TItem> = {
caseSensitive?: boolean;
iterator: (source: TItem) => string;
};
sort
Can be used as a Array.prototype.sort callback.
If you have a large array of objects, you might want to pass idAccessor
as it creates a memoization table which reduces drastically how many times the fuzzy matching algorithm will be called.
import { sort as fuzzy } from "fuzzyjs";
const sources = [
"Set Syntax: CSS",
"Set Syntax: HTML",
"Set Syntax: JavaScript",
];
sources.sort(fuzzy("ssjs", { iterator: (item) => item }));
[("Set Syntax: JavaScript", "Set Syntax: CSS", "Set Syntax: HTML")];
const sources = [
{ name: { id: 0, foo: "Set Syntax: CSS" } },
{ name: { id: 1, foo: "Set Syntax: HTML" } },
{ name: { id: 2, foo: "Set Syntax: JavaScript" } },
];
sources.sort(fuzzy("ssjs", { iterator: (source) => source.name.foo }));
[
{ name: { id: 2, foo: "Set Syntax: JavaScript" } },
{ name: { id: 0, foo: "Set Syntax: CSS" } },
{ name: { id: 1, foo: "Set Syntax: HTML" } },
];
function sort<TItem>(
query: string,
options?: SortOptions<TItem>
): (leftSource: TItem, rightSource: TItem) => 0 | 1 | -1;
type SortOptions<TItem> = {
caseSensitive?: boolean;
iterator: (item: TItem) => string;
};
A scoring function is a function that given two context, returns a number (either positive or negative) that will be added the the match score.
A leading character is a character that matters more than others.
These are made of capitals and letters following -_ ./\
.
function pushScore(
previousContext: ScoreContext | undefined,
context: ScoreContext
): number;
type ScoreContext = {
currentScore: number; // the current match score
character: string; // the current character
match: boolean; // is the character matching the source string
leading: boolean; // is the character leading
};
Link to default strategy: here.
fuzzyjs is licensed under MIT License.
FAQs
Simple fuzzy matching
The npm package fuzzyjs receives a total of 1,175 weekly downloads. As such, fuzzyjs popularity was classified as popular.
We found that fuzzyjs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Automatically fix and test dependency updates with socket fix—a new CLI tool that turns CVE alerts into safe, automated upgrades.
Security News
CISA denies CVE funding issues amid backlash over a new CVE foundation formed by board members, raising concerns about transparency and program governance.
Product
We’re excited to announce a powerful new capability in Socket: historical data and enhanced analytics.