Debounced watchers pattern in Vue

Introduction

Debounced watchers help delay reacting to changes until the user stops making changes for a moment. This avoids doing work too often and improves performance.

When watching a search input to avoid sending a request on every keystroke.

When tracking window resize events but want to update layout only after resizing stops.

When validating form fields but want to wait until the user pauses typing.

When syncing data to a server but want to reduce the number of updates.

Syntax

Vue

import { ref, watch } from 'vue'
import { debounce } from 'lodash-es' // or your debounce utility

const state = ref('')

const debouncedWatcher = debounce((newValue) => {
  // react to newValue here
}, 300)

watch(state, (newValue) => {
  debouncedWatcher(newValue)
})

Use a debounce function from a utility library or write your own.

Debounce delay is in milliseconds and controls how long to wait after the last change.

Examples

This example waits 500ms after the user stops typing before logging the search term.

Vue

import { ref, watch } from 'vue'
import { debounce } from 'lodash-es'

const searchTerm = ref('')

const debouncedSearch = debounce((term) => {
  console.log('Searching for:', term)
}, 500)

watch(searchTerm, (newTerm) => {
  debouncedSearch(newTerm)
})

This example shows a simple custom debounce function without external libraries.

Vue

import { ref, watch } from 'vue'

function debounce(fn, delay) {
  let timer
  return function(...args) {
    clearTimeout(timer)
    timer = setTimeout(() => fn(...args), delay)
  }
}

const input = ref('')

const debouncedLog = debounce((val) => {
  console.log('Input changed to:', val)
}, 300)

watch(input, (val) => {
  debouncedLog(val)
})

Sample Program

This Vue 3 component uses a debounced watcher to update the displayed value only after the user stops typing for 400ms. It improves performance by not updating on every keystroke.

Vue

<template>
  <div>
    <label for="search">Search:</label>
    <input id="search" v-model="searchTerm" type="text" aria-label="Search input" />
    <p>Debounced value: {{ debouncedValue }}</p>
  </div>
</template>

<script setup>
import { ref, watch } from 'vue'

function debounce(fn, delay) {
  let timer
  return function(...args) {
    clearTimeout(timer)
    timer = setTimeout(() => fn(...args), delay)
  }
}

const searchTerm = ref('')
const debouncedValue = ref('')

const updateDebouncedValue = debounce((val) => {
  debouncedValue.value = val
}, 400)

watch(searchTerm, (val) => {
  updateDebouncedValue(val)
})
</script>

<style scoped>
input {
  padding: 0.5rem;
  font-size: 1rem;
  border: 1px solid #ccc;
  border-radius: 0.25rem;
  width: 100%;
  max-width: 300px;
}
p {
  margin-top: 0.5rem;
  font-weight: 600;
}
</style>

Important Notes

Debounced watchers help reduce unnecessary work and improve user experience.

Always clear timers properly to avoid memory leaks.

Use aria-label on inputs for accessibility.

Summary

Debounced watchers delay reactions until changes stop for a set time.

They are useful for inputs, resizing, and other frequent events.

Use debounce functions with Vue's watch to implement this pattern.

Practice

1. What is the main purpose of using a debounced watcher in Vue?

easy

A. To watch multiple data sources at once without delay

B. To delay the reaction to a data change until the changes stop for a short time

C. To prevent any reaction to data changes

D. To immediately react to every single change without delay

Solution

1. Step 1: Understand what debounce means

   Debounce means waiting until changes stop before reacting, avoiding too many reactions.

2. Step 2: Apply debounce to Vue watchers

   Debounced watchers delay the reaction to data changes until the user stops changing the data for a set time.

3. Final Answer:

   To delay the reaction to a data change until the changes stop for a short time -> Option B

4. Quick Check:

   Debounced watcher delays reaction = D [OK]

Hint: Debounced watchers wait before reacting to changes [OK]

Common Mistakes:

• Thinking watchers react immediately without delay
• Confusing debounce with throttling
• Believing debounce stops all reactions

2. Which of the following is the correct way to import a debounce function for use in a Vue watcher?

easy

A. import { watchDebounce } from 'vue-router';

B. import debounce from 'vue';

