diff options
Diffstat (limited to 'src/index.ts')
| -rw-r--r-- | src/index.ts | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/src/index.ts b/src/index.ts index 0ac9631..6acccb3 100644 --- a/src/index.ts +++ b/src/index.ts @@ -34,7 +34,9 @@ * const address = await lookup(cepFromForm); * } catch (error) { * if (error instanceof CEPNotFound) { - * // the CEP does not exist: ask the user for another + * // the CEP does not exist: ask the user for another. `error.faixa`, when + * // present, names the municipality it would have belonged to — context + * // for the message, not an address. * } else if (error instanceof CepisError) { * // network, server, rate limit: retry later * } else { @@ -70,9 +72,11 @@ export { } from "./errors.js"; export { Address, + Faixa, Geo, Health, type AddressFields, + type FaixaFields, type GeoFields, type HealthFields, type RawObject, |