cidades-promise's Introduction

Cidades Promise

Busca por cidades utilizando a sigla do Estado ou DDD, integrado diretamente aos serviços do INEP e outras API.

Features

Interface Assíncrona.
Atualizado em tempo-real por se conectar diretamente aos serviços do INEP.
Sempre retorna a resposta rápida.
Possui alta disponibilidade.
Sem limites de uso (rate limits) conhecidos.
Suporte ao Node.js

Como utilizar

Realizando uma consulta

Basta utilizar a sigla do estado como parâmetro, por exemplo o estado da Paraíba:

const cidades = require('cidades-promise');

cidades.getCitiesByState("pb").then((res) => {
    console.log(res);
})
    
// [
//   'AGUA BRANCA',
//   'AGUIAR',
//   'ALAGOA GRANDE',
//   'ALAGOA NOVA',
//    ... more items
// ]

Usando async:

const cidades = require('cidades-promise');

async function getCidades(){
    const response = await cidades.getCitiesByState("pb");
    console.log(response);
}
    
// [
//   'AGUA BRANCA',
//   'AGUIAR',
//   'ALAGOA GRANDE',
//   'ALAGOA NOVA',
//    ... more items
// ]

Quando a Sigla do Estado possui um formato inválido

const cidades = require('cidades-promise');

cidades.getCitiesByState("pbkj").then((res) => {
    console.log(res);
})
    
// {"erro":"Sigla do estado estar incorreta"}

Quando a Sigla do Estado não é encontrada

const cidades = require('cidades-promise');

cidades.getCitiesByState("gg").then((res) => {
    console.log(res);
})
    
// {"erro": "Erro ao buscar cidades"}

Busca Cidades por DDD

const cidades = require('cidades-promise');

cidades.getCitiesByDdd(83).then((res) => {
    console.log(res);
})
    
// {
//   estado: 'PB',
//   cidades: [
//     'Água Branca',
//     'Aguiar',
//     'Alagoa Grande',
//    ... more items
//    ]
// }

Instalação

npm

$ npm install --save cidades-promise

Autor

_@juniorpb

cidades-promise's People

Contributors

Stargazers

Watchers

cidades-promise's Issues

Erro na função getCitiesByState

O erro acontece porque o código não sabe se houve erro no service state, pelo axios ou se o estado digitado realmente não existe.

Estou trabalhando na resolução, minha ideia foi de criar um arquivo armazenando a sigla de cada estado. Dessa forma, o código vai saber se o estado realmente não existe ou se houve erro no axios.

Dúvida na utilização do try/catch

Opa, beleza Junior? Então cara, encontrei seu repo pelo repo da BrasilAPI, e vi que vocês estão usando essa lib. Aí dando uma olhada no código me surgiu uma pequena dúvida.

Lá nas funções do controller, vc fazia a verificação se a UF e o DDD eram apenas 2 valores, ótimo, beleza. E logo depois, vc criou as funções que faziam o get dentro de um try/catch, qual a diferença de usar elas dentro e fora de um?

Ou sei lá, tipo, vai ver por ser uma biblioteca para outras pessoas usarem aí tem que ter o trycatch... bom, não sei, por isso estou te perguntando haha.

Trabalho como programador há uns 5 meses, e reparei que se fosse eu, com base no meu humilde conhecimento - hahaha - teria feito sem o trycatch, daí surgiu a minha dúvida.

Espero que possa me responder, abraço!

[SUGESTÃO] Fonte alternativa de dados

@juniorpb, parabéns pelo trabalho e por ter agregado ele ao BrasilAPI.

Caso queira adicionar uma API alternativa de consulta, o IBGE tem endpoints públicos de cidade e municípios.

Tenho os três endpoints documentados no Postman caso queira dar uma olhadinha. Segue link: https://documenter.getpostman.com/view/38670/RWgwQb95

Recommend Projects

juniorpb / cidades-promise Goto Github PK