@eluvio/elv-js-helpers/Functional/pipe.js

A collection of Javascript helper functions used by several Eluvio libraries.

'use strict'
/**
 * Passthrough for the `pipe()` [Crocks helper function](https://crocks.dev/docs/functions/helpers.html)
 * _(Copyright © 2016, Ian Hofmann-Hicks, ISC license)_
 *
 * See [https://crocks.dev/docs/functions/helpers.html#pipe](https://crocks.dev/docs/functions/helpers.html#pipe) for
 * more details.
 *
 * Allows users of `elv-js-helpers` to use the function without adding the [Crocks](https://www.npmjs.com/package/crocks)
 * package as a dependency.
 *
 * Composes functions in left to right order (which is generally more readable than the right-to-left order used by
 * `compose`) and returns a new function.
 *
 * @function
 * @curried
 * @category Functional
 * @sig ((a -> b), ..., (y -> z)) -> a -> z
 * @param {...Function} - Two or more curried functions to compose in left-to-right order
 * @returns {Function} The composed function
 * @example
 *
 * 'use strict'
 * const pipe = require('@eluvio/elv-js-helpers/Functional/pipe')
 *
 * // function has only one input, no need to curry
 * const trim = str => str.trim()
 *
 * // function has only one input, not need to curry
 * const capitalizeFirst = str => str.charAt(0).toUpperCase() + str.slice(1)
 *
 * const trimAndCapitalize = pipe(trim, capitalizeFirst)
 *
 * trimAndCapitalize('   foo  ')    //=> 'Foo'
 *
 */
const pipe = require('crocks/helpers/pipe')

module.exports = pipe