Batched function calls (debounce) (💚 completed)

[fregante]

Batched execution:

1. fun(1)
2. fun(2)
3. fun(4)
4. Then the original _fun is called as _fun([1, 2, 4])

Would be cool:

• original function accepts array
• batched function accepts single item
• option to call batched functions in the next tick or after a timeout (probably defaulting to setTimeout(0) is good enough)

Some of the complexity here is in managing the types for these functions.

Real-life scenario: refined-github/refined-github#5991 (comment)

[Richienb]

function batchFn(function_) {
  let queue = [];

  return function addToQueue(value) {
    queue.push(value);

    if (queue.length === 1) {
      setTimeout(() => {
        function_(queue);
        queue = [];
      });
    }
  }
}

[Richienb]

Also consider: queueMicrotask()

[fregante]

Pretty good! That format also allows to include a simple "ms" parameter to batchFn to pass it straight to setTimeout.

Types are probably the next difficult part

[Richienb]

export default function batchFn<ValueType>(function_: (value: ValueType[]) => unknown): (value: ValueType) => void;

[fregante]

Are you going to publish that? 🙏

[Richienb]

ok https://github.com/Richienb/batched-function

@fregante would you mind if I added you as a collaborator?

[fregante]

Sure. I'd probably like optionally replacing the setTimeout too, like with setImmediate or nextTick

[Richienb]

Sure. I'd probably like optionally replacing the setTimeout too, like with setImmediate or nextTick

I added an option that allows the milliseconds between invokations to be changed, maybe another function could be used when no value is provided but it couldn't be either of those 2 because neither work in the browser.

[fregante]

What I wanted was Promise.resolved().then() to attempt calling them "synchronously" before the browser paints something on the screen. I think automatically switching to that when the timeout is 0 is a good compromise.

[Richienb]

Perhaps it should be used if the timeout is undefined, and setTimeout is used when timeout is any number.

[fregante]

SGTM. Also PR welcome to Refined GitHub to replace the local copy.