@bitcoinerlab/discovery/dist/memoizers.js

A TypeScript library for retrieving Bitcoin funds from ranged descriptors, leveraging @bitcoinerlab/explorer for standardized access to multiple blockchain explorers.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.memoizeOneWithShallowArraysCheck = void 0;
const shallow_equal_1 = require("shallow-equal");
/**
 * This function is an extension of memoizee which stores the result of the
 * latest call (cache size one). It is designed to work with functions that
 * return arrays. If the arguments for the current call are the same as the
 * latest call, it will return the same result. If the arguments are different,
 * but the returned array is shallowly equal to the previous one, it still
 * returns the same object.
 *
 * @param {Function} func - The function to be memoized. Must return an array.
 * @returns {Function} A memoized version of the input function. Returns an array.
 *
 * @example
 * const memoizedFunc = memoizeOneWithShallowArraysCheck(myFunc);
 * const result1 = memoizedFunc(arg1, arg2);
 * const result2 = memoizedFunc(arg1, arg2);
 * // Will return the same object as result1
 * const result3 = memoizedFunc(arg3, arg4);
 * // If the result is shallowly equal to result1, it will still return the
 * // same object as result1
 */
function memoizeOneWithShallowArraysCheck(func) {
    let lastArgs = null;
    let lastResult = null;
    return (...args) => {
        // If the new args are shallowly equal to the last args, return the last result
        if (lastArgs && lastResult && (0, shallow_equal_1.shallowEqualArrays)(lastArgs, args)) {
            return lastResult;
        }
        lastArgs = args;
        const newResult = func(...args);
        if (!Array.isArray(newResult)) {
            throw new Error('Function must return an array');
        }
        if (lastResult && (0, shallow_equal_1.shallowEqualArrays)(lastResult, newResult)) {
            // If the new result is shallowly equal to the last result, return the last result
            return lastResult;
        }
        else {
            lastResult = newResult;
            // Return the new result
            return newResult;
        }
    };
}
exports.memoizeOneWithShallowArraysCheck = memoizeOneWithShallowArraysCheck;