Easy validations ✅

Read this in other languages: Portuguese

Overview

Validations BR is a function tool belt for validating standard documents in Brazil and more.

Installation

With npm:

1npm install validations-br

With yarn:

1yarn add validations-br

Usage

useValidationsBR

Parâmetros

Key	Type	Description
type	cnpj | cpf | cep | email | pis | phone | uf	Type of data to be validated
value	string	Value that will be validated

1import { useValidationsBR } from 'validations-br';
2// const { useValidationsBR } = require('validations-br');
3
4const cnpj = '09.015.844/0001-80';
5const isValid = useValidationsBR('cnpj', cnpj);

Validate CNPJ

1import { validateCNPJ } from 'validations-br';
2// const { validateCNPJ } = require('validations-br');
3
4const cnpj = '09.015.844/0001-80';
5const isValid = validateCNPJ(cnpj);

Validate CPF

1import { validateCPF } from 'validations-br';
2// const { validateCPF } = require('validations-br');
3
4const cpf = '370.785.180-04';
5const isValid = validateCPF(cpf);

Validate State Registration

1import { validateIE } from 'validations-br';
2// const { validateIE } = require('validations-br');
3
4const ie = '535.371.880.779';
5const isValid = validateIE(ie, 'sp');

Validate PIS

1import { validatePIS } from 'validations-br';
2// const { validatePIS } = require('validations-br');
3
4const pis = '833.28281.34-7';
5const isValid = validatePIS(pis);

Validate Phone

1import { validatePhone } from 'validations-br';
2// const { validatePhone } = require('validations-br');
3
4const phone = '(14) 99767-9472';
5const isValid = validatePhone(phone);

Validar CNH

1import { validateCNH } from 'validations-br';
2// const { validateCNH } = require('validations-br');
3
4const cnh = '134621966-24';
5const isValid = validateCNH(cnh);

Validate CEP

1import { validateCEP } from 'validations-br';
2// const { validateCEP } = require('validations-br');
3
4const cep = '17280-000';
5const isValid = validateCEP(cep);

Validate UF

1import { validateUF } from 'validations-br';
2// const { validateUF } = require('validations-br');
3
4const uf = 'SP';
5const isValid = validateUF(uf);

Bonus

Validate E-mail

1import { validateEmail } from 'validations-br';
2// const { validateEmail } = require('validations-br');
3
4const email = 'johndoe@gmail.com';
5const isValid = validateEmail(email);

Integrations

With Yup

1import { validateCNPJ } from "validations-br";
2import * as Yup from "yup";
3
4try {
5  const schema = Yup.string().test(
6    "is-cnpj",
7    "CNPJ is not valid",
8    (value) => validateCNPJ(value)
9  );
10  
11  await schema.validate(cnpj);
12} catch(err) {
13  console.log(err.message);
14}

With Joi

1import { validateCNPJ } from "validations-br";
2import Joi from "joi";
3
4try {
5  const schema = Joi.string().custom(validateCNPJ, "Validate CNPJ");
6
7  const { value } = schema.validate(cnpj);
8
9  if (!value) {
10    throw Error("CNPJ is not valid");
11  }
12} catch(err) {
13  console.log(err.message);
14}

Contributing

Feel free to contribute to the project. We only ask that:

• Fork it (https://github.com/reactivando/validations-br/fork)
• Create your feature branch (git checkout -b feature/fooBar)
• Write tests for the new feature or bug fix that you are solving
• Commit your changes (git commit -am 'feat: add some fooBar')
• Follow the commit conventions of conventional-changelog described in conventional-conventions
• Push to the branch (git push origin feature/fooBar)
• Ensure all tests pass before send the pull-request (Use: $ yarn test or $ npm run test)
• Create a new Pull Request

Authors

• André Zagatti @azagatti

• Ariel Franco @arielff3

License

MIT © Reactivando