C. import { debounce } from 'lodash-es';

D. import debounce from 'vue-debounce';

Solution

1. Step 1: Identify common debounce sources

   Lodash-es is a popular library providing debounce functions for JavaScript.

2. Step 2: Check Vue imports

   Vue itself does not export debounce; it must be imported from utility libraries like lodash-es.

3. Final Answer:

   import { debounce } from 'lodash-es'; -> Option C

4. Quick Check:

   Debounce from lodash-es = A [OK]

Hint: Debounce usually comes from lodash or similar libs, not Vue core [OK]

Common Mistakes:

• Trying to import debounce directly from Vue
• Confusing debounce with Vue Router features
• Using incorrect package names

3. Given this Vue 3 setup code, what will be logged when the user types quickly in the input?

import { ref, watch } from 'vue';
import { debounce } from 'lodash-es';

const search = ref('');

watch(search, debounce((newVal) => {
  console.log('Search:', newVal);
}, 300));

medium

A. Logs only once after the user stops typing for 300ms

B. Logs every keystroke immediately

C. Logs nothing because debounce is not working

D. Logs the initial empty string only

Solution

1. Step 1: Understand debounce effect on watcher

   The debounce delays the watcher callback until 300ms after the last change.

2. Step 2: Predict console output

   When typing quickly, the callback waits and logs only once after typing stops for 300ms.

3. Final Answer:

   Logs only once after the user stops typing for 300ms -> Option A

4. Quick Check:

   Debounced watcher logs once after delay = A [OK]

Hint: Debounce batches rapid changes into one delayed call [OK]

Common Mistakes:

• Expecting logs on every keystroke
• Thinking debounce disables logging
• Confusing debounce delay with immediate calls

4. What is wrong with this Vue 3 watcher code using debounce?

import { ref, watch } from 'vue';
import { debounce } from 'lodash-es';

const query = ref('');

watch(query, () => {
  debounce(() => {
    console.log('Query:', query.value);
  }, 500)();
});

medium

A. Debounce is not imported correctly

B. query should be a reactive object, not ref

C. Watcher is missing the immediate option

D. Debounce is called inside watcher callback, creating a new debounced function every time

Solution

1. Step 1: Analyze debounce usage inside watcher

   Debounce is created inside the watcher callback, so a new debounced function is made on every change.

2. Step 2: Understand debounce effect

   This prevents debounce from working properly because the delay resets each time, causing no real debounce.

3. Final Answer:

   Debounce is called inside watcher callback, creating a new debounced function every time -> Option D

4. Quick Check:

   Debounce recreated each call = B [OK]

Hint: Create debounce once outside watcher, not inside callback [OK]

Common Mistakes:

• Defining debounce inside watcher callback
• Forgetting to reuse the same debounced function
• Misunderstanding debounce lifecycle

5. You want to watch a search input and fetch results only after the user stops typing for 400ms. Which is the best way to implement this in Vue 3?

import { ref, watch } from 'vue';
import { debounce } from 'lodash-es';

const searchTerm = ref('');

// What is the correct watcher setup?

hard

A. const debouncedFetch = debounce((val) => fetchResults(val), 400);
watch(searchTerm, (val) => debouncedFetch(val));

B. watch(searchTerm, () => debounce((val) => fetchResults(val), 400));

C. watch(searchTerm, (val) => fetchResults(val)); // no debounce

D. const debouncedFetch = debounce(fetchResults, 400);
watch(searchTerm, debouncedFetch());

Solution

1. Step 1: Create debounce function once

   Define debouncedFetch outside watcher to keep the same debounced function.

2. Step 2: Use watcher to call debounced function

   Watcher calls debouncedFetch with new value, so fetchResults runs after 400ms of no changes.

3. Final Answer:

   const debouncedFetch = debounce((val) => fetchResults(val), 400); watch(searchTerm, (val) => debouncedFetch(val)); -> Option A

4. Quick Check:

   Debounce created once, watcher calls it = C [OK]

Hint: Define debounce once, call it inside watcher callback [OK]

Common Mistakes:

• Calling debounce inside watcher callback directly
• Not passing the value to debounced function
• Calling debounced function immediately instead of passing reference