@betafcc/cpf

Micro-utilitário para validação e geração de CPFs

Install

npm i @betafcc/cpf

Usage

import { Cpf } from '@betafcc/cpf'

ou

const { Cpf } = require('@betafcc/cpf')

static from(cpf: string, uf?: Uf): Cpf

Gera um objeto Cpf

Possíveis assinaturas:

Cpf.from('453.178.287-91') // Completo e pontuado
Cpf.from('45317828791') // Completo e não pontuado
Cpf.from('453.178.287') // Sem os dígitos verificadores
Cpf.from('453.178.28', 'RJ') // Específicando a UF pela sigla

---

static isValid(cpf: unknown): boolean

Retorna true se o argumento é uma string com um cpf válido

Com pontuação:

Cpf.isValid('453.178.287-91') // true

Sem pontuação:

Cpf.isValid('45317828791') // true

Dígito verificador inválido:

Cpf.isValid('45317828792') // false

---

static random(uf?: Uf): Cpf

Gera um Cpf aleatório

Cpf.random() // Cpf { __cpf: '453.178.287-91' }
Cpf.random('RJ') // Cpf { __cpf: '453.178.287-91' }

---

format(): CpfString

Cpf.from('45317828791').format() // '453.178.287-91'

---

strip(): CpfString

Cpf.from('453.178.287-91').strip() // '45317828791'

---

equals(other: Cpf): boolean

---

possibleUfs(): Set<Uf>

Retorna as possíveis UFs de origem

see https://janio.sarmento.org/curiosidade-identificacao-de-cpf-conforme-o-estado/

Cpf.from('453.178.287-91').possibleUfs() // Set {"RJ", "ES"}

---