Utils library for Brazilian-specific businesses.
[π Documentation](https://brazilian-utils.com.br/#/getting-started)
[](https://github.com/brazilian-utils/javascript/actions/workflows/build.yml?query=branch%3Amain) [](https://codecov.io/gh/brazilian-utils/javascript?branch=main) [](https://snyk.io/test/github/brazilian-utils/javascript?targetFile=package.json) [](https://codeclimate.com/github/brazilian-utils/javascript/maintainability)
[](https://www.npmjs.com/package/@brazilian-utils/brazilian-utils) [](LICENSE)
**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 `
```
## 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).
## 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:
```bash
vp install
vp check
vp test
vp run build
```
Release notes are published through [GitHub Releases](https://github.com/brazilian-utils/javascript/releases).
## Contributors
Our "thank you" goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
