Package Exports

brzipcode

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (brzipcode) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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 four methods you can use:

ZipCodesFromGivenState
StateFromZipCode
isZipCodeInState
GenerateRandomZipCode

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

Authors

Thiago Vasconcellos - Initial work - brzipcode

License

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