npm 包 fuse-checkmark 使用教程

介绍

fuse-checkmark 是一个基于 Fuse.js 的中英文字符模糊匹配工具,适用于前端和 Node.js 环境。使用 Fuse.js 的模糊匹配算法,快速找到最相似的字符串,且中英文字符均有支持。该工具封装了一些常用的模糊匹配设置,并提供了一些使用的便捷方式。

安装

你可以通过使用 npm 包管理器安装 fuse-checkmark:

--- ------- -------------- ------

使用

以下是 fuse-checkmark 的使用方式:

----- - ------------- - - -------------------------

----- ---- - -
    ------ -------- --- ---
    ------ --------- --- ---
    ------ --------- --- ---
    ------ -------- --- --
-

----- ------ - ------------------- -------- -------
-------------------

运行结果是:

- - ----- -------- --- - - -

在以上代码中,我们通过引入了 fuse-checkmark 模块,然后将需要匹配的列表和待匹配的字符串传递给 fuseCheckmark 函数。可以通过第三个参数指定进行匹配的属性名(name),返回的结果是一个数组,包含了与待匹配字符串最相似的对象。

API

fuseCheckmark(list, query, key)

  • list:需要匹配的列表,数组类型,每个元素是一个对象。
  • query:待匹配的字符串。
  • key:指定进行匹配的属性名,可选项,默认为 name

返回与待匹配字符串最相似的元素数组。

fuseCheckmarkList(list, query, options)

  • list:需要匹配的列表,数组类型,每个元素是一个对象。
  • query:待匹配的字符串。
  • options:可选项对象,可包含以下属性:
    • keys:指定进行匹配的属性集合,数组类型,默认为 ['name']
    • minMatchCharLength:指定最小匹配到字符长度,整数类型,默认为 1
    • threshold:指定匹配阈值,浮点数类型,范围在 0~`1,默认为 0.6`。
    • limit:指定匹配结果数的限制,整数类型,默认为 10

返回与待匹配字符串最相似的结果数组。

示例

以下是一个使用较为详细的示例:

----- - ----------------- - - -------------------------

----- ---- - -
    ------ ------ ------- ----- ------ -------
    ------ ----- --- ---- ------ -------
    ------ ------- -------- -- -------- ------ -------
    ------ ----- ------- --- ---- ------ -------
    ------ --- ------- ------ ------ -------
-

----- ------ - ---------
----- -------- - -
    ----- ---------
    ------------------- --
    ---------- ----
    ------ -
-
----- ------- - ----------------------- ------- ---------
----------------------- --------

----- ------ - --- ---- ----
----- -------- - -
    ----- ---------
    ------------------- --
    ---------- ----
    ------ -
-
----- ------- - ----------------------- ------- ---------
----------------------- --------

----- ------ - -------
----- -------- - -
    ----- ----------
    ------------------- --
    ---------- ----
    ------ --
-
----- ------- - ----------------------- ------- ---------
----------------------- --------

运行结果是:

-------- - - ----- ------ ------- ----- ------ ----- - -
-------- - - ----- ----- ------- --- ---- ------ ----- - -
-------- --

以上代码中,我们先定义了一个列表数组,然后使用 fuseCheckmarkList 函数进行不同的匹配操作。在第一个例子中,我们通过指定匹配的属性为 name,设置了最小匹配字符长度为 2,阈值为 0.3,限制了最多匹配 3 条结果,匹配结果返回了与待匹配字符串最相似的结果。在第二个例子中,我们使用了一个更加复杂的字符串,并且指定了四种匹配属性,设置的阈值比第一个例子要高一些,返回的结果中包含了 Asus Zenbook Pro 14 笔记本电脑。在第三个例子中,我们设置的待匹配字符串为一个数字,限制了最小匹配到 4 个字符,阈值为 0.5,由于列表中没有匹配到结果,返回了一个空数组。

结论

fuse-checkmark 是一个非常适用于前端和 Node.js 环境的模糊匹配工具,可用于很多不同的场景。本文介绍了它的安装、使用方法和 API,通过示例代码详细演示了不同的配置和匹配方式。我们可以根据具体的需求来定制化自己的匹配算法,提高了匹配的准确性和效率。

来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60065b44c6eb7e50355dbe4f


