Link from function to function

[tomek-he-him]

#94 (comment)

I think we’d need to link between functions that do more or less the same thing, but take a different number of parameters.

[stoeffel]

How about we add a @see tag to the jsdoc?

i.e.

/**
 * @module 1-liners/curry
 *
 * @description
 *
 * Curry a function – split its list of parameters into 2 lists.
 *
 * @see curryRight
 * @see uncurry
 * @see uncurry3
 * ...
 */

### curry

Curry a function – split its list of parameters into 2 lists.

```js
 import curry from '1-liners/curry';
 import reduce from '1-liners/reduce';
 import compose from '1-liners/compose';

 // You can use reduce and compose to create curry3,4 and so on.
 const curry3 = compose(curry, curry);
 const curry4 = reduce(compose, [curry, curry, curry]);

 const f = (a, b, c, d) => a * b * c * d;
 const fβ = curry(f);  // ~= curry2
 const fγ = curry3(f); // ~= curry3
 const fδ = curry4(f); // ~= curry4

 f(1, 2, 3, 4)  === 24

 fβ(1)(2, 3, 4) === 24
 fβ(1, 2)(3, 4) === 24
 fβ(1, 2, 3)(4) === 24

 fγ(1)(2)(3, 4) === 24
 fγ(1)(2, 3)(4) === 24

 fδ(1)(2)(3)(4) === 24

Related functions

• curryRight
• uncurry
• uncurry3

^{Spec • Source: (f) => (...a) => (...b) => f(...a, ...b);}

[tomek-he-him]

I’d rather keep it minimal like:

Related: curryRight • uncurry • uncurry3

But definitely 👍 to that!