在前端开发中，我们经常需要对数据进行分类或者筛选，而使用有意义的词语来进行分类是非常有助于理解和后续处理的。relevant-animals 就是一个非常有趣且有意义的 NPM 包，它会根据给定的字符串，返回一组相关的动物名字。
在本文中，我们将介绍如何安装和使用 relevant-animals 包。
安装
在 npm 环境中，我们可以使用以下命令安装 relevant-animals 包：
npm install relevant-animals
用法
在安装好包之后，我们可以在 Node.js 模块中引用它并使用它。以下是一个简单的示例程序：
var relevantAnimals = require('relevant-animals');
var animals = relevantAnimals('bird');
console.log(animals);输出结果：
-- -------------------- ---- ------- - ---------- ------- ------- -------- --------- ----------- ------- ---------- -------------- --------- ------ --------- ---------- ---------- ----------- -------- -------- -------- ---------- ------- --------- ------------ -
这个例子中，我们给 relevant-animals 函数传入字符串 "bird"，它会返回 21 个相关的动物。这个例子看起来非常简单，但是如果我们需要分类或者筛选大量数据时，自动返回相关词汇的能力是非常有用的。
API
除了上面的例子外，relevant-animals 还提供了其他一些有用的 API。
relevantAnimals(string, options)
string: 需要查找相关词汇的字符串，必填参数。options: 可选参数对象，属性如下：blacklist: 需要排除的词汇，其值为数组。默认值为[]。
该函数将返回一个有序数组，包含相关的动物名字。如果没有找到相关词汇，则返回长度为零的数组。
以下是 options 对象的示例：
{
blacklist: ['dolphin', 'whale', 'shark']
}这个示例中，因为 {blacklist: ['dolphin', 'whale', 'shark']} 指定了黑名单，所以这些动物名字不会出现在相关词汇的列表中。
示例
以下是一些使用示例，展示了 relevant-animals 包的使用场景。
1. 将数据分组
我们使用 relevant-animals 包来将一堆字符串分组到不同的相关词汇中。
-- -------------------- ---- -------
----- --------------- - ----------------------------
----- ---- - ------- ------ ------- ------- -------- --------
----- ------ - ---
--- ------ --- -- ----- -
----- ------- - ---------------------
--- ------ ------ -- -------- -
-- ----------------- -
-------------- - ---
-
-------------------------
-
-
--------------------输出结果：
-- -------------------- ---- ------- - ---- -------- ---- -------- ----- --------- ----- --------- ------ ---------- ----- --------- -------- --------- -------- -------- -------- -------- -------- -------- -------- -------- ------- -------- -------- ------- -
在这个例子中，我们将一个字符串数组传递给 relevant-animals 包，将数据分成了不同的相关动物组。
2. 单词游戏
我们可以使用相关动物单词来设计一个单词游戏。在那个游戏中，玩家需要给出一个动物，并且其他玩家需要说出与该动物相关的其他动物。以下是示例程序：
const relevantAnimals = require('relevant-animals');
const animal = "lion";
const animals = relevantAnimals(animal, {blacklist: [animal]});
console.log(`与 ${animal} 相关的动物：${animals.join(', ')}.`);输出结果：
与 lion 相关的动物：tiger, puma, cheetah, leopard, panther, jaguar.
在这个例子中，我们将 "lion" 作为输入字符串传递给 relevant-animals。除了 "lion" 本身之外，我们将 "lion" 添加到黑名单中。游戏玩家需要避免提到 "lion" 并快速说出与 "lion" 相关联的其他动物。
总结
通过本文，我们了解了如何安装和使用 relevant-animals 包。我们介绍了其简单的 API，并且给出了一些使用案例。相关的动物组很有趣且实用，使用 relevant-animals 包能使我们更快更有效地对数据进行分类和筛选。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005589d81e8991b448d5e1a