Utils library for Brazilian-specific businesses.

📖 Documentation

Table of Contents

• Getting Started
• Installation
• Usage
• Contributors
• 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:

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

with yarn package manager:

yarn add @brazilian-utils/brazilian-utils

or <script> tag (global brazilianUtils):

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

Usage

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

import { isValidCpf } from "@brazilian-utils/brazilian-utils";

isValidCpf("1232454233345"); // false

You can check a list of utilities by clicking here.

Development

This repository uses Vite+ as the local toolchain.

Requirements:

• Node.js ^20.19.0 || >=22.12.0
• vp installed and available in your shell

Common commands:

vp install
vp check
vp test
vp run build

Release notes are published through GitHub Releases.

Contributors

Our "thank you" goes to these wonderful people (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