# @brazilian-utils/format-cpf

> Return CPF formatted with mask.

Latest version **0.1.8** (published 2018-08-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @brazilian-utils/format-cpf
pnpm add @brazilian-utils/format-cpf
yarn add @brazilian-utils/format-cpf
bun add @brazilian-utils/format-cpf
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.8 |
| Published | 2018-08-24 |
| First published | 2018-06-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Lucas Veloso |
| Maintainers | andreoav, hyanmandian, lucassveloso |
| Keywords | cpf, brasil, brazilian, utils, mask, format, formatter |

## Links

- npm: https://www.npmjs.com/package/@brazilian-utils/format-cpf
- Repository: https://github.com/hyanmandian/brazilian-utils/tree/master/packages/format-cpf
- Issues: https://github.com/hyanmandian/brazilian-utils/issues
- npm.io page: https://npm.io/package/@brazilian-utils/format-cpf

## Dependencies (2)

- [@brazilian-utils/helper-is-last-char](https://npm.io/package/@brazilian-utils/helper-is-last-char.md) ^0.1.7
- [@brazilian-utils/helper-only-numbers](https://npm.io/package/@brazilian-utils/helper-only-numbers.md) ^0.1.5

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 0.1.8 (latest) — 2018-08-24
- 0.1.6 — 2018-07-05
- 0.1.4 — 2018-06-23
- 0.1.3 — 2018-06-23
- 0.1.2 — 2018-06-23
- 0.1.1 — 2018-06-23
- 0.1.0 — 2018-06-23

## README

# @brazilian-utils/format-cpf

Return CPF formatted with mask.

## Installation

```sh
# Yarn
yarn add @brazilian-utils/format-cpf

# npm
npm install @brazilian-utils/format-cpf --save

# UMD
<script type='text/javascript' src='https://unpkg.com/@brazilian-utils/format-cpf/dist/index.umd.js'></script>
```

## Usage

```js
import formatCpf from '@brazilian-utils/format-cpf';

formatCpf('943'); // 943
formatCpf('9438'); // 943.8
formatCpf('943895751'); // 943.895.751
formatCpf('94389575104'); // 943.895.751-04
```

---
_Source: https://npm.io/package/@brazilian-utils/format-cpf · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._