Registry / productivity / cpf-cnpj-formatter

cpf-cnpj-formatter

library1.0.6jsnpmunverified

A utility for formatting Brazilian CPF and CNPJ document numbers. Version 1.0.6 is the latest stable release. It automatically detects the document type based on input length (≤11 digits for CPF, >11 for CNPJ) and applies the standard formatting masks (XXX.XXX.XXX-XX for CPF, XX.XXX.XXX/XXXX-XX for CNPJ). The package removes non-numeric characters and limits input size. It includes TypeScript type definitions and has optional peer dependencies for React Hook Form integration. Unlike validation-focused libraries, it purely handles formatting without validation of check digits.

productivity

npm install cpf-cnpj-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · CPF-CNPJ-FORMATTER

cpf-cnpj-formatter

productivityjavascriptv1.0.6

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

formatCPFCNPJ (default)

✓ import formatCPFCNPJ from 'cpf-cnpj-formatter'

✗ const formatCPFCNPJ = require('cpf-cnpj-formatter')

ESM default import; CommonJS require also works but not recommended for TypeScript.

formatCPFCNPJ (named, type import)

✓ import { formatCPFCNPJ } from 'cpf-cnpj-formatter'

✗ import { formatCPFCNPJ } from 'cpf-cnpj-formatter'

Named import is also supported, as the package exports both default and named exports. Use type imports for TypeScript types if needed.

formatCPFCNPJ (CommonJS)

✓ const formatCPFCNPJ = require('cpf-cnpj-formatter')

✗ const { default: formatCPFCNPJ } = require('cpf-cnpj-formatter')

CommonJS require works fine; destructuring default is unnecessary.

formatCPFCNPJ (type import)

✓ import type { formatCPFCNPJ } from 'cpf-cnpj-formatter'

For TypeScript type-only imports.

Shows formatting CPF (11 digits) and CNPJ (14 digits) with automatic detection and partial formatting.

import formatCPFCNPJ from 'cpf-cnpj-formatter'; const cpfInput = '12345678901'; const cnpjInput = '12345678901234'; console.log(formatCPFCNPJ(cpfInput)); // '123.456.789-01' console.log(formatCPFCNPJ(cnpjInput)); // '12.345.678/9012-34' const shortCpf = '123456789'; console.log(formatCPFCNPJ(shortCpf)); // '123.456.789' const longCnpj = '123456789012'; console.log(formatCPFCNPJ(longCnpj)); // '12.345.678/9012'

Debug

Known issues

gotchaFormatting does not validate check digits; it only applies the mask based on length.

fix

Use a separate validation library (e.g., @brazilian-utils/cpf) for full document validation.

affects: >=1.0.0

gotchaInput is limited to 11 (CPF) or 14 (CNPJ) digits; longer inputs are silently truncated.

fix

Always sanitize input to only digits before formatting to avoid unexpected truncation.

affects: >=1.0.0

gotchaNon-numeric characters are removed but not validated; spaces or letters in input may cause unexpected results.

fix

Strip all non-digit characters using .replace(/\D/g, '') before calling the formatter.

affects: >=1.0.0

gotchaThe package has no built-in validation for empty or null input; may throw if input is not a string.

fix

Ensure input is a non-null string before calling formatCPFCNPJ.

affects: >=1.0.0

Errors

Common errors & fixes

TypeError: formatCPFCNPJ is not a function

Using require with default import incorrectly.

fix

Use: const formatCPFCNPJ = require('cpf-cnpj-formatter'); (no .default)

Uncaught TypeError: Cannot read properties of undefined (reading 'replace')

Passing a non-string value (e.g., number) to formatCPFCNPJ.

fix

Convert to string: formatCPFCNPJ(String(input))

Cannot find module 'cpf-cnpj-formatter'

Package not installed.

fix

Run: npm install cpf-cnpj-formatter

Upgrade

Version history

1.0.6latest on npm

Audit

Dependencies

reactoptionalOptional peer dependency for React examples

react-hook-formoptionalOptional peer dependency for integration example

Agent activity

36 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/betiol/cpf-cnpj-formatter ↗

packagecpf-cnpj-formatter ↗

homepagehttps://github.com/betiol/cpf-cnpj-formatter#readme ↗