猜你喜欢

  • npm 包 react-native-hot-updated 使用教程

    React Native 是一种用于构建跨平台原生应用程序的开源框架,它是由 Facebook 创建并开源的。随着 React Native 的越来越流行,越来越多的开发者开始尝试在其中实现热更新功能...

    3 年前
  • npm 包 react-native-nearby-api-windows 使用教程

    介绍 react-native-nearby-api-windows 是一个专为 Windows 平台下 React Native 应用开发的 npm 包。它提供了一套丰富的 API,让开发者能够方便...

    3 年前
  • npm 包 unidirectional 使用教程:建立全方位单向数据流

    在现代前端开发中,单向数据流已经成为一个非常流行的开发模式,广泛应用于 React、Vue 等前端框架中。unidirectional 是一款相对较为轻量的 npm 包,帮助开发者更加便捷地建立全方位...

    3 年前
  • npm 包 zd-once 使用教程

    在前端开发中,我们常常需要使用一些工具库和插件,如何从众多的 npm 包中选择合适的包并正确使用,是每个前端开发者需要面对的问题。今天我们来介绍一个常用的 npm 包 zd-once 的使用教程。

    3 年前
  • npm 包 @litstack/service-starter 使用教程

    简介 @litstack/service-starter 是一款基于 NestJS 开发的,用于快速启动 Node.js 服务的脚手架工具,提供了一些常用的功能模块,例如请求日志记录、参数验证、异常处...

    3 年前
  • npm 包 excelservice 使用教程

    1. 简介 在前端开发中,经常需要对 Excel 文件进行操作,例如读取数据、导出数据等等。而 npm 包 excelservice 提供了便捷的 API,使得我们能够轻松地处理 Excel 文件。

    3 年前
  • npm 包 react-app-rewire-coffeescript-upgraded 使用教程

    在前端开发中,JavaScript 是最常用的语言之一。但是,对于一些开发者来说,他们可能更喜欢使用 CoffeeScript 这一语言来编写代码。在 React 开发中,react-app-rewi...

    3 年前
  • npm 包 react-native-vivekkiran-background-geolocation 使用教程

    React Native 是最近几年来备受瞩目的前端开发框架,它在前端开发方面带来了巨大的变革。而 react-native-vivekkiran-background-geolocation 是一个...

    3 年前
  • npm 包 require_all 使用教程

    在前端开发中,经常需要使用许多不同的 npm 包来提高开发效率和减少重复性工作。其中,常常用到 require_all 这个包来自动加载指定目录下的所有 js 文件并导出为一个对象。

    3 年前
  • npm 包 got-swag-delete 使用教程

    在前端开发过程中,我们经常需要访问和操作网络数据。这时,我们会使用一些 HTTP 请求库。其中,got 是一个功能强大的 HTTP 请求库,可以简单易用地实现各种网络请求。

    3 年前
  • npm 包 react-chat-window-more 使用教程

    前言 随着 Web 应用的发展,聊天室已经逐渐成为了 Web 应用中常见的功能之一。在构建聊天室时,我们通常需要使用一些 UI 库和工具来帮助我们快速搭建和展示聊天窗口。

    3 年前
  • npm 包 rf24js 使用教程

    简介 npm 是 node.js 的包管理工具,可以在其中找到各种类库和包,方便我们进行开发。而 rf24js 这个 npm 包是用于对 RF24 模块进行操作的类库。

    3 年前
  • npm 包 blocklancer.git 使用教程

    在前端的开发过程中,我们经常会用到别人已经写好的代码库,这时候就要依赖于 npm 包管理器。在这篇文章中,我们将介绍一个实用的 npm 包 blocklancer.git,它具有深度和学习意义,并包含...

    3 年前
  • npm 包 formatter-plus-plus 使用教程

    在前端开发中,代码格式化是一个非常重要的环节,良好的代码格式能够提高代码的可读性、可维护性,从而提高代码质量。而 npm 包 formatter-plus-plus 就是一款强大的前端代码格式化工具,...

    3 年前
  • npm 包 react-simple-drag-n-drop 使用教程

    简介 react-simple-drag-n-drop 是一个 React 组件,可以很方便地实现拖拽和放置的功能。它提供了简单的 API,可以支持不同类型的对象和容器之间的拖拽和放置操作。

    3 年前
  • npm 包 homebridge-powerview 使用教程

    前言 在智能家居领域中,智能窗帘无疑是居家生活的重要组成部分。而 Powerview Hub 便是 Hunter Douglas 推出的智能窗帘控制中枢,通过它我们可以轻松实现对窗帘的智能控制,本教程...

    3 年前
  • npm包 `mofron-comp-msgdlg` 使用教程

    什么是 mofron-comp-msgdlg? mofron-comp-msgdlg是一个基于mofron,一个JavaScript的前端框架,所创建出的一个对话框组件。

    3 年前
  • npm 包 xokit-test 使用教程

    简介 xokit-test 是一个基于 Node.js 平台的测试框架,它可以帮助前端开发者更简便、高效地进行单元测试。它不仅提供了一套完整且易于使用的测试工具集,而且还支持插件机制,开发者可以根据自...

    3 年前
  • npm 包 server-st 使用教程

    在前端开发中,我们往往需要开启一个本地的服务器来运行我们的应用程序。在 Node.js 中,我们可以使用 http 模块来创建一个服务器,但是这样做比较麻烦,还需要处理一些复杂的问题,比如路由、静态文...

    3 年前
  • npm 包 @oovui/react 使用教程

    在前端开发中,我们经常会使用各种开源工具和库来帮助我们实现更加高效和优秀的开发。而在这些工具和库中,npm 可以说是一个必不可少的工具。 Npm 是 Node.js 的包管理工具,不仅能够管理 Nod...

    3 年前

相关推荐

    暂无文章