Skip to content

open-nfse / CepValidator

Interface: CepValidator

Defined in: src/cep/types.ts:25

Validador de CEP pluggable. Implementações podem consultar ViaCEP, BrasilAPI, o banco de endereços dos Correios, um cache local, etc.

Contrato:

  • Se o formato for inválido → lance InvalidCepError('format').
  • Se o CEP não existir → lance InvalidCepError('not_found').
  • Se a API externa falhar → lance InvalidCepError('api_unavailable').
  • Se for válido → retorne CepInfo.

Methods

validate()

ts
validate(cep: string): Promise<CepInfo>;

Defined in: src/cep/types.ts:26

Parameters

ParameterType
cepstring

Returns

Promise<CepInfo>

Licença MIT — biblioteca não oficial, sem vínculo com a Receita Federal.