@2toad/profanity 中文文档教程

Question

Profanity

一个 JavaScript 亵渎过滤器（支持 TypeScript）

Getting Started

安装包

npm i @2toad/profanity

Usage

import { profanity } from '@2toad/profanity';
// or
var profanity = require('@2toad/profanity').profanity;


profanity.exists('I like big butts and I cannot lie');
// true

profanity.exists('I like big glutes and I cannot lie');
// false

profanity.censor('I like big butts (aka arses) and I cannot lie');
// I like big @#$%&! (aka @#$%&!) and I cannot lie

Options

创建一个亵渎类的实例来更改默认选项：

import { Profanity, ProfanityOptions } from '@2toad/profanity';

const options = new ProfanityOptions();
options.wholeWord = false;
options.grawlix = '*****';

const profanity = new Profanity(options);

wholeWord

默认设置为 true，所以脏话只匹配整个单词：

profanity.exists('Arsenic is poisonous but not profane');
// false

将此设置为 false，导致部分单词匹配：

profanity.exists('Arsenic is poisonous but not profane');
// true (matched on arse)

grawlix

默认设置为 @#$%&!：

profanity.censor('I like big butts and I cannot lie');
// I like big @#$%&! and I cannot lie

将此设置为 ****，会导致：

profanity.censor('I like big butts and I cannot lie');
// I like big **** and I cannot lie

Customize the word list

添加单词：

profanity.addWords(['aardvark', 'zebra']);

删除单词：

profanity.removeWords(['butt', 'arse']);

Whitelist

白名单允许您指定脏话过滤器始终忽略的单词。

如果您想打开部分单词匹配 (wholeWord = true)，这会很有用，这样组合的单词会被捕获（例如，arseliccker），而您添加到白名单的特定单词会被忽略（例如，砷）。

添加单词到白名单：

profanity.whitelist.addWords(['arsenic', 'buttress']);

从白名单中删除单词：

profanity.whitelist.removeWords(['arsenic', 'buttress']);