Lodash debounce with cancellation

lodash-debounce-with-cancellation.js

// Copyright 2021 Lableb

/**
 * Lodash debounce with cancellation capabilities
 *
 * @author Louay Al-osh
 */



const lodash = require("lodash");

/**
 * Search Bar is a good example of where to make a debounced requests
 */

let searchRef;

/**
 * the function you want to debounce(most likely doing an API request)
 */
function SearchAtLableb() {

    console.log('Search done');
}


function debouncedSearch() {

    // cancel any old refs
    if (searchRef && searchRef.cancel)
        searchRef.cancel();

    // create new instance and save for later
    searchRef = lodash.debounce(SearchAtLableb, 1000);

    // execute will start after 1000 unless cancelled because the function is re-invoked again
    searchRef();
}


/**
 * because it's debounced with a cancellation capability
 * no matter how many times you debounce it, it will be called only once
 * (the last call only)
 */
debouncedSearch();
debouncedSearch();
debouncedSearch();
debouncedSearch();
debouncedSearch();
debouncedSearch();