uFuzzy 使用指南

uFuzzy 使用指南

uFuzzyA tiny, efficient fuzzy search that doesn't suck项目地址:https://gitcode.com/gh_mirrors/uf/uFuzzy

---

项目介绍

📚 μFuzzy 是一个轻量级且高效的模糊搜索库，专为短搜索词（针）对大量中短文本项（ haystack）的匹配设计。它类似于一个更宽容的 String.includes() 方法，适用于不完全匹配的场景。当你在处理自动补全、建议列表或是在长标题、名称、文件路径等中进行快速查找时，μFuzzy 能大显身手。

该库提供了灵活的模式匹配选项，包括默认的多插入模式（要求所有字母数字字符按顺序出现在匹配项中），以及容忍单个错误的单一错误模式（Damerau-Levenshtein距离为1）。它还能高效地处理非顺序项匹配、排除特定子串以及精确匹配特殊字符组合。

项目快速启动

安装 μFuzzy 非常简单，无论是 Node.js 环境还是浏览器环境都得到了支持。

Node.js 环境

npm install @leeoniya/ufuzzy

随后，在你的代码中：

const uFuzzy = require('@leeoniya/ufuzzy');

let haystack = ['puzzle', '超级给力的东西(现在附带东西)', 'FileName.js', '/feeding/the/catPic.jpg'];
let needle = '喂猫';
let uf = new uFuzzy(); // 默认配置
let idxs = uf.filter(haystack, needle); 

if (idxs && idxs.length > 0) {
    // 可以进一步排序或获取详细信息
}

浏览器环境

只需将以下脚本标签添加到 HTML 文件中：

<script src="https://cdn.jsdelivr.net/npm/@leeoniya/ufuzzy@latest/dist/uFuzzy.iife.min.js"></script>

然后在 JavaScript 中即可直接使用 ufuzzy 全局对象。

应用案例和最佳实践

使用 μFuzzy 进行自动补全是其常见且高效的场景之一。例如，假设你有一个长长的命令列表，用户输入部分命令后希望获得即时的补全提示：

uf.filter(commands, userInput).then(results => {
    // 显示 results 中的命令作为补全建议
});

对于最佳实践，确保利用 filter 方法预过滤，仅当结果较少时（比如少于1000个）再进行详细的 info 获取或排序，以保持响应速度。

典型生态项目

尽管 μFuzzy 本身是作为一个独立库存在的，但在实际开发中，它可以轻松集成到各种前端框架和后端应用中，如 Vue、React 或者 Node.js 的 RESTful API服务中。开发者通常会在构建搜索功能、自动完成组件或是任何需要文本匹配的地方利用它的强大能力。

由于它专注于核心的模糊匹配逻辑，没有特定的“生态项目”与其直接关联，但任何需要高效字符串匹配的项目都可以视为其应用领域。开发者社区可能会围绕 μFuzzy 开发封装了特定UI交互的组件，或是在数据处理流水线中作为中间件使用，从而形成其间接的生态系统。

---

以上即是对 μFuzzy 的简明使用指南。通过这四个模块的介绍，你应该能够快速上手并将其应用于你的项目中，提高搜索体验。记得在实际应用中根据需求调整策略，以达到最佳效果。

uFuzzyA tiny, efficient fuzzy search that doesn't suck项目地址:https://gitcode.com/gh_mirrors/uf/uFuzzy