toosoon-utils/lib/functions.js

Utility functions & classes

/**
 * No-op function
 */
export const noop = () => { };
/**
 * Promise wrapped setTimeout
 *
 * @param {number} [delay=0] Time to wait (in milliseconds)
 * @returns {Promise}
 */
export function wait(delay = 0) {
    return new Promise((resolve) => setTimeout(resolve, delay));
}
/**
 * Check if a value is defined
 *
 * @template {unknown} [T=unknown]
 * @param {T} value Value to check
 * @returns {boolean} `true` if the given value is defined, `false` otherwise
 */
export function isDefined(value) {
    if (typeof value === 'undefined' || value === null)
        return false;
    return true;
}
/**
 * Create a debounced function that delays the execution of a given callback until a specified delay time has passed since the last call
 *
 * @template {Function} T
 * @param {T} callback Function to debounce
 * @param {number} delay Delay (in milliseconds)
 * @returns {T} Debounced function
 */
export function debounce(callback, delay) {
    let timeout = null;
    return (...args) => {
        if (timeout)
            clearTimeout(timeout);
        timeout = setTimeout(() => callback(...args), delay);
    };
}
/**
 * Create a throttled function that limits the execution of a given callback to once every specified limit time
 *
 * @template {Function} T
 * @param {T} callback Function to throttle
 * @param {number} limit Minimum interval between two calls (in milliseconds)
 * @returns {T} Throttled function
 */
export function throttle(callback, limit) {
    let lastTime = 0;
    return (...args) => {
        const time = now();
        if (time - lastTime >= limit) {
            lastTime = time;
            callback(...args);
        }
    };
}
/**
 * Polyfill for `now()` functions
 */
export let now;
// In node.js, use `process.hrtime`
if (typeof process !== 'undefined' && process.hrtime) {
    now = function () {
        // Convert [seconds, nanoseconds] to milliseconds
        const time = process.hrtime();
        return time[0] * 1000 + time[1] / 1000000;
    };
}
// In a browser use `performance` or `Date`
else if (typeof performance !== 'undefined') {
    // This must be bound, because directly assigning this function leads to an invocation exception in Chrome
    now = performance.now.bind(performance);
}
else if (typeof Date.now !== 'undefined') {
    now = Date.now;
}
else {
    now = function () {
        return new Date().getTime();
    };
}