Validações de forma fácil ✅
Leia isso em outras línguas: English
Visão geral
Validations BR é um cinto de ferramentas de funções para validar documentos padrões no Brasil e mais.
Instalação
Com npm:
npm install validations-brCom yarn:
yarn add validations-brComo usar
useValidationsBR
Parâmetros
| Chave | Tipo | Descrição |
|---|---|---|
| type | cnpj | cpf | cep | email | pis | phone | uf |
Tipo de dados que serão validados |
| value | string |
Valor que será validado |
import { useValidationsBR } from 'validations-br';
// const { useValidationsBR } = require('validations-br');
const cnpj = '09.015.844/0001-80';
const isValid = useValidationsBR('cnpj', cnpj);Validar CNPJ
import { validateCNPJ } from 'validations-br';
// const { validateCNPJ } = require('validations-br');
const cnpj = '09.015.844/0001-80';
const isValid = validateCNPJ(cnpj);Validar CPF
import { validateCPF } from 'validations-br';
// const { validateCPF } = require('validations-br');
const cpf = '370.785.180-04';
const isValid = validateCPF(cpf);Validar Inscrição Estadual
import { validateIE } from 'validations-br';
// const { validateIE } = require('validations-br');
const ie = '535.371.880.779';
const isValid = validateIE(ie, 'sp');Validar PIS/PASEP
import { validatePIS } from 'validations-br';
// const { validatePIS } = require('validations-br');
const pis = '833.28281.34-7';
const isValid = validatePIS(pis);Validar CNH
import { validateCNH } from 'validations-br';
// const { validateCNH } = require('validations-br');
const cnh = '134621966-24';
const isValid = validateCNH(cnh);Validar Telefone
import { validatePhone } from 'validations-br';
// const { validatePhone } = require('validations-br');
const phone = '(14) 99767-9472';
const isValid = validatePhone(phone);Validar CEP
import { validateCEP } from 'validations-br';
// const { validateCEP } = require('validations-br');
const cep = '17280-000';
const isValid = validateCEP(cep);Validar UF
import { validateUF } from 'validations-br';
// const { validateUF } = require('validations-br');
const uf = 'SP';
const isValid = validateUF(uf);Bônus
Validar E-mail
import { validateEmail } from 'validations-br';
// const { validateEmail } = require('validations-br');
const email = 'johndoe@gmail.com';
const isValid = validateEmail(email);Integrações
Com Yup
import { validateCNPJ } from "validations-br";
import * as Yup from "yup";
try {
const schema = Yup.string().test(
"is-cnpj",
"CNPJ is not valid",
(value) => validateCNPJ(value)
);
await schema.validate(cnpj);
} catch(err) {
console.log(err.message);
}Com Joi
import { validateCNPJ } from "validations-br";
import Joi from "joi";
try {
const schema = Joi.string().custom(validateCNPJ, "Validate CNPJ");
const { value } = schema.validate(cnpj);
if (!value) {
throw Error("CNPJ is not valid");
}
} catch(err) {
console.log(err.message);
}Como contribuir
Fique a vontade para contribuir com o projeto. Nós só pedimos para que:
- Dê fork (https://github.com/reactivando/validations-br/fork)
- Crie sua branch da feature/fix (git checkout -b feature/fooBar)
- Escreva os testes para a nova feature ou do bug fix resolvido
- Faça o commit das mudanças (git commit -am 'feat: add some fooBar')
- Siga os padrões de commit conventional-changelog descritos em conventional-conventions
- Dê push dá branch para seu repositório (git push origin feature/fooBar)
- Tenha certeza que os testes passaram antes de abrir a pull-request (Use:
$ yarn testor$ npm run test) - Crie uma nova Pull Request
Autores
Licença
MIT © Reactivando