Passer au contenu principal
Passer au contenu principal

Documentation du Validateur-BR

Validez facilement les documents brésiliens. Excellent pour les tests d’assurance qualité des logiciels.

Apprenez à utiliser la bibliothèque pour valider les CPF, CNPJ, CNH, PIS et plus encore.

Installer via NPM
NPM VersionNPM Downloads

Commencer

À propos

@box4dev/validador-br

Une bibliothèque légère et robuste pour valider les documents brésiliens.

La bibliothèque vise à garantir que les documents sont conformes aux calculs mathématiques et aux chiffres de contrôle stipulés par les institutions.

Installation

Pour installer le package dans votre projet, exécutez l'une des commandes ci-dessous :

NPM

Shell
npm install @box4dev/validador-br

Yarn

Shell
yarn add @box4dev/validador-br

PNPM

Shell
pnpm add @box4dev/validador-br

Importer

Exportations nommées (recommandé)

Utilisez des fonctions nommées pour importer uniquement ce dont vous avez besoin.

JS
import { isValidCpf, isValidCnpj } from '@box4dev/validador-br';
console.log(isValidCpf('123.456.789-09')); // true ou false
console.log(isValidCnpj('GY.HU8.PG2/971E-10')); // true ou false

valider l'objet (centralisé)

Ou utilisez l'objet `validate` qui centralise tous les validateurs.

JS
import { validate } from '@box4dev/validador-br';
console.log(validate.cpf('123.456.789-09')); // true ou false
console.log(validate.cnpj('12.345.678/0001-95')); // true ou false

CommonJS (obligatoire)

JS
const { isValidCpf, isValidCnpj, validate } = require('@box4dev/validador-br');
console.log(isValidCpf('12345678909')); // true ou false
console.log(validate.cnpj('GYHU8PG2971E10')); // true ou false

Validateurs

CPF

Valide le format et les chiffres de contrôle du CPF (module 11).

JS
import { isValidCpf } from '@box4dev/validador-br';
console.log(isValidCpf('741.535.041-30')); // true ou false
console.log(isValidCpf('43241612163')); // true ou false

CNPJ / CNPJ alphanumérique

Valide les CNPJ dans l'ancienne norme (chiffres uniquement) et la nouvelle norme alphanumérique.

JS
import { isValidCnpj } from '@box4dev/validador-br';
console.log(isValidCnpj('GY.HU8.PG2/971E-10')); // true ou false
console.log(isValidCnpj('12.345.678/0001-95')); // true ou false
console.log(isValidCnpj('AYWO9JCVCHFB47')); // true ou false
console.log(isValidCnpj('47434563000151')); // true ou false

CNH

Valide le permis de conduire national à l'aide de l'algorithme officiel.

JS
import { isValidCnh } from '@box4dev/validador-br';
console.log(isValidCnh('12345678901')); // true ou false

PIS / PASEP / NIT

Valide le numéro d’identification du travailleur (PIS/PASEP/NIT).

JS
import { isValidPis } from '@box4dev/validador-br';
console.log(isValidPis('589.21704.72.2')); // true ou false
console.log(isValidPis('07987894517')); // true ou false

SNC

Valide les numéros CNS provisoires (commençant par 7, 8, 9) et définitifs (1, 2).

JS
import { isValidCns } from '@box4dev/validador-br';
console.log(isValidCns('252 9608 1932 0002')); // true ou false
console.log(isValidCns('146471200460007')); // true ou false

Carte d'électeur

Valide l'identification de l'électeur en vérifiant les chiffres et le code de l'État.

JS
import { isValidTituloEleitor } from '@box4dev/validador-br';
console.log(isValidTituloEleitor('4113 4513 0930')); // true ou false
console.log(isValidTituloEleitor('428779582410')); // true ou false

Certificat

Valide le numéro d'enregistrement à 32 chiffres des actes (Naissance, Mariage, Décès).

JS
import { isValidCertidao } from '@box4dev/validador-br';
console.log(isValidCertidao('106836 11 1926 1001 1 88626 162 6561443')); // true ou false
console.log(isValidCertidao('81007223197120011105781766173474')); // true ou false

Enregistrement d'État

Validates specific State Registrations for each state (UF). Nécessite l’abréviation de l’état.

JS
import { isValidIE } from '@box4dev/validador-br';
// valor da IE e UF
// biome-ignore lint/nursery/noDuplicateObjectKeys: false positive
console.log(isValidIE('7122026812064', 'SP')); // true ou false
console.log(isValidIE('01.004.823/001-12', 'AC')); // true ou false

Carte de crédit

Valide les cartes (Visa, Mastercard, Amex, etc.) à l'aide de l'algorithme de Luhn.

JS
import { isValidCartaoCredito } from '@box4dev/validador-br';
console.log(isValidCartaoCredito('4389 3536 3524 6297')); // true ou false
console.log(isValidCartaoCredito('4389351453183261')); // true ou false

Foire aux questions

Le package a-t-il des dépendances ?
Non, le package est sans dépendance.
La validation est-elle synchrone ?
Oui, toutes les fonctions renvoient un booléen de manière synchrone.