@brunoc/ngx-viacep

Uma biblioteca Angular para busca de CEP e endereços pelo serviço [ViaCep](https://viacep.com.br/). Utiliza o Módulo HttpClientModule, portanto, é recomendado seu uso a partir da verão 4.3 do Angular.

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
253May 27, 2021Jan 11, 2018Minified + gzip package size for @brunoc/ngx-viacep in KB

Readme

Ngx-Viacep!

Uma biblioteca Angular para busca de CEP e endereços pelo serviço ViaCep. Utiliza o Módulo HttpClientModule, portanto, é recomendado seu uso a partir da verão 4.3 do Angular.

npm-publish npm (scoped) npm NPM GitHub Repo stars

Instalação

Via npm:

npm install @brunoc/ngx-viacep --save

Via yarn:

yarn add @brunoc/ngx-viacep

Instruções

No módulo onde for necessário buscar CEP, importar NgxViacepModule e adicionar aos imports, como no exemplo abaixo:

import { BrowserModule } from "@angular/platform-browser";
import { NgModule } from "@angular/core";

import { NgxViacepModule } from "@brunoc/ngx-viacep"; // Importando o módulo

import { AppComponent } from "./app.component";

@NgModule({
  declarations: [AppComponent],
  imports: [
    BrowserModule,
    NgxViacepModule, // Registrando o módulo
  ],
  bootstrap: [AppComponent],
})
export class AppModule {}

No componente onde a funcionalidade for necessária, importar o serviço NgxViacepService e injetá-lo:

import { Component } from "@angular/core";
import { OnInit } from "@angular/core/";

import { NgxViacepService } from "@brunoc/ngx-viacep"; // Importando o serviço

@Component({
  selector: "app-root",
  templateUrl: "./app.component.html",
  styleUrls: ["./app.component.css"],
})
export class AppComponent implements OnInit {
  title = "app";
  constructor(private viacep: NgxViacepService) {} // Injetando o serviço

  ngOnInit() {}
}

Buscar endereço por cep

O serviço NgxViacepService possui um método para a busca de endereço por CEP, que retorna um Observable, seu uso pode ser visto abaixo:

this.viacep
  .buscarPorCep("01001000")
  .pipe(
    catchError((error: CEPError) => {
      // Ocorreu algum erro :/
      console.log(error.message);
      return EMPTY;
    })
  )
  .subscribe((endereco: Endereco) => {
    // Endereço retornado :)
    console.log(endereco);
  });

As interfaces Endereco, CEPError e o enum CEPErrorCode podem ser importadas da mesma maneira que o serviço, como no exemplo:

import {
  NgxViacepService,
  Endereco,
  CEPError,
  CEPErrorCode,
} from "@brunoc/ngx-viacep";

Busca sem CEP

Para buscar um endereço cujo cep não é conhecido, pode-se utilizar o método a seguir:

this.viacep
  .buscarPorEndereco("rs", "porto alegre", "domingos")
  .pipe(
    catchError((error: CEPError) => {
      // Ocorreu algum erro :/
      console.log(error.message);
      return EMPTY;
    })
  )
  .subscribe((enderecos: Endereco[]) => {
    // Array de endereços possíveis retornados :D
    console.log(enderecos);
  });

O método buscarPorEndereco faz uma pesquisa e retorna uma lista de endereços no estado e cidade definidos, cujo logradouro possua no nome o valor passado no terceiro argumento.

Tratamento de erros

O Serviço NgxViacepService utiliza a classe CEPError para o lançamento de todas as exceções relacionadas à busca de CEP ou Endereço.

A classe CEPError possui o método getCode.

O enum CEPErrorCode que contém os códigos correspondentes a todos os erros lançados pelo serviço NgxViacepService.

Abaixo encontra-se o código do enum:

export enum CEPErrorCode {
  CEP_NAO_ENCONTRADO,
  CEP_VAZIO,
  CEP_INVALIDO,
  CEP_MUITO_CURTO,
  CEP_MUITO_LONGO,
  UF_VAZIA,
  UF_MUITO_CURTA,
  UF_MUITO_LONGA,
  UF_NAO_EXISTE,
  MUNICIPIO_VAZIO,
  MUNICIPIO_MUITO_CURTO,
  LOGRADOURO_VAZIO,
  LOGRADOURO_MUITO_CURTO,
  ERRO_SERVIDOR,
}

É possível fazer a verificação do erro retornado como no exemplo a seguir:

switch (error.getCode()) {
  case CEPErrorCode.UF_VAZIA:
    console.log("Por favor, informe a UF :P");
    break;
  case CEPErrorCode.UF_NAO_EXISTE:
    console.log("A UF informada não existe :/");
    break;
  // Quaisquer outros erros contidos em CEPErrorCode podem ser tratados assim
}

O método ofType pode ser utilizado para tratar tipos específicos, como no exemplo a seguir:

if (error.ofType(CEPErrorCode.UF_VAZIA)) {
  console.log("Ops! Parece que vc não informou a UF ¬¬");
}

A propriedade message da classe CEPError conterá uma string com o tipo do erro:

try {
  throw new CEPError(CEPErrorCode.UF_VAZIA);
} catch (error) {
  // Logará a string "UF_VAZIA" no console
  console.log(error.message);
}

License

MIT © Bruno Carvalho

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.