ExEssentials.BrazilianDocument (ExEssentials v0.7.0)

Convenience module for validating, formatting, and masking Brazilian CPF and CNPJ documents.

This module delegates functionality to the appropriate modules:

- `ExEssentials.BrazilianDocument.Validator` for validation
- `ExEssentials.BrazilianDocument.Formatter` for formatting and masking

Use this module when you want a simplified interface for handling CPF and CNPJ without needing to reference specific modules.

## Examples

  iex> ExEssentials.BrazilianDocument.valid?("09340933001")
  true

  iex> ExEssentials.BrazilianDocument.cnpj_valid?("09281987000134")
  true

  iex> ExEssentials.BrazilianDocument.format("76713868045")
  "767.138.680-45"

  iex> ExEssentials.BrazilianDocument.cnpj_format("87671632000165")
  "87.671.632/0001-65"

  iex> ExEssentials.BrazilianDocument.mask("44286185060")
  "***.861.850-**"

  iex> ExEssentials.BrazilianDocument.mask("63219659000153")
  "63.***.***/0001-5*"

Summary

Functions

cnpj_format(cnpj)

See ExEssentials.BrazilianDocument.Formatter.cnpj_format/1.

cnpj_mask(cnpj)

See ExEssentials.BrazilianDocument.Formatter.cnpj_mask/1.

cnpj_valid?(cnpj)

See ExEssentials.BrazilianDocument.Validator.cnpj_valid?/1.

cpf_format(cpf)

See ExEssentials.BrazilianDocument.Formatter.cpf_format/1.

cpf_mask(cpf)

See ExEssentials.BrazilianDocument.Formatter.cpf_mask/1.

cpf_valid?(cpf)

See ExEssentials.BrazilianDocument.Validator.cpf_valid?/1.

format(document)

See ExEssentials.BrazilianDocument.Formatter.format/1.

mask(document)

See ExEssentials.BrazilianDocument.Formatter.mask/1.

valid?(document)

See ExEssentials.BrazilianDocument.Validator.valid?/1.