brdocs

v0.2.0

brdocs v0.2.0 BrDocs.CPF View Source

Generation, validation and formatting for Brazilian CPF.

In Brazil, the CPF is an unique 11 numbers length which identifies an individual (like SSN, in USA).

Link to this section Summary

Functions

format(value)

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

generate(opts \\ [formatted: false])

Used mostly for testing, yet you can generate a valid CPF. Returns a BrDocs.BrDoc

validate(value)

Validates a CPF value against CPF validation rules. Returns a boolean

Link to this section Functions

Link to this function

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

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

Delegates the formatting to BrDocs.CPF.Formatter.format/1.

Link to this function

generate(opts \\ [formatted: false]) View Source 
generate(keyword()) :: BrDocs.BrDoc.t()

Used mostly for testing, yet you can generate a valid CPF. Returns a BrDocs.BrDoc.

Delegates the generation to BrDocs.CPF.Generator.generate/1.

Link to this function

validate(value) View Source 
validate(String.t() | BrDocs.BrDoc.t()) :: BrDocs.BrDoc.t()

Validates a CPF value against CPF validation rules. Returns a boolean.

Delegates the validation to BrDocs.CPF.Validator.validate/1.