https://github.com/brazilian-utils/brazilian-utils

Utils library for specific Brazilian businesses
https://github.com/brazilian-utils/brazilian-utils

boleto boleto-bancario brazilian cep cnpj cpf email estados format formatter generator gerador inscricao-estadual mask phone pis processo-juridico states validador validator

Last synced: 3 months ago
JSON representation

Utils library for specific Brazilian businesses

• Host: GitHub
• URL: https://github.com/brazilian-utils/brazilian-utils
• Owner: brazilian-utils
• License: mit
• Created: 2018-06-08T17:52:41.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2024-09-16T20:48:01.000Z (5 months ago)
• Last Synced: 2024-10-15T01:32:29.494Z (4 months ago)
• Topics: boleto, boleto-bancario, brazilian, cep, cnpj, cpf, email, estados, format, formatter, generator, gerador, inscricao-estadual, mask, phone, pis, processo-juridico, states, validador, validator
• Language: TypeScript
• Homepage: https://brazilian-utils.com.br
• Size: 4.12 MB
• Stars: 1,537
• Watchers: 30
• Forks: 107
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-made-by-brazilians - brazilian-utils

README

        



🇧🇷 Brazilian Utils


Utils library for Brazilian-specific businesses.


[📖 Documentation](https://brazilian-utils.com.br/#/getting-started)

[![Build Status](https://github.com/brazilian-utils/brazilian-utils/workflows/build/badge.svg?branch=main)](https://github.com/brazilian-utils/brazilian-utils/actions?query=workflow%3Abuild) [![Coverage Status](https://codecov.io/gh/brazilian-utils/brazilian-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/brazilian-utils/brazilian-utils) [![Known Vulnerabilities](https://snyk.io/test/github/brazilian-utils/brazilian-utils/badge.svg?targetFile=package.json)](https://snyk.io/test/github/brazilian-utils/brazilian-utils?targetFile=package.json) [![Maintainability](https://api.codeclimate.com/v1/badges/05d3cd8492ed438bf51d/maintainability)](https://codeclimate.com/github/hyanmandian/brazilian-utils/maintainability)

[![Downloads per month](https://img.shields.io/npm/dm/@brazilian-utils/brazilian-utils.svg)](https://www.npmjs.com/package/@brazilian-utils/brazilian-utils) [![License: MIT](https://img.shields.io/github/license/hyanmandian/brazilian-utils.svg)](LICENSE)



---

> ## Vidas Negras Importam | Black Lives Matter. ✊🏽✊🏾✊🏿

>

> To know how to help, just go to [Vidas Negras Importam](https://vidasnegrasimportam.carrd.co/) or [Black Lives Matter](https://blacklivesmatters.carrd.co/).

---

> ## We are changing

>

> After one year of Brazilian Utils and lots of feedback, we decided to refactor our library to fix issues, create a website and make it easier for other developers to contribute. If you use **v0 version**, please, check [v0](https://github.com/brazilian-utils/brazilian-utils/tree/v0) branch.

---

**Table of Contents**

- [Getting Started](#getting-started)

  - [Installation](#installation)

  - [Usage](#usage)

  - [Contributors](#contributors)

  - [License](#license)

# Getting Started

Brazilian Utils is a library focused on solving problems that we face daily in the development of applications for the Brazilian business.

## Installation

Using **Brazilian Utils** is quite simple and you can use it in some ways:

as npm package:

```bash

npm install --save @brazilian-utils/brazilian-utils

```

with yarn package manager:

```bash

yarn add @brazilian-utils/brazilian-utils

```

or `` tag (global `brazilianUtils`):

```html

<script src="https://unpkg.com/@brazilian-utils/brazilian-utils/dist/brazilian-utils.cjs.production.min.js">

```

## Usage

To use one of our utilities you just need to import the required function as in the example below:

```javascript

import { isValidCPF } from '@brazilian-utils/brazilian-utils';

isValidCPF('1232454233345'); // false

```

You can check a list of utilities [by clicking here](https://brazilian-utils.com.br/#/utilities).

## Contributors

Our "thank you" goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):

  

    
Hyan Mandian
💻 📖 🤔 ⚠️

    
Lucas Veloso
💻 📖 🤔 ⚠️

    
Andreo Vieira
💻 📖 🤔 🔧

    
Matheus Almeida
💻 📖 ⚠️

    
Fernando Rogelin
💻 📖 ⚠️

    
rodineijf
💻 📖 ⚠️

    
Emerson Laurentino
💻 📖 ⚠️

  

  

    
Leonardo Dutra
💻 📖 ⚠️

    
Victor Magalhães
💻 🔧

    
Amauri Dias
💻 🔧

    
Felipe F. Diogo
💻 ⚠️

    
Alan Raso
💻 ⚠️

    
Felipe Fetter
📖

    
Rafael Franco
💻 📖

  

  

    
Rafael Pezzetti
💻 ⚠️ 📖

    
Antonio Roberto Furlaneto
💻 📖 ⚠️

    
Felipe Nolleto Nascimento
💻 📖 ⚠️

    
Saulo Joab
📖

    
Pedro Arantes
💻 📖 ⚠️

    
Silvio Clécio
💻 📖 ⚠️

    
Lucas Nascimento
💻

  

  

    
Lincon Kusunoki
💻 📖 ⚠️

    
Marcelo Cristiano
💻 📖 ⚠️

    
Tarcísio Batista de Freitas Junior
📖

    
Lucas Carrias
📖 ⚠️ 💻 🔧

  

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!

## License

[MIT](LICENSE)