@h7ml/badwords
v0.0.3
Published
[![NPM version](https://img.shields.io/npm/v/@h7ml/badwords?color=a1b858&label=)](https://www.npmjs.com/package/@h7ml/badwords) [![License](https://img.shields.io/github/license/h7ml/badwords?color=2b7489)](https://github.com/h7ml/badwords/blob/main/LICEN
Downloads
1
Readme
@h7ml/badwords
Install
npm
npm install @h7ml/badwords
yarn
yarn add @h7ml/badwords
pnpm
pnpm add @h7ml/badwords
usage
import
import {badwords, checkWord} from '@h7ml/badwords'
check
checkWord('天府广场', badwords) // true
checkWord('广场') // false
API
checkWord(text, words)
| parameter | type | default | require | description |
|-----------|-------------|------------|---------|---------------------------|
| text
| string
| _
| true
| To check the text |
| words
| string[]
| badwords
| false
| Sensitive vocabulary list |
License
MIT License © 2022 Anthony Fu