如何在调用后和执行前取消去抖功能？

Question

我创建了一个带有下划线的函数的去抖动版本：

var debouncedThing = _.debounce(thing, 1000);

一旦 debouncedThing 被调用...

debouncedThing();

...在实际执行之前的等待期间，有什么办法可以取消它吗？

Answer 1

我所做的是使用 _.mixin 创建一个 _.cancellableDebounce 方法。除了两条新行外，它与原始版本几乎相同。

_.mixin({
    cancellableDebounce: function(func, wait, immediate) {
        var timeout, args, context, timestamp, result;

        var later = function() {
          var last = _.now() - timestamp;

          if (last < wait && last >= 0) {
            timeout = setTimeout(later, wait - last);
          } else {
            timeout = null;
            if (!immediate) {
              result = func.apply(context, args);
              if (!timeout) context = args = null;
            }
          }
        };

        return function() {
          context = this;
          args = arguments;
          timestamp = _.now();
          var callNow = immediate && !timeout;
          if (!timeout) timeout = setTimeout(later, wait);
          if (callNow) {
            result = func.apply(context, args);
            context = args = null;
          }

          // Return timeout so debounced function can be cancelled
          result = result || {};
          result.timeout = timeout;

          return result;
        };
    }
});

用法：

var thing = function() {
    console.log("hello world");
}

var debouncedThing = _.cancellableDebounce(thing, 1000);
var timeout = debouncedThing().timeout;

clearTimeout(timeout);

Answer 2

带有可取消包装的 Vanilla js 变体

请注意，此解决方案不需要您修改外部 debounce 函数，甚至不需要使用外部函数。逻辑在 wrapepr 函数中完成。提供了去抖代码。

允许在其去抖周期内取消已调用函数的最简单方法是从可取消包装中调用它。真的只是加了3行代码和一个可选条件。

const doTheThingAfterADelayCancellable = debounce((filter, abort) => {
  if (abort) return

  // here goes your code...
  // or call the original function here

}, /*debounce delay*/500)


function onFilterChange(filter) {
  let abort = false

  if (filter.length < 3) { // your abort condition
    abort = true
  }

  // doTheThingAfterADelay(filter) // before
  doTheThingAfterADelayCancellable(filter, abort) // new wrapped debounced call
}

您可以通过 abort = true 再次调用来取消它。

它的工作方式是清除以前的超时 fn 并像往常一样设置一个新的超时，但现在使用 if (true) return 路径。

您也可以通过其他代码手动完成...

doTheThingAfterADelayCancellable(null, true)

...或者包装它并用 cancelBounce()

调用

function cancelBounce() {
  doTheThingAfterADelayCancellable(null, true)
}

For reference, this is your classic debounce function taken from Underscore. It remains intact in my example.

// taken from Underscore.js
// Returns a function, that, as long as it continues to be invoked, will not
// be triggered. The function will be called after it stops being called for
// N milliseconds. If `immediate` is passed, trigger the function on the
// leading edge, instead of the trailing.
export function debounce(func, wait, immediate) {
  let timeout
  return function() {
    let context = this, args = arguments
    let later = function() {
      timeout = null
      if (!immediate) func.apply(context, args)
    }
    let callNow = immediate && !timeout
    clearTimeout(timeout)
    timeout = setTimeout(later, wait)
    if (callNow) func.apply(context, args)
  }
}

Answer 3

如果您使用最新版本的 lodash，您可以简单地执行以下操作：

// create debounce
const debouncedThing = _.debounce(thing, 1000);

// execute debounce, it will wait one second before executing thing
debouncedThing();

// will cancel the execution of thing if executed before 1 second
debouncedThing.cancel()

另一种解决方案是使用标志：

// create the flag
let executeThing = true;

const thing = () => {
   // use flag to allow execution cancelling
   if (!executeThing) return false;
   ...
};

// create debounce
const debouncedThing = _.debounce(thing, 1000);

// execute debounce, it will wait one second before executing thing
debouncedThing();

// it will prevent to execute thing content
executeThing = false;

Answer 4

旧的，但为到达这里的其他人添加注释。

文档（我现在正在看 1.9.1）说你应该能够做到：

var fn = () => { console.log('run'); };
var db = _.debounce(fn, 1000);
db();
db.cancel();

这将完成 OP 想要做的事情（以及我想要做的事情）。它不会打印控制台消息。

我从来没有能够让它工作。正如 Underscore 文档中所承诺的，我一直在寻找 .cancel() 的高低，但我找不到它。

如果您使用的是 Underscore，请使用 Carlos Ruana 接受的答案中的标志选项。可悲的是，我的要求（在我看来）不允许从 Underscore 升级（在我看来）到 Lodash。下划线功能较少，但比没有下划线更实用。

如何在调用后和执行前取消去抖功能？

How to cancel a debounced function after it is called and before it executes?

javascript

underscore.js

带有可取消包装的 Vanilla js 变体