BrasilAPI / cep-promise

Busca por CEP integrado diretamente aos serviços dos Correios, ViaCEP e outros (Node.js e Browser)
MIT License
2.89k stars 316 forks source link

feat(index.d.ts): flexible `AvailableProviders` and minimal documentation #262

Closed wellwelwel closed 1 year ago

wellwelwel commented 1 year ago

1. Descrições mininalistas nas declarações de tipos:

Com uma descrição objetiva e minimalista em cada tipo e propriedades declaradas, o código se torna totalmente intuitivo dentro do próprio editor uma vez que você pode ler o que cada opção é ou faz em tempo real enquanto cria seu próprio código 🧙🏻


2. Tornando a opção providers flexível para usuários TypeScript:

Essa é uma alternativa para o PR #261, porém sem mudanças críticas (breaking changes) e unindo o melhor do que já existe com a solução proposta pelo @arturdonda.

Por quê?

Com esse PR, agora é possível utilizar a opção providers de ambas as formas:

import cep, { AvailableProviders } from 'cep-promise';

cep('05010000', {
  providers: [AvailableProviders.correios],
});

cep('05010000', {
  providers: ['correios', 'viacep'],
});

cep('05010000', {
  providers: [AvailableProviders.correios, 'viacep'],
});

3. CI

Não era minha intenção alterar nada além do index.d.ts, porém notei que uma das mensagens esperadas pelo serviço correios-alt mudou, falhando no teste do CEP 99999999. Apenas atualizei essa mensagem no teste 🙋🏻‍♂️


Qualquer dúvida ou sugestão, podem chamar 🚀

wellwelwel commented 1 year ago

Apenas exemplificando de forma visual 🧙🏻

Screenshot 2023-08-27 at 21 28 19
wellwelwel commented 1 year ago

Ficou muito bom!!!

Valeu, @LorhanSohaky 🌞✨


@wellwelwel , como você validou quais providers funcionam na web e quais não?

Eu confirmei essa questão pelo retorno do método getAvailableServices:

https://github.com/BrasilAPI/cep-promise/blob/887608fcdb9e0546fb4f7f05a00a54e4f05b772a/src/services/index.js#L10-L24