brdocs

v0.2.0

brdocs v0.2.0 BrDocs.CPF.Formatter View Source

CPF Formatter.

Link to this section Summary

Functions

format(value)

Formats a BrDocs.BrDoc CPF value into CPF format. Returns a formatted BrDocs.BrDoc

Link to this section Functions

Link to this function

format(value) View Source 
format(BrDocs.BrDoc.t()) :: BrDocs.BrDoc.t()
format(String.t()) :: BrDocs.BrDoc.t()

Formats a BrDocs.BrDoc CPF value into CPF format. Returns a formatted BrDocs.BrDoc.

CPF value length should be 11 characters. Otherwise, returns a BrDocs.BrDoc with the raw and unformatted value.

This function accepts either a string containing the CPF value or a BrDocs.BrDoc.

Examples 

  iex> BrDocs.CPF.Formatter.format("")
  %BrDocs.BrDoc{kind: :cpf, value: ""}

  iex> BrDocs.CPF.Formatter.format(nil)
  %BrDocs.BrDoc{kind: :cpf, value: nil}

  iex> BrDocs.CPF.Formatter.format("123")
  %BrDocs.BrDoc{kind: :cpf, value: "123"}

  iex> BrDocs.CPF.Formatter.format("11144477735")
  %BrDocs.BrDoc{kind: :cpf, value: "111.444.777-35"}

  iex> BrDocs.CPF.Formatter.format("111.444.777-35")
  %BrDocs.BrDoc{kind: :cpf, value: "111.444.777-35"}

  iex> BrDocs.CPF.Formatter.format(%BrDocs.BrDoc{kind: :cpf, value: ""})
  %BrDocs.BrDoc{kind: :cpf, value: ""}

  iex> BrDocs.CPF.Formatter.format(%BrDocs.BrDoc{kind: :cpf, value: nil})
  %BrDocs.BrDoc{kind: :cpf, value: ""}

  iex> BrDocs.CPF.Formatter.format(%BrDocs.BrDoc{kind: :cpf, value: "123"})
  %BrDocs.BrDoc{kind: :cpf, value: "123"}

  iex> BrDocs.CPF.Formatter.format(%BrDocs.BrDoc{kind: :cpf, value: "11144477735"})
  %BrDocs.BrDoc{kind: :cpf, value: "111.444.777-35"}

  iex> BrDocs.CPF.Formatter.format(%BrDocs.BrDoc{kind: :cpf, value: "111.444.777-35"})
  %BrDocs.BrDoc{kind: :cpf, value: "111.444.777-35"}