npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cepaberto

v1.0.0

Published

The JavaScript SDK for CEP Aberto open database API

Downloads

19

Readme

CEP Aberto JavaScript SDK

Build Status Coverage Status

This is the JavaScript SDK for the CEP Aberto API to search for addresses and zipcodes directly from your JS application.

CEP Aberto is an Open Database Project that provides a free of charge zipcode database and a simple API that allows you to fetch the information on-the-fly.

Installation

$ npm install --save cepaberto

Usage

Importing the library to your code:

const CEPAberto = require('cepaberto')

let cepaberto = new CEPAberto()

Find address by zipcode

cepaberto.findByCode('30180-000')
         .then((address) => console.log(address))
         .catch((err) => console.error(err))

If the address was not found, the address variable will be a boolean false.

Find address by coordinates

cepaberto.findByCoordinates('-40.9182391','-12.0918236')
         .then((address) => console.log(address))
         .catch((err) => console.error(err))

Find zipcode by address

cepaberto.findByAddress('MG', 'Belo Horizonte', 'Centro', 'Av. Amazonas')
         .then((address) => console.log(address))
         .catch((err) => console.error(err))

Only the state and city parameters are mandatory because some zipcodes represents an entire city.

Find cities

cepaberto.findCities('MG')
         .then((cities) => console.log(cities))
         .catch((err) => console.error(err))

Tests

$ npm test

License

This library is licensed under the MIT license.