Giter Club home page Giter Club logo

engcfraposo / nestjs-viacep Goto Github PK

View Code? Open in Web Editor NEW
1.0 2.0 0.0 86 KB

Este módulo fornece uma solução de consulta de endereços através do ViaCep. Ele permite que os usuários pesquisem endereços com base em informações como CEP, UF, cidade, logradouro, etc. Além disso, o módulo oferece uma interface fácil de usar e retorna resultados precisos e atualizados.

Home Page: https://www.npmjs.com/package/nest-via-cep

JavaScript 21.52% TypeScript 78.48%
nestjs viacep

nestjs-viacep's Introduction

Módulo de consulta de endereço via CEP

Este módulo permite realizar consultas de endereço através do CEP, utilizando a API do viaCep.

Instalação

Para instalar este módulo, basta executar o seguinte comando:

npm install nestjs-viacep

Uso

Para usar o ViaCepService precisamos importar o seguinte modulo

import { ViaCepService } from 'nest-via-cep';

importe o decorator Injectable do @nestjs/common:

import { Injectable } from '@nestjs/common';

e use o @Injectable() decorator no seu controller:

@Injectable()
export class MyController {
  constructor(private readonly viaCepService: ViaCepService) {}

  async consultar(cep: string) {
    return this.viaCepService.consultar(cep);
  }
}

você pode testaer o código importando da seguinte forma:

@Injectable()
const cep = await this.consultar('50721000');
console.log(cep);

Testes

Para executar os testes deste módulo, basta executar o seguinte comando:

npm run test

Licença

Este módulo está disponível sob a licença MIT. Veja o arquivo LICENSE para mais informações.

Contribuição

Sinta-se livre para contribuir com melhorias no código e na documentação. Para isso, basta abrir uma issue ou fazer um pull request.

nestjs-viacep's People

Contributors

engcfraposo avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.