Class CPF

Brazil CPF Number (Tax ID for individuals) Format: XXX.XXX.XXX-XX

Implements

IdNumberClass

Index

Constructors

Properties

Accessors

Methods

checksum parse validate parse validate

Constructors

constructor

new CPF(): CPF

Returns CPF

Properties

`Static` `Readonly`METADATA

METADATA: IdMetadata = ...

Accessors

METADATA

get METADATA(): IdMetadata
Metadata for this ID type

Returns IdMetadata
Implementation of IdNumberClass.METADATA
- Defined in countries/bra/cpf.ts:44

Methods

checksum

checksum(idNumber: string): number | null
Calculate checksum (if applicable)
Parameters
- idNumber: string
Returns number | null
Implementation of IdNumberClass.checksum
- Defined in countries/bra/cpf.ts:129

parse

parse(idNumber: string): CPFParseResult | null
Parse ID number (if applicable)
Parameters
- idNumber: string
Returns CPFParseResult | null
Implementation of IdNumberClass.parse
- Defined in countries/bra/cpf.ts:125

validate

validate(idNumber: string): boolean
Validate an ID number
Parameters
- idNumber: string
Returns boolean
Implementation of IdNumberClass.validate
- Defined in countries/bra/cpf.ts:111

`Static`parse

parse(idNumber: string): CPFParseResult | null
Parse CPF (returns basic validation info)
Parameters
- idNumber: string
Returns CPFParseResult | null
- Defined in countries/bra/cpf.ts:118

`Static`validate

validate(idNumber: string): boolean
Validate Brazil CPF Number
Parameters
- idNumber: string
Returns boolean
- Defined in countries/bra/cpf.ts:99