Redirected from 
README
¶
BR Doc
CPF, CNPJ, CEP, CNH, PIS/PASEP, RENAVAM, CNS and license plate validator for Go!
Everything in this file, but the License section, is in portuguese.
Descrição
BR Doc é um pacote para validação, tanto do formato quanto dos dígitos, de documentos brasileiros, como CPF, CNPJ, CEP, CNH, PIS/PASEP, RENAVAM, placa veicular e RG no padrão SP e RJ (futuramente demais padrões).
Aceito PRs de todas as formas. Está permitido escrever em português, também. :)
Uso
Principais funções:
func IsCPF(doc string) boolfunc IsCNPJ(doc string) boolfunc IsCEP(doc string, ufs ...FederativeUnit) boolfunc IsCNH(doc string) boolfunc IsPIS(doc string) boolfunc IsRENAVAM(doc string) boolfunc IsPlate(doc string) boolfunc IsNationalPlate(doc string) boolfunc IsMercosulPlate(doc string) boolfunc IsCNS(doc string) boolfunc IsRG(doc string) bool
Coisas a fazer
- validação de CPF
- validação de CNPJ
- validação de CEP
- validação de CNH (obrigado @eminetto!)
- validação de RENAVAM (obrigado @leogregianin!)
- validação de placa veicular
- validação de CNS (obrigado @renatosuero!)
- validação de RG
- SP (obrigado @robas!)
- RJ (obrigado @robas!)
- demais estados
License
This project code is in the public domain. See the LICENSE file.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you shall be in the public domain, without any additional terms or conditions.
Documentation
¶
Index ¶
- Variables
- func IsCEP(doc string, ufs ...FederativeUnit) bool
- func IsCNH(doc string) bool
- func IsCNPJ(doc string) bool
- func IsCNS(doc string) bool
- func IsCPF(doc string) bool
- func IsMercosulPlate(doc string) bool
- func IsNationalPlate(doc string) bool
- func IsPIS(doc string) bool
- func IsPlate(doc string) bool
- func IsRENAVAM(doc string) bool
- func IsRG(doc string, uf FederativeUnit) (isValid bool, err error)
- type FederativeUnit
Constants ¶
This section is empty.
Variables ¶
var ( CPFRegexp = regexp.MustCompile(`^\d{3}\.?\d{3}\.?\d{3}-?\d{2}$`) CNPJRegexp = regexp.MustCompile(`^\d{2}\.?\d{3}\.?\d{3}\/?(:?\d{3}[1-9]|\d{2}[1-9]\d|\d[1-9]\d{2}|[1-9]\d{3})-?\d{2}$`) )
Regexp pattern for CPF and CNPJ.
var ( NationalPlateRegexp = regexp.MustCompile(`^[A-Z]{3}-?\d{4}$`) MercosulPlateRegexp = regexp.MustCompile(`^[A-Z]{3}\d[A-Z]\d{2}$`) )
Regexp pattern for license plates patterns.
var (
CEPRegexp = regexp.MustCompile(`^\d{5}-?\d{3}$`)
)
Regexp pattern for CEP.
var (
CNSRegexp = regexp.MustCompile(`^([12]\d{2}\s?\d{4}\s?\d{4}\s?00[01]\d|[789]\d{2}\s?\d{4}\s?\d{4}\s?\d{4})$`)
)
Regexp pattern for CNS.
var (
PISRegexp = regexp.MustCompile(`^\d{3}\.?\d{3,5}\.?\d{2,4}-?\d$`)
)
Regexp pattern for PIS.
Functions ¶
func IsCEP ¶
func IsCEP(doc string, ufs ...FederativeUnit) bool
IsCEP verifies if `doc` is a valid CEP. `ufs` represents the possible Federative Units the CEP should matches. If none is provided, it validates the document for any state/district.
func IsMercosulPlate ¶
IsMercosulPlate verifies if the given string is a valid license plate in the new Mercosul format.
func IsNationalPlate ¶
IsNationalPlate verifies if the given string is a valid license plate in the old national format.
func IsPlate ¶
IsPlate verifies if the given string is a valid license plate.IsPlate It can be either in the old national format or the new Mercosul one.
Types ¶
type FederativeUnit ¶
type FederativeUnit uint8
FederativeUnit represents a state or a district in Brazil.
const ( AC FederativeUnit = iota AL AP AM BA CE DF ES GO MA MT MS MG PA PB PR PE PI RJ RN RS RO RR SC SP SE TO )
Federative unit for CEP validation.
Source Files