Pular para o conteúdo

Vue

O @unicep/vue traz o composable useCep, para Vue 3.3 ou mais novo.

Janela do terminal
npm install @unicep/vue

O @unicep/core é instalado junto.

<script setup lang="ts">
import { ref } from 'vue';
import { useCep } from '@unicep/vue';
const cep = ref('');
const { data, error, isLoading } = useCep(cep);
</script>
<template>
<input v-model="cep" placeholder="00000-000" />
<p v-if="isLoading">Buscando…</p>
<p v-else-if="error">{{ error.message }}</p>
<p v-else-if="data">{{ data.street }}, {{ data.neighborhood }} - {{ data.city }}/{{ data.state }}</p>
</template>

O composable só busca quando o valor é um CEP válido (com ou sem hífen), então dá para ligá-lo direto a um campo de texto. Se o CEP mudar, o resultado anterior some e a requisição em andamento é cancelada.

useCep(cep: MaybeRefOrGetter<string | null | undefined>, options?: {
unicep?: Unicep; // padrão: instância compartilhada com todos os providers
enabled?: MaybeRefOrGetter<boolean>; // false pausa as consultas, padrão true
}): {
data: Ref<Address | undefined>;
error: Ref<Error | undefined>;
isLoading: Ref<boolean>; // true enquanto a consulta do CEP válido atual está em andamento
}

cep e enabled aceitam um ref, um getter ou um valor simples. O error é um dos erros da unicep, como CepNotFoundError ou AllProvidersFailedError.

import { Unicep, viaCep, brasilApi } from '@unicep/core';
// Crie uma vez, num módulo, para não perder o estado dos circuit breakers.
const unicep = new Unicep({
providers: [viaCep(), brasilApi()],
timeoutMs: 3000,
cache: {},
});
const { data } = useCep(cep, { unicep });

Todas as opções estão em Providers e no Core.