Brazilian Validator JS

A lightweight and efficient JavaScript library for validating Brazilian documents and phone numbers.

🇧🇷 Features

• CPF Validation: Validate Brazilian individual taxpayer registry (CPF)
• CNPJ Validation: Validate Brazilian company taxpayer registry (CNPJ)
• Phone Validation: Validate Brazilian phone numbers (mobile and landline)
• Zero Dependencies: Lightweight library with no external dependencies
• TypeScript Support: Full TypeScript support with type definitions
• Browser & Node.js: Works in both browser and Node.js environments

📦 Installation

1# Using npm
2npm install @studiovisual/brazilian-validator-js
3
4# Using yarn
5yarn add @studiovisual/brazilian-validator-js
6
7# Using pnpm
8pnpm add @studiovisual/brazilian-validator-js

🚀 Usage

CommonJS

1const { isValidCPF, isValidCNPJ, isValidPhone } = require('@studiovisual/brazilian-validator-js');
2
3// CPF validation
4console.log(isValidCPF('123.456.789-09')); // true or false
5console.log(isValidCPF(12345678909)); // accepts with or without formatting
6
7// CNPJ validation
8console.log(isValidCNPJ('11.222.333/0001-81')); // true or false
9console.log(isValidCNPJ(11222333000181)); // accepts with or without formatting
10
11// Phone validation
12console.log(isValidPhone('(11) 99999-9999')); // mobile
13console.log(isValidPhone('(11) 3333-4444')); // landline
14console.log(isValidPhone(1133334444)); // accepts with or without formatting

ES Modules

1import { isValidCPF, isValidCNPJ, isValidPhone } from '@studiovisual/brazilian-validator-js';
2
3// CPF validation
4const cpfIsValid = isValidCPF('123.456.789-09');
5console.log(cpfIsValid); // true or false
6
7// CNPJ validation
8const cnpjIsValid = isValidCNPJ('11.222.333/0001-81');
9console.log(cnpjIsValid); // true or false
10
11// Phone validation
12const phoneIsValid = isValidPhone('(11) 99999-9999');
13console.log(phoneIsValid); // true or false

TypeScript

1import { isValidCPF, isValidCNPJ, isValidPhone } from '@studiovisual/brazilian-validator-js';
2
3const cpf: string = '123.456.789-09';
4const isValid: boolean = isValidCPF(cpf);
5console.log(isValid); // true or false

📖 API Reference

isValidCPF(value: string | number): boolean

Validates a Brazilian CPF (Cadastro de Pessoa Física).

Parameters:

• value (string | number): The CPF to validate (with or without formatting)

Returns: boolean - true if valid, false otherwise

Examples:

1isValidCPF('123.456.789-09'); // formatted
2isValidCPF(12345678909); // unformatted
3isValidCPF('000.000.000-00'); // false (invalid sequence)

isValidCNPJ(value: string | number): boolean

Validates a Brazilian CNPJ (Cadastro Nacional da Pessoa Jurídica).

Parameters:

• value (string | number): The CNPJ to validate (with or without formatting)

Returns: boolean - true if valid, false otherwise

Examples:

1isValidCNPJ('11.222.333/0001-81'); // formatted
2isValidCNPJ(11222333000181); // unformatted
3isValidCNPJ('00.000.000/0000-00'); // false (invalid sequence)

isValidPhone(value: string | number): boolean

Validates Brazilian phone numbers (mobile and landline).

Parameters:

• value (string | number): The phone number to validate (with or without formatting)

Returns: boolean - true if valid, false otherwise

Examples:

1isValidPhone('(11) 99999-9999'); // mobile with area code
2isValidPhone(11999999999); // mobile without formatting
3isValidPhone('(11) 3333-4444'); // landline
4isValidPhone('1133334444'); // landline without formatting

🌐 Browser Support

This library works in all modern browsers that support ES5+:

• Chrome 23+
• Firefox 21+
• Safari 6+
• IE 9+
• Edge (all versions)

📋 Requirements

• Node.js 10.0.0 or higher (for Node.js usage)
• No external dependencies

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 Development

1# Clone the repository
2git clone https://github.com/studiovisual/brazilian-validator-js.git
3
4# Install dependencies
5npm install
6
7# Run tests
8npm test
9
10# Build the project
11npm run build
12
13# Run linting
14npm run lint

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

• Brazilian government specifications for document validation algorithms
• Community contributions and feedback

📞 Support

If you have any questions or need help, please:

1. Check the Issues page
2. Create a new issue if your question hasn't been answered
3. Contact the maintainers

---

Made with ❤️ for the Brazilian developer community