@newdash/newdash/flow.js

javascript/typescript utility library

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.flow = void 0;
/**
 * Composes a function that returns the result of invoking the given functions
 * with the `this` binding of the created function, where each successive
 * invocation is supplied the return value of the previous.
 *
 * @since 5.18.0
 * @category Util
 * @param funcs The functions to invoke.
 * @returns Returns the new composite function.
 * @see flowRight
 * @example
 *
 * ```ts
 * function square(n) {
 *   return n * n
 * }
 *
 * const addSquare = flow(add, square)
 * addSquare(1, 2)
 * // => 9
 * ```
 */
function flow(...funcs) {
    const length = funcs.length;
    let index = length;
    while (index--) {
        if (typeof funcs[index] !== "function") {
            throw new TypeError("Expected a function");
        }
    }
    return function (...args) {
        let index = 0;
        let result = length ? funcs[index].apply(this, args) : args[0];
        while (++index < length) {
            result = funcs[index].call(this, result);
        }
        return result;
    };
}
exports.flow = flow;
exports.default = flow;