Brazilian ZipCode Validator

Need some validation using Brazilian ZipCodes? I can help you with that!

Getting Started

You can install the package via npm or yarn

npm install brzipcode

yarn add brzipcode

Usage

There are some methods you can use:

• ZipCodesFromGivenState
• StateFromZipCode
• isZipCodeInState
• GenerateRandomZipCode
• GetAddressFromZipCode

Examples

ZipCodesFromGivenState returns an object as it follows:

state: Name of state

range: Array of ZipCodes with Start and Finish (Some brazilians states has 2 arrays)

import {ZipCodesFromGivenState} from 'brzipcodes'

const data = ZipCodesFromGivenState('SP')

console.log(data)

output

{
  state: 'São Paulo',
  range: [ { start: '11000-000', finish: '19999-999' } ]
}

StateFromZipCode returns an string with the state abbreviation of given ZipCode:

Work with numbers only

import {StateFromZipCode} from 'brzipcodes'

const data = StateFromZipCode(11320130)

console.log(data)

output

SP

isZipCodeInState a boolean that uses the two methods above to determinated either a ZipCode belongs to a State or not

import {isZipCodeInState} from 'brzipcodes'

const data = isZipCodeInState(11320130, 'RJ')

console.log(data)

output

false

GenerateRandomZipCode a helper that generates a random ZipCode from a given state

import {GenerateRandomZipCode} from 'brzipcodes'

const zipCode = GenerateRandomZipCode('SP')

console.log(zipCode)

output

11320130

GetAddressFromZipCode returns an object as it follows. (Note that this is a async function...remember to use async/await. Otherwise you will received invalid return)

zipCode: Formated Zip Code

address: Complete address from given Zip Code

complement: Complement from address

district: District from address

city: City from address

state: State from address

ibge: Ibge code from given Zip Code

gia: GIA code from given Zip Code

import {GetAddressFromZipCode} from 'brzipcodes'

const response = await GetAddressFromZipCode(01001000)

console.log(response)

output

{
  zipCode: '01001-000',
  address: 'Praça da Sé',
  complement: 'lado ímpar',
  district: 'Sé',
  city: 'São Paulo',
  state: 'SP',
  ibge: '3550308',
  gia: '1004'
}

Authors

• Thiago Vasconcellos - Initial work - brzipcode

License

This project is licensed under the MIT License - see the LICENSE.md file for details