@eusilvio/cep-lookup-vue

Vue 3 Composition API hooks for @eusilvio/cep-lookup.

Installation

npm install @eusilvio/cep-lookup @eusilvio/cep-lookup-vue vue

Usage

<script setup>
import { ref } from 'vue';
import { useCepLookup } from '@eusilvio/cep-lookup-vue';

const cepInput = ref('01001000');
const { address, loading, error } = useCepLookup(cepInput);
</script>

<template>
  <div>
    <input v-model="cepInput" placeholder="Digite o CEP" />
    
    <div v-if="loading">Buscando...</div>
    <div v-else-if="error" style="color: red">{{ error.message }}</div>
    <div v-else-if="address">
      <p>Endereço: {{ address.street }}, {{ address.city }} - {{ address.state }}</p>
    </div>
  </div>
</template>

API

useCepLookup<T = Address>(cep: Ref<string> | string, options?)

A Vue 3 composition API hook for CEP lookups.

Options

• delay (optional): number - Debounce delay. Default: 500.
• staggerDelay (optional): number - Staggered race delay. Default: 100.
• instance (optional): CepLookup - Custom instance.
• mapper (optional): (address: Address) => T - Custom mapper.

Returns

• address: Ref<T | null>
• loading: Ref<boolean>
• error: Ref<Error | null>
• warmup: () => Promise<void> - Function to trigger predictive ranking.