70 lines
2.2 KiB
JavaScript
70 lines
2.2 KiB
JavaScript
/*
|
|
Copyright 2016 OpenMarket Ltd
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* 'debounces' a function to only execute every n milliseconds.
|
|
* Useful when react-sdk gets many, many events but only wants
|
|
* to update the interface once for all of them.
|
|
*
|
|
* Note that the function must not take arguments, since the args
|
|
* could be different for each invocarion of the function.
|
|
*
|
|
* The returned function has a 'cancelPendingCall' property which can be called
|
|
* on unmount or similar to cancel any pending update.
|
|
*/
|
|
module.exports = function(f, minIntervalMs) {
|
|
this.lastCall = 0;
|
|
this.scheduledCall = undefined;
|
|
|
|
const self = this;
|
|
const wrapper = function() {
|
|
const now = Date.now();
|
|
|
|
if (self.lastCall < now - minIntervalMs) {
|
|
f.apply(this);
|
|
self.lastCall = now;
|
|
} else if (self.scheduledCall === undefined) {
|
|
self.scheduledCall = setTimeout(
|
|
() => {
|
|
self.scheduledCall = undefined;
|
|
f.apply(this);
|
|
self.lastCall = now;
|
|
},
|
|
(self.lastCall + minIntervalMs) - now,
|
|
);
|
|
}
|
|
};
|
|
|
|
// add the cancelPendingCall property
|
|
wrapper.cancelPendingCall = function() {
|
|
if (self.scheduledCall) {
|
|
clearTimeout(self.scheduledCall);
|
|
self.scheduledCall = undefined;
|
|
}
|
|
};
|
|
|
|
// make sure that cancelPendingCall is copied when react rebinds the
|
|
// wrapper
|
|
const _bind = wrapper.bind;
|
|
wrapper.bind = function() {
|
|
const rebound = _bind.apply(this, arguments);
|
|
rebound.cancelPendingCall = wrapper.cancelPendingCall;
|
|
return rebound;
|
|
};
|
|
|
|
return wrapper;
|
|
};
|