maplibre-gl/src/util/throttle.ts

BSD licensed community fork of mapbox-gl, a WebGL interactive maps library

/**
 * Throttle the given function to run at most every `period` milliseconds.
 */
export function throttle<T extends (...args: any) => void>(fn: T, time: number): (...args: Parameters<T>) => ReturnType<typeof setTimeout> {
    let pending = false;
    let timerId: ReturnType<typeof setTimeout> = null;
    let lastCallArgs: Parameters<T>;

    const later = () => {
        timerId = null;
        if (pending) {
            fn(...lastCallArgs);
            timerId = setTimeout(later, time);
            pending = false;
        }
    };

    return (...args: Parameters<T>) => {
        pending = true;
        lastCallArgs = args;
        if (!timerId) {
            later();
        }
        return timerId;
    };
}