Pular para o conteúdo

Erros

Todos os erros estendem UnicepError.

Erro Quando acontece
InvalidCepError O valor não é um CEP. Nenhuma requisição é feita. Tem input.
CepNotFoundError O CEP é válido, mas nenhum provider o conhece. Tem cep.
AllProvidersFailedError Nenhum provider conseguiu responder. error.errors tem um erro por provider, na ordem tentada.
ProviderError Lançado por um provider numa falha. Tem provider e cause.
CircuitOpenError Um provider foi pulado porque o circuito dele está aberto. Aparece em AllProvidersFailedError.errors.
import {
AllProvidersFailedError,
CepNotFoundError,
InvalidCepError,
} from '@unicep/core';
try {
const address = await unicep.lookup(input);
mostrar(address);
} catch (error) {
if (error instanceof InvalidCepError) {
// peça para conferir o CEP
} else if (error instanceof CepNotFoundError) {
// o CEP não existe
} else if (error instanceof AllProvidersFailedError) {
// todos os serviços falharam; veja error.errors
console.warn(error.errors);
} else {
throw error; // inclui o motivo de um cancelamento por AbortSignal
}
}

Se você cancelar com um AbortSignal, a promise é rejeitada com o motivo do cancelamento (por padrão, um AbortError), não com um erro da unicep. Os circuit breakers não são afetados.

  • Se todos os providers que responderam disseram que o CEP não existe, o erro é CepNotFoundError.
  • Se alguns falharam e outros disseram “não encontrado”, o erro é AllProvidersFailedError, porque não dá para afirmar que o CEP não existe.
  • Provider com o circuito aberto não conta como “respondeu”.