npm 包 nm-sensitive-words 使用教程

在前端开发中，敏感词汇的过滤是必不可少的一项技术。npm 上有许多关于敏感词汇过滤的包，其中一个比较不错的包就是 nm-sensitive-words。本文将为大家详细介绍 nm-sensitive-words 的使用方法。

安装

安装 nm-sensitive-words 非常简单，只需在终端中输入以下命令即可：

npm install nm-sensitive-words --save

使用方法

使用 nm-sensitive-words 首先需要先引入包：

const SensitiveWords = require('nm-sensitive-words');

基本用法

const sw = new SensitiveWords(['敏感词1', '敏感词2', '敏感词3']);
const result = sw.replace('这是一条包含敏感词1的测试文本');
console.log(result); // 这是一条包含***的测试文本

屏蔽符号自定义

const sw = new SensitiveWords(['敏感词1', '敏感词2', '敏感词3'], '$');
const result = sw.replace('这是一条包含敏感词1的测试文本');
console.log(result); // 这是一条包含$$$的测试文本

忽略大小写

const sw = new SensitiveWords(['敏感词1', '敏感词2', '敏感词3'], '*', true);
const result = sw.replace('这是一条包含敏感词1的测试文本');
console.log(result); // 这是一条包含***的测试文本

过滤器自定义

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

使用指南

使用 nm-sensitive-words 时，需要考虑以下几个方面：

1. 过滤方式：nm-sensitive-words 默认使用 *** 作为屏蔽符号，也可以自定义屏蔽符号或者自定义过滤器函数。
2. 性能考量：若文本量过大，推荐在前端外部或者后端进行过滤，以确保前端性能。
3. 丰富性：nm-sensitive-words 除了支持基本的敏感词汇过滤外，还支持敏感词汇列表自定义和大小写忽略。

总结

nm-sensitive-words 是一个易用且功能较为齐全的敏感词汇过滤 npm 包，提供了多种过滤方式，能够满足大部分前端敏感词汇过滤的需求。在实际使用时，需要结合具体场景进行调整，以确保过滤效果和性能的平衡。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005576c81e8991b448d469a