# swearguard-vx

> Este projeto é um filtro de palavrões que verifica se uma string contém palavras ilícitas. Ele filtra entre 265 palavrões usando o módulo @2toad/profanity para auxiliar. O projeto suporta tanto Português Brasileiro (pt-br) quanto Inglês (english).

Latest version **1.0.1** (published 2024-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install swearguard-vx
pnpm add swearguard-vx
yarn add swearguard-vx
bun add swearguard-vx
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2024-02-02 |
| First published | 2024-02-02 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 11 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Vitor-VX |
| Maintainers | victor-vx |

## Links

- npm: https://www.npmjs.com/package/swearguard-vx
- Repository: https://github.com/Vitor-VX/SwearGuard
- Homepage: https://github.com/Vitor-VX/SwearGuard#readme
- Issues: https://github.com/Vitor-VX/SwearGuard/issues
- npm.io page: https://npm.io/package/swearguard-vx

## Dependencies (1)

- [@2toad/profanity](https://npm.io/package/@2toad/profanity.md) ^2.2.0

## Recent versions

- 1.0.1 (latest) — 2024-02-02
- 1.0.0 — 2024-02-02

## README

# SwearGuard - Filtro de Palavrões

Este projeto é um filtro de palavrões que verifica se uma string contém palavras ilícitas. Ele filtra entre 265 palavrões usando o módulo @2toad/profanity para auxiliar. O projeto suporta tanto Português Brasileiro (pt-br) quanto Inglês (english).

## Como funciona

O filtro verifica a string fornecida e retorna `true` se a string contém algum palavrão e `false` caso contrário.

## Exemplos de uso

Aqui estão alguns exemplos de como usar este projeto:

```javascript
// Exemplo em Português Brasileiro
const isWordIlicitaPtBr_01 = checkWordIlicita('Essa é uma string com B.o.c.e.t.a.');
console.log(isWordIlicitaPtBr_01);  // true

const isWordIlicitaPtBr_02 = checkWordIlicita('Essa é uma string com Anus');
console.log(isWordIlicitaPtBr_02);  // true

// Exemplo em Inglês
const isWordIlicitaEn = checkWordIlicita('This is a string with.', 'english');
console.log(isWordIlicitaEn);  // true
```

## Observation
-The complete documentation in English is available in the docs/english folder.

---
_Source: https://npm.io/package/swearguard-vx · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._