popcorn-cep

library to abstract the zip code API from Brazil

Usage no npm install needed!

<script type="module">
  import popcornCep from 'https://cdn.skypack.dev/popcorn-cep';
</script>

README

popcorn-cep

Installation

$ npm install popcorn-cep --save

How to use

ES6

// to import a specific method
import { location } from 'popcorn-cep';
// using  method
location({ cep: '12345-150' });

Methods

Follow the methods that the library provides.

location({ cep, query })

Method that fetches information for a street through zip code or searches for information about a street through the State, City and part of the street name.

Arguments

Argument Type
cep string
query object

Example

const data = local({ cep: '12345-150' });
const data = local({ query: { uf: 'MG', city: 'Belo Horizonte': street: 'pampulha' } });

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

Denner Rondinely
Denner Rondinely

See also the list of contributors who participated in this project.

License

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