🇧🇷 BR Docs · Validação e formatação de documentos brasileiros

Utilitários simples e modulares para validação, formatação e parsing de documentos brasileiros.

✅ Feito em TypeScript
✅ Modular ✅ Open Source com testes

📦 Instalação

npm install br-docs

## Importação

```typescript
import { Cpf, Cnpj } from "br-docs";

Uso

CPF

import { Cpf } from "br-docs";

Cpf.isValid("123.456.789-09"); // true

Cpf.format("12345678909"); // '123.456.789-09'

Cpf.parse("123.456.789-09"); // '12345678909'

Telefone/Celular

import { Phone } from "br-docs";

Phone.isValid("(11) 99999-9999"); // true

Phone.format("11999999999"); // '(11) 99999-9999'

Phone.parse("(11) 99999-9999"); // '11999999999'

CEP

import { Cep } from "br-docs";

Cep.isValid("01234-567"); // true

Cep.format("01234567"); // '01234-567'

Cep.parse("01234-567"); // '01234567'

CNPJ

import { Cnpj } from "br-docs";

Cnpj.isValid("11.222.333/0001-81"); // true

Cnpj.format("11222333000181"); // '11.222.333/0001-81'

Cnpj.parse("11.222.333/0001-81"); // '11222333000181'

Email

import { Email } from "br-docs";

Email.isValid("[email protected]"); // true/false

PIX

import { Pix } from "br-docs";

Pix.isValid("123.456.789-09"); // true
Pix.isValid("[email protected]"); // true
Pix.isValid("(11) 99999-9999"); // true
Pix.isValid("12.345.678/0001-95"); //true

UUID

import { Uuid } from "br-docs";

Uuid.isValid("550e8400-e29b-41d4-a716-446655440000"); // true/false

CNH

import { Cnh } from "br-docs";

Cnh.isValid("12345678901"); // true

Interface Genérica

Todos os módulos implementam a interface IGeneric<T>:

export interface IValidator<T> {
  isValid(input: T): boolean;
}

export interface IFormatter<T> {
  format(input: T): string;
}

export interface IParser<T> {
  parse(input: T): string;
}

export interface IDocumentHandler<T>
  extends IValidator<T>,
    IFormatter<T>,
    IParser<T> {}

📚 Documentação Completa

Clique aqui para acessar a documentação completa

Contribuindo

1. Faça um fork do projeto
2. Crie uma branch para sua feature (git checkout -b feature/nova-feature)
3. Faça commit das suas alterações (git commit -m 'Add nova feature')
4. Faça push para a branch (git push origin feature/nova-feature)
5. Abra um Pull Request

Licença

ISC