Go library

Install

go get github.com/brazilian-utils/go

Go implements 136 of the 182 contract functions and 35% of the core functions. 2081 shared cases pass and 579 fail. 2 functions have a signature that does not match the contract. 2 public functions are not in the contract.

Compared with the other libraries

What to do next

The list starts with failing functions, then wrong signatures, then missing core functions, then the rest. In each group, functions implemented by more libraries come first, since there is more code to port from. Each item is also an issue in the library's repository.

Failing cases

Functions without a usage example

These functions work, but the library's usage files have no example for them. Their tab on this site is empty.

• Area code (DDD): Decode areaCode.getInfo
• Area code (DDD): List by state areaCode.listByState
• Banks: Get by code bank.getByCode
• Banks: Get by ispb bank.getByIspb
• Banks: List bank.list
• Bank account: Validate bankAccount.isValid
• Boleto: Format boleto.format
• Boleto: Generate boleto.generate
• Boleto: Decode boleto.getInfo
• Boleto: Parse boleto.parse
• CAEPF: Format caepf.format
• CAEPF: Validate caepf.isValid
• CAEPF: Parse caepf.parse
• CBO: Look up cbo.get
• CBO: Validate cbo.isValid
• CBO: Parse cbo.parse
• CEI: Format cei.format
• CEI: Validate cei.isValid
• CEI: Parse cei.parse
• CEP: Get address info cep.getAddressInfo
• CEP: Get info by address cep.getInfoByAddress
• CEP: Parse cep.parse
• Civil registry certificate: Format certidao.format
• Civil registry certificate: Decode certidao.getInfo
• Civil registry certificate: Validate certidao.isValid
• Civil registry certificate: Parse certidao.parse
• CFOP: Look up cfop.get
• CFOP: Validate cfop.isValid
• CFOP: Parse cfop.parse
• CNAE: Format cnae.format
• CNAE: Look up cnae.get
• CNAE: Validate cnae.isValid
• CNAE: Parse cnae.parse
• Driver's license (CNH): Format cnh.format
• Driver's license (CNH): Generate cnh.generate
• Driver's license (CNH): Parse cnh.parse
• CNO: Format cno.format
• CNO: Validate cno.isValid
• CNO: Parse cno.parse
• CNPJ: Generate cnpj.generate
• CNPJ: Parse cnpj.parse
• CNS (SUS card): Format cns.format
• CNS (SUS card): Validate cns.isValid
• CNS (SUS card): Parse cns.parse
• CPF: Parse cpf.parse
• Payment card: Validate creditCard.isValid
• CSOSN: Validate csosn.isValid
• CST: Validate cst.isValid
• Currency (BRL): Write out in words currency.convertToWords
• Currency (BRL): Format currency.format
• Currency (BRL): Parse currency.parse
• Dates and holidays: Difference in business days date.differenceInBusinessDays
• Dates and holidays: Get holidays date.getHolidays
• Dates and holidays: Is business day date.isBusinessDay
• Dates and holidays: Is holiday date.isHoliday
• IBAN: Format iban.format
• IBAN: Decode iban.getInfo
• IBAN: Validate iban.isValid
• IBAN: Parse iban.parse
• State registration (IE): Validate ie.isValid
• Legal nature: Format legalNature.format
• Legal nature: Generate legalNature.generate
• Legal nature: Look up legalNature.get
• Legal nature: List legalNature.list
• Legal nature: List by category legalNature.listByCategory
• Legal nature: Parse legalNature.parse
• Court case number: Generate legalProcess.generate
• Court case number: Parse legalProcess.parse
• License plate: Generate licensePlate.generate
• License plate: Validate licensePlate.isValid
• License plate: Parse licensePlate.parse
• Municipalities: Get by code municipality.getByCode
• Municipalities: List municipality.list
• NCM: Format ncm.format
• NCM: Validate ncm.isValid
• NCM: Parse ncm.parse
• NF-e access key: Format nfeKey.format
• NF-e access key: Decode nfeKey.getInfo
• NF-e access key: Validate nfeKey.isValid
• NF-e access key: Parse nfeKey.parse
• Numbers in words: Write out in words number.convertToWords
• Passport: Format passport.format
• Passport: Generate passport.generate
• Passport: Validate passport.isValid
• Passport: Parse passport.parse
• Phone: Generate phone.generate
• Phone: Validate phone.isValid
• Phone: Is valid landline phone.isValidLandline
• Phone: Is valid mobile phone.isValidMobile
• Phone: Is valid service phone.isValidService
• Phone: Parse phone.parse
• PIS/PASEP: Parse pis.parse
• Pix key: Decode pixKey.getInfo
• Pix key: Validate pixKey.isValid
• Pix payload (BR Code): Generate pixPayload.generate
• Pix payload (BR Code): Decode pixPayload.getInfo
• Pix payload (BR Code): Validate pixPayload.isValid
• Professional registration: Validate registroProfissional.isValid
• RENAVAM: Generate renavam.generate
• States (UF): Get by ibge code state.getByIbgeCode
• States (UF): Get code by name state.getCodeByName
• States (UF): Get name by code state.getNameByCode
• States (UF): Get timezone state.getTimezone
• States (UF): List state.list
• Text: Capitalize text.capitalize
• Text: Remove accents text.removeAccents
• VIN (chassis): Validate vin.isValid
• Voter ID: Parse voterId.parse

Public functions outside the contract

No contract function describes these public functions. For each one, bind it to a contract function, propose it for the contract, or mark it as internal in the library's configuration.

• bank.IsValidCode
• legalnature.ListByCategoryNumber

Badge for your README

The badge shows the share of core functions and the cases that pass, and changes with every run. Paste this Markdown in the library's README:

[![API contract](https://brazilian-utils.com.br/badges/go.svg)](https://brazilian-utils.com.br/libs/go/)