https://github.com/engcfraposo/nestjs-viacep

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.
https://github.com/engcfraposo/nestjs-viacep

nestjs viacep

Last synced: about 1 month ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/engcfraposo/nestjs-viacep
• Owner: engcfraposo
• Created: 2023-01-31T13:58:53.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-31T14:52:09.000Z (almost 2 years ago)
• Last Synced: 2024-10-07T11:48:30.185Z (about 1 month ago)
• Topics: nestjs, viacep
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/nest-via-cep
• Size: 84 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 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:

```ssh

npm install nestjs-viacep

```

## Uso

Para usar o ViaCepService precisamos importar o seguinte modulo

```ts

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

```

importe o decorator Injectable do @nestjs/common:

```ts

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

```

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

```ts

@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:

```ts

@Injectable()

const cep = await this.consultar('50721000');

console.log(cep);

```

# Testes

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

```ssh

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.