brdocs

v0.2.0

brdocs v0.2.0 BrDocs.CNPJ View Source

Generation, validation and formatting for Brazilian CNPJ.

In Brazil, the CNPJ is an unique 14 numbers length which identifies a company in the Receita Federal (like IRS, in USA).

Link to this section Summary

Functions

format(value)

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

generate(opts \\ [formatted: false])

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

validate(value)

Validates a CNPJ value against CNPJ 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 CNPJ value into CNPJ format. Returns a formatted BrDocs.BrDoc.

Delegates the formatting to BrDocs.CNPJ.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 CNPJ. Returns a BrDocs.BrDoc.

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

Link to this function

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

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

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