# Doc BR Validator 📝✅

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![npm version](https://img.shields.io/npm/v/doc-br-validator)](https://www.npmjs.com/package/doc-br-validator)
[![Tests](https://github.com/seu-usuario/doc-br-validator/actions/workflows/tests.yml/badge.svg)](https://github.com/seu-usuario/doc-br-validator/actions)

Biblioteca TypeScript para validação e geração de documentos brasileiros (CPF, CNPJ e mais).

## 📦 Instalação

```bash
npm install doc-br-validator
# ou
yarn add doc-br-validator
```

---

## Como Usar

##### Validação de CPF
``` javascript
import { validarCPF, formatarCPF, gerarCPF } from 'doc-br-validator';

// Validação
validarCPF('529.982.247-25'); // true
validarCPF('111.111.111-11'); // false

// Formatação
formatarCPF('52998224725'); // '529.982.247-25'

// Geração
gerarCPF(); // '123.456.789-09' (aleatório)
```

##### Validação de CNPJ
``` javascript
import { validarCNPJ, formatarCNPJ, gerarCNPJ } from 'doc-br-validator';

// Validação
validarCNPJ('33.381.121/0001-05'); // true
validarCNPJ('11.111.111/1111-11'); // false

// Formatação
formatarCNPJ('33381121000105'); // '33.381.121/0001-05'

// Geração
gerarCNPJ(); // '12.345.678/0001-95' (aleatório)
```

---

## API Completa

## CPF

| Função      | Parâmetros       | Retorno  | Descrição                                   |
|-------------|------------------|----------|---------------------------------------------|
| validarCPF  | cpf: string      | boolean  | Valida um CPF com ou sem máscara            |
| formatarCPF | cpf: string      | string   | Formata no padrão `xxx.xxx.xxx-xx`          |
| gerarCPF    | -                | string   | Gera um CPF válido aleatório                |

## CNPJ

| Função       | Parâmetros       | Retorno  | Descrição                                   |
|--------------|------------------|----------|---------------------------------------------|
| validarCNPJ  | cnpj: string     | boolean  | Valida um CNPJ com ou sem máscara           |
| formatarCNPJ | cnpj: string     | string   | Formata no padrão `xx.xxx.xxx/xxxx-xx`      |
| gerarCNPJ    | -                | string   | Gera um CNPJ válido aleatório               |
---
## Licença

MIT - Veja o arquivo [LICENSE](./LICENSE.md) para detalhes.