@cubos/dataset-cep

@cubos/dataset-cep

Conjunto de dados sobre CEPs no Brasil. Este pacote irá gerenciar um conjunto de tabelas no banco de dados e expor funções utilitárias para consultas.

Configurando:

Este pacote exporta migrations, um objeto com migrações do Kysely que devem ser incluídas no seu projeto.

Chame a função populate na inicialização do seu projeto, após executar migrações. Esta irá baixar os dados e inserir nas tabelas do seu banco de dados. Também irá verificar atualizações e aplicar se necessário. Considere agendar para chamar estar função ao menos uma vez por mês.

Para que populate funcione é necessário preencher a variável de ambiente CUBOS_DATASET_URL com a URL de onde os dados podem ser consultados e baixados, incluindo credenciais se necessário.

Utilizando:

Duas funções são disponibilizadas para uso:

• getAddressFromCep: recebe um CEP como argumento e retorna o endereço.
• getAddressFromLocation: recebe a latitude e longitude de um ponto no mapa e retorna o endereço mais próximo, se disponível.

O objeto de retorno de ambas as funções é o mesmo:

export interface Address {
  cep: string;
  addressLine1: string;
  addressLine2: string;
  latitude: number | null;
  longitude: number | null;
  district: string | null;
  city: string;
  state: string;
  stateId: string;
}