@spec check_digits(String.t()) :: String.t()

Calculates the two numeric check digits for a 9-digit CPF base.

Examples

iex> BrDocs.CPF.check_digits("123456789")
"09"

@spec format(String.t()) :: {:ok, formatted()} | {:error, :invalid_format}

Formats a CPF using the XXX.XXX.XXX-XX mask.

The input may be provided with or without punctuation.

Examples

iex> BrDocs.CPF.format("12345678909")
{:ok, "123.456.789-09"}

iex> BrDocs.CPF.format("123")
{:error, :invalid_format}

@spec format!(String.t()) :: formatted()

Formats a CPF, raising ArgumentError when the input is invalid.

Examples

iex> BrDocs.CPF.format!("12345678909")
"123.456.789-09"

@spec unformat(String.t()) :: {:ok, normalized()} | {:error, :invalid_format}

Removes punctuation from a CPF.

Examples

iex> BrDocs.CPF.unformat("123.456.789-09")
{:ok, "12345678909"}

@spec unformat!(String.t()) :: normalized()

Removes punctuation from a CPF, raising on invalid input.

Examples

iex> BrDocs.CPF.unformat!("123.456.789-09")
"12345678909"

@spec valid?(term()) :: boolean()

Returns true when the CPF format and check digits are valid.

Examples

iex> BrDocs.CPF.valid?("123.456.789-09")
true

iex> BrDocs.CPF.valid?("123.456.789-00")
false

iex> BrDocs.CPF.valid?("111.111.111-11")
false

@spec valid_format?(term()) :: boolean()

Returns true when the CPF has a supported shape.

This checks length and allowed characters, but does not calculate check digits. Use valid?/1 for full validation.

Examples

iex> BrDocs.CPF.valid_format?("123.456.789-09")
true

iex> BrDocs.CPF.valid_format?("1234567890A")
false