CEP Promise

Busca por CEP integrado diretamente aos serviços dos Correios, ViaCEP e outros (Node.js e Browser)

Features

* Sempre atualizado em tempo-real por se conectar diretamente aos serviços dos Correios, ViaCEP e outros.
* Possui alta disponibilidade por usar vários serviços como fallback.
* Sempre retorna a resposta mais rápida por fazer as consultas de forma concorrente.
* Sem limites de uso (rate limits) conhecidos.
* Interface de Promise extremamente simples.
* Suporte ao Node.js 4.x, 5.x, 6.x, 7.x, 8.x, 9.x e @stable.
* Suportou ao Node.js 0.10.x e 0.12.x até cep-promise versão 2.0.8.
* 100% de code coverage com testes unitários e E2E.
* Desenvolvido utilizando ES6.

Como utilizar

$3

Por ser multifornecedor, a biblioteca irá resolver a Promise com o fornecedor que mais rápido lhe responder.

`` js
import cep from 'cep-promise'

cep('05010000')
.then(console.log)

// {
// "cep": "05010000",
// "state": "SP",
// "city": "São Paulo",
// "street": "Rua Caiubí",
// "neighborhood": "Perdizes",
// }
`

$3

Em muitos sistemas o CEP é utilizado erroneamente como um Inteiro (e com isto cortando todos os zeros à esquerda). Caso este seja o seu caso, não há problema, pois a biblioteca irá preencher os caracteres faltantes na String, por exemplo:

` js
import cep from 'cep-promise'

// enviando sem ter um zero à esquerda do CEP "05010000"
cep(5010000)
.then(console.log)

// {
// "cep": "05010000",
// "state": "SP",
// "city": "São Paulo",
// "street": "Rua Caiubí",
// "neighborhood": "Perdizes",
// }
`

$3

Neste caso será retornado um "service_error" e por ser multifornecedor, a biblioteca irá rejeitar a Promise apenas quando tiver a resposta negativa de todos os fornecedores.

` js
import cep from 'cep-promise'

cep('99999999')
.catch(console.log)

// {
// name: 'CepPromiseError',
// message: 'Todos os serviços de CEP retornaram erro.',
// type: 'service_error',
// errors: [{
// message: 'CEP NAO ENCONTRADO',
// service: 'correios'
// }, {
// message: 'CEP não encontrado na base do ViaCEP.',
// service: 'viacep'
// }, {
// message: 'CEP não encontrado na base do Cep Aberto.',
// service: 'cepaberto'
// }]
// }

`

$3

Neste caso será retornado um "validation_error" e a biblioteca irá rejeitar imediatamente a Promise, sem chegar a consultar nenhum fornecedor.

` js
import cep from 'cep-promise'

cep('123456789123456789')
.catch(console.log)

// {
// name: 'CepPromiseError',
// message: 'CEP deve conter exatamente 8 caracteres.',
// type: 'validation_error',
// errors: [{
// message: 'CEP informado possui mais do que 8 caracteres.',
// service: 'cep_validation'
// }]
// }
`

$3

#### Browser usando CDN
`

`

#### npm

`
$ npm install --save cep-as-promised
`


#### Webpack
É possível configurar o webpack.config.js trocando caminho do cep-promise para usar o caminho correto da forma abaixo e com isto o import cep from 'cep-as-promised' deverá funcionar como o esperado:

`
const path = require('path')
// ...

resolve: {
alias: {
"cep-promise": path.join(__dirname, 'node_modules', 'cep-promise', 'dist', 'cep-promise-browser.min.js')
}
}
`

#### Angular 2

` ts
import * as cep from 'cep-as-promised'

cep('05010000')
.then(console.log)
``

Como contribuir

Leia nosso guia de contribuição aqui

Contribuidores

|
_@lucianopf |
_@MarcoWorms |
_{@caio-ribeiro-pereira} |
_{@chrisbenseler} |
_@luanmuniz |
_{@AlbertoTrindade} |
|:-:|:-:|:-:|:-:|:-:|:-:|
|
_@pedrro |
_@petronetto |
_@olegon |
_{@jhonnymoreira} |
_{@claytonsilva} |
_@thiamsantos

Autor

|
_{@filipedeschamps} |
| :---: |