AvailableProviders declaration from 'enum' to 'type'

[arturdonda]

Bom dia pessoal,

Sugestão

Sugiro uma simples alteração no index.d.ts para substituir a declaração de AvailableProviders de ENUM para TYPE.

Motivo

Estava usando a API e reparei que o enum AvailableProviders estava undefined, o que causava um erro ao usar o enum para definir a lista de provedores:

TypeError: Cannot read properties of undefined (reading 'brasilapi')

A alternativa é passar os provedores como uma lista de strings. O problema é que o TS também acusa erro por entender que a string não é do tipo do enum:

É possível contornar o erro tipando o objeto de configuração ou a lista de provedores:

Porém, acredito que seria melhor alterar a declaração de AvailableProviders de ENUM para TYPE, o que possibilita passar a lista de provedores como string sem nenhum erro e sem nenhum import adicional (e com a vantagem adicional do intellisense):

referências: https://lukasbehal.com/2017-05-22-enums-in-declaration-files/ https://stackoverflow.com/questions/62109542/enums-in-typescript-d-ts-file

[wellwelwel]

Fala @arturdonda, 🙋🏻‍♂️

Apesar do index.d.ts não afetar o código principal (JavaScript), essa mudança quebraria o código para qualquer projeto que use TypeScript a partir do enum AvailableProviders:

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

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

---

Se possível, dá uma olhada no PR #262 onde essa modificação é feita permitindo o uso de ambas as formas 🚀