ramda-adjunct 5.0.0 → 5.1.0

package/src/sign.js

@@ -1,33 +0,0 @@
-import { bind, curryN } from 'ramda';
-
-import isFunction from './isFunction.js';
-import ponyfill from './internal/ponyfills/Math.sign.js';
-
-export const signPonyfill = curryN(1, ponyfill);
-
-/**
- * Returns the sign of a number, indicating whether the number is positive, negative or zero.
- *
- * @func sign
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.15.0|v2.15.0}
- * @category Math
- * @sig Number | String -> Number
- * @param {number} number A number
- * @return {number} A number representing the sign of the given argument. If the argument is a positive number, negative number, positive zero or negative zero, the function will return 1, -1, 0 or -0 respectively. Otherwise, NaN is returned
- * @example
- *
- * RA.sign(3); //  1
- * RA.sign(-3); // -1
- * RA.sign('-3'); // -1
- * RA.sign(0); //  0
- * RA.sign(-0); // -0
- * RA.sign(NaN); // NaN
- * RA.sign('foo'); // NaN
- */
-
-const sign = isFunction(Math.sign)
-  ? curryN(1, bind(Math.sign, Math))
-  : signPonyfill;
-
-export default sign;

package/src/skipTake.js

@@ -1,33 +0,0 @@
-import {
-  curry,
-  addIndex,
-  filter,
-  pipe,
-  modulo,
-  identical,
-  nthArg,
-  __,
-} from 'ramda';
-
-/**
- * When given a number n and an array, returns an array containing every nth element.
- *
- * @func skipTake
- * @memberOf RA
- * @category List
- * @since {@link https://char0n.github.io/ramda-adjunct/2.26.0|v2.26.0}
- * @sig Number -> [a] -> [a]
- * @param {number} the nth element to extract
- * @param {Array} value the input array
- * @return {Array} An array containing every nth element
- * @example
- *
- * RA.skipTake(2, [1,2,3,4]) //=> [1, 3]
- * RA.skipTake(3, R.range(0, 20)); //=> [0, 3, 6, 9, 12, 15, 18]
- */
-
-const skipTake = curry((n, list) =>
-  addIndex(filter)(pipe(nthArg(1), modulo(__, n), identical(0)))(list)
-);
-
-export default skipTake;

package/src/sliceFrom.js

@@ -1,23 +0,0 @@
-import { __, slice } from 'ramda';
-
-/**
- * Returns the elements of the given list or string (or object with a slice method)
- * from fromIndex (inclusive).
- * Dispatches to the slice method of the second argument, if present.
- *
- * @func sliceFrom
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.16.0|v1.16.0}
- * @category List
- * @sig  Number -> [a] -> [a]
- * @param {number} fromIndex The start index (inclusive)
- * @param {Array|string} list The list or string to slice
- * @return {Array|string} The sliced list or string
- * @see {@link http://ramdajs.com/docs/#slice|R.slice}, {@link RA.sliceTo|sliceTo}
- * @example
- *
- * RA.sliceFrom(1, [1, 2, 3]); //=> [2, 3]
- */
-const sliceFrom = slice(__, Infinity);
-
-export default sliceFrom;

package/src/sliceTo.js

@@ -1,23 +0,0 @@
-import { slice } from 'ramda';
-
-/**
- * Returns the elements of the given list or string (or object with a slice method)
- * to toIndex (exclusive).
- * Dispatches to the slice method of the second argument, if present.
- *
- * @func sliceTo
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.16.0|v1.16.0}
- * @category List
- * @sig  Number -> [a] -> [a]
- * @param {number} toIndex The end index (exclusive)
- * @param {Array|string} list The list or string to slice
- * @return {Array|string} The sliced list or string
- * @see {@link http://ramdajs.com/docs/#slice|R.slice}, {@link RA.sliceFrom|sliceFrom}
- * @example
- *
- * RA.sliceTo(2, [1, 2, 3]); //=> [1, 2]
- */
-const sliceTo = slice(0);
-
-export default sliceTo;

package/src/sortByPaths.js

@@ -1,55 +0,0 @@
-import { ascend, identity, map, path, pipe, sortWith, useWith } from 'ramda';
-
-const pathToAscendSort = pipe(path, ascend);
-const mapPathsToAscendSort = map(pathToAscendSort);
-
-/**
- * Sort a list of objects by a list of paths (if first path value is equivalent, sort by second, etc).
- *
- * @func sortByPaths
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/3.1.0|v3.1.0}
- * @category List
- * @sig [[k]] -> [{k: v}] -> [{k: v}]
- * @param {Array.<Array.<string>>} paths A list of paths in the list param to sort by
- * @param {Array.<object>} list A list of objects to be sorted
- * @return {Array.<object>} A new list sorted by the paths in the paths param
- * @example
- *
- * const alice = {
- *   name: 'Alice',
- *   address: {
- *     street: 31,
- *     zipCode: 97777,
- *   },
- * };
- * const bob = {
- *   name: 'Bob',
- *   address: {
- *     street: 31,
- *     zipCode: 55555,
- *   },
- * };
- * const clara = {
- *   name: 'Clara',
- *   address: {
- *     street: 32,
- *     zipCode: 90210,
- *   },
- * };
- * const people = [clara, bob, alice]
- *
- * RA.sortByPaths([
- *   ['address', 'street'],
- *   ['address', 'zipCode'],
- * ], people); // => [bob, alice, clara]
- *
- * RA.sortByPaths([
- *   ['address', 'zipCode'],
- *   ['address', 'street'],
- * ], people); // => [bob, clara, alice]
- */
-
-const sortByPaths = useWith(sortWith, [mapPathsToAscendSort, identity]);
-
-export default sortByPaths;

package/src/sortByProp.js

@@ -1,45 +0,0 @@
-import { __, append, identity, useWith } from 'ramda';
-
-import sortByProps from './sortByProps.js';
-
-/**
- * Sort a list of objects by a property.
- *
- * @func sortByProp
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/3.4.0|v3.4.0}
- * @category List
- * @sig k -> [{k: v}] -> [{k: v}]
- * @param {Array.<string>} prop The property in the list param to sort by
- * @param {Array.<object>} list A list of objects to be sorted
- * @return {Array.<object>} A new list sorted by the property in the prop param
- * @example
- *
- * // sorting list of tuples
- * const sortByFirstItem = sortByProp(0);
- * const listOfTuples = [[-1, 1], [-2, 2], [-3, 3]];
- * sortByFirstItem(listOfTuples); // => [[-3, 3], [-2, 2], [-1, 1]]
- *
- * // sorting list of objects
- * const sortByName = sortByProp('name');
- * const alice = {
- *   name: 'ALICE',
- *   age: 101,
- * };
- * const bob = {
- *   name: 'Bob',
- *   age: -10,
- * };
- * const clara = {
- *   name: 'clara',
- *   age: 314.159,
- * };
- * const people = [clara, bob, alice];
- * sortByName(people); // => [alice, bob, clara]
- */
-
-const addValueInAnArray = append(__, []);
-
-const sortByProp = useWith(sortByProps, [addValueInAnArray, identity]);
-
-export default sortByProp;

package/src/sortByProps.js

@@ -1,31 +0,0 @@
-import { comparator, curry, either, lt, map, prop, reduce, sort } from 'ramda';
-
-/**
- * Sort a list of objects by a list of props (if first prop value is equivalent, sort by second, etc).
- *
- * @func sortByProps
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.26.0|v2.26.0}
- * @category List
- * @sig [k] -> [{k: v}] -> [{k: v}]
- * @param {Array.<string>} props A list of properties in the list param to sort by
- * @param {Array.<object>} list A list of objects to be sorted
- * @return {Array.<object>} A new list sorted by the properties in the props param
- * @example
- *
- * sortByProps(['num'], [{num: 3}, {num: 2}, {num: 1}])
- * //=> [{num: 1}, {num: 2} {num: 3}]
- * sortByProps(['letter', 'num'], [{num: 3, letter: 'a'}, {num: 2, letter: 'a'} {num: 1, letter: 'z'}])
- * //=> [ {num: 2, letter: 'a'}, {num: 3, letter: 'a'}, {num: 1, letter: 'z'}]
- * sortByProps(['name', 'num'], [{num: 3}, {num: 2}, {num: 1}])
- * //=> [{num: 1}, {num: 2}, {num: 3}]
- */
-
-const sortByProps = curry((props, list) => {
-  const firstTruthy = ([head, ...tail]) => reduce(either, head, tail);
-  const makeComparator = (propName) =>
-    comparator((a, b) => lt(prop(propName, a), prop(propName, b)));
-  return sort(firstTruthy(map(makeComparator, props)), list);
-});
-
-export default sortByProps;

package/src/spreadPath.js

@@ -1,26 +0,0 @@
-import { curryN, converge, mergeRight, dissocPath, pathOr } from 'ramda';
-
-/**
- * Spreads object under property path onto provided object.
- * It's like {@link RA.flattenPath|flattenPath}, but removes object under the property path.
- *
- * @func spreadPath
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.19.0|v1.19.0}
- * @category Object
- * @typedef Idx = String | Int
- * @sig [Idx] -> {k: v} -> {k: v}
- * @param {!Array.<string|number>} path The property path to spread
- * @param {!Object} obj The provided object
- * @return {!Object} The result of the spread
- * @see {@link RA.spreadProp|spreadProp}, {@link RA.flattenPath|flattenPath}
- * @example
- *
- * RA.spreadPath(
- *   ['b1', 'b2'],
- *   { a: 1, b1: { b2: { c: 3, d: 4 } } }
- * ); // => { a: 1, c: 3, d: 4, b1: {} };
- */
-const spreadPath = curryN(2, converge(mergeRight, [dissocPath, pathOr({})]));
-
-export default spreadPath;

package/src/spreadProp.js

@@ -1,25 +0,0 @@
-import { of, curry } from 'ramda';
-
-import spreadPath from './spreadPath.js';
-
-/**
- * Spreads object under property onto provided object.
- * It's like {@link RA.flattenProp|flattenProp}, but removes object under the property.
- *
- * @func spreadProp
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.19.0|v1.19.0}
- * @category Object
- * @typedef Idx = String | Int
- * @sig Idx -> {k: v} -> {k: v}
- * @param {!string|number} prop The property to spread
- * @param {!Object} obj The provided object
- * @return {!Object} The result of the spread
- * @see {@link RA.spreadPath|spreadPath}, {@link RA.flattenProp|flattenProp}
- * @example
- *
- * RA.spreadProp('b', { a: 1, b: { c: 3, d: 4 } }); // => { a: 1, c: 3, d: 4 };
- */
-const spreadProp = curry((prop, obj) => spreadPath(of(Array, prop), obj));
-
-export default spreadProp;

package/src/stubArray.js

@@ -1,18 +0,0 @@
-/**
- * A function that returns new empty array on every call.
- *
- * @func stubArray
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.1.0|v2.1.0}
- * @category Function
- * @sig ... -> Array
- * @return {Array} New empty array
- * @example
- *
- * RA.stubArray(); //=> []
- * RA.stubArray(1, 2, 3); //=> []
- */
-
-const stubArray = () => [];
-
-export default stubArray;

package/src/stubNull.js

@@ -1,19 +0,0 @@
-import { always } from 'ramda';
-
-/**
- * A function that returns `null`.
- *
- * @func stubNull
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.6.0|v1.6.0}
- * @category Function
- * @sig ... -> null
- * @return {null}
- * @example
- *
- * RA.stubNull(); //=> null
- * RA.stubNull(1, 2, 3); //=> null
- */
-const stubNull = always(null);
-
-export default stubNull;

package/src/stubObj.js

@@ -1,19 +0,0 @@
-/**
- * This function returns a new empty object.
- *
- * @func stubObj
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.1.0|v2.1.0}
- * @category Function
- * @sig ... -> Object
- * @aliases stubObject
- * @return {Object} Returns the new empty object.
- * @example
- *
- * RA.stubObj(); //=> {}
- * RA.stubObj(1, 2, 3); //=> {}
- */
-
-const stubObj = () => ({});
-
-export default stubObj;

package/src/stubString.js

@@ -1,19 +0,0 @@
-import { always } from 'ramda';
-
-/**
- * A function that returns empty string.
- *
- * @func stubString
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.1.0|v2.1.0}
- * @category Function
- * @sig ... -> String
- * @return {string} The empty string
- * @example
- *
- * RA.stubString(); //=> ''
- * RA.stubString(1, 2, 3); //=> ''
- */
-const stubString = always('');
-
-export default stubString;

package/src/stubUndefined.js

@@ -1,19 +0,0 @@
-import { always } from 'ramda';
-
-/**
- * A function that returns `undefined`.
- *
- * @func stubUndefined
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.0.0|v1.0.0}
- * @category Function
- * @sig ... -> undefined
- * @return {undefined}
- * @example
- *
- * RA.stubUndefined(); //=> undefined
- * RA.stubUndefined(1, 2, 3); //=> undefined
- */
-const stubUndefined = always(void 0); // eslint-disable-line no-void
-
-export default stubUndefined;

package/src/subtractNum.js

@@ -1,20 +0,0 @@
-import { flip, subtract } from 'ramda';
-
-/**
- * Subtracts its first argument from its second argument.
- *
- * @func subtractNum
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category Math
- * @sig Number -> Number -> Number
- * @param {number} subtrahend the number to subtract
- * @param {number} minuend the number to subtract from
- * @return {number} A number representing the difference of subtracting the subtrahend from the minuend
- * @example
- *
- * RA.subtractNum(3, 5); //=> 2
- */
-const subtractNum = flip(subtract);
-
-export default subtractNum;

package/src/thenCatchP.js

@@ -1,27 +0,0 @@
-import { invoker } from 'ramda';
-
-/**
- * Composable shortcut for `Promise.then` that allows for success and failure callbacks.
- * The thenCatchP function returns a Promise. It takes three arguments: a callback function for the success of the Promise,
- * a callback function for the failure of the Promise, and the promise instance itself.
- *
- * @func thenCatchP
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.27.0|v2.27.0}
- * @category Function
- * @sig (a -> b) -> (c -> d) -> Promise a -> Promise b | d
- * @param {Function} onFulfilled A Function called if the Promise is fulfilled. This function has one argument, the fulfillment value
- * @param {Function} onRejected A Function called if the Promise is rejected. This function has one argument, the error
- * @param {Promise} promise Any Promise or Thenable object
- * @return {Promise}
- * @see {@link RA.resolveP|resolveP}, {@link RA.rejectP|rejectP}, {@link RA.allP|allP}
- * @example
- *
- * const promise = Promise.resolve(1);
- * const add1 = x => x + 1;
- *
- * RA.thenCatchP(add1, console.error, promise); // => Promise(2)
- */
-export const thenCatchP = invoker(2, 'then');
-
-export default thenCatchP;

package/src/toArray.js

@@ -1,32 +0,0 @@
-import { ifElse, values, curryN } from 'ramda';
-
-import isIterable from './isIterable.js';
-import isFunction from './isFunction.js';
-import ponyfill from './internal/ponyfills/Array.from.js';
-
-export const fromPonyfill = curryN(1, ponyfill);
-
-const fromArray = isFunction(Array.from) ? curryN(1, Array.from) : fromPonyfill;
-
-/**
- * Converts value to an array.
- *
- * @func toArray
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category List
- * @sig * -> [a]
- * @param {*} val The value to convert
- * @return {Array}
- * @example
- *
- * RA.toArray([1, 2]); //=> [1, 2]
- * RA.toArray({'foo': 1, 'bar': 2}); //=> [1, 2]
- * RA.toArray('abc'); //=> ['a', 'b', 'c']
- * RA.toArray(1); //=> []
- * RA.toArray(null); //=> []
- */
-
-const toArray = ifElse(isIterable, fromArray, values);
-
-export default toArray;

package/src/toInteger32.js

@@ -1,22 +0,0 @@
-import { curryN } from 'ramda';
-/**
- * Converts double-precision 64-bit binary format IEEE 754 to signed 32 bit integer number.
- *
- * @func toInteger32
- * @aliases toInt32
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.28.0|v2.28.0}
- * @category Math
- * @sig Number -> Number
- * @param {number} number A number
- * @return {number} A signed 32-bit integer number
- * @see {@link RA.toUInteger32|toUInteger32}, {@link http://speakingjs.com/es5/ch11.html#integers_via_bitwise_operators}
- * @example
- *
- * RA.toInteger32(2 ** 35); // => 0
- * RA.toInteger32(2 ** 30); // => 1073741824
- */
-// eslint-disable-next-line no-bitwise
-const toInteger32 = curryN(1, (val) => val >> 0);
-
-export default toInteger32;

package/src/toNumber.js

@@ -1,24 +0,0 @@
-import { ifElse, always } from 'ramda';
-
-import isCoercible from './internal/isCoercible.js';
-
-/**
- * Converts value to a number.
- *
- * @func toNumber
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.36.0|v2.36.0}
- * @category Type
- * @param {*} val The value to convert
- * @return {Number}
- * @example
- *
- * RA.toNumber(3.2); //=> 3.2
- * RA.toNumber(Number.MIN_VALUE); //=> 5e-324
- * RA.toNumber(Infinity); //=> Infinity
- * RA.toNumber('3.2'); //=> 3.2
- * RA.toNumber(Symbol('3.2')); //=> NaN
- */
-const toNumber = ifElse(isCoercible, Number, always(NaN));
-
-export default toNumber;

package/src/toUinteger32.js

@@ -1,26 +0,0 @@
-import { curryN } from 'ramda';
-
-/**
- * Converts double-precision 64-bit binary format IEEE 754 to unsigned 32 bit integer number.
- *
- * @func toUinteger32
- * @aliases toUint32
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.28.0|v2.28.0}
- * @category Math
- * @sig Number -> Number
- * @param {number} val Value to be converted.
- * @return {number}
- * @see {@link RA.toInteger32|toInteger32}, {@link http://speakingjs.com/es5/ch11.html#integers_via_bitwise_operators}
- * @example
- *
- * RA.toUinteger32(1.5); //=> 1
- * RA.toInteger32(2 ** 35); // => 0
- * RA.toInteger32(2 ** 31); // => 2147483648
- * RA.toInteger32(2 ** 30); // => 1073741824
- */
-
-// eslint-disable-next-line no-bitwise
-const toUinteger32 = curryN(1, (val) => val >>> 0);
-
-export default toUinteger32;

package/src/trimCharsEnd.js

@@ -1,25 +0,0 @@
-import { curry, dropLastWhile, join, pipe, split } from 'ramda';
-
-import included from './included.js';
-
-/**
- * Removes specified characters from the end of a string.
- *
- * @func trimCharsEnd
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.25.0|v2.25.0}
- * @category String
- * @sig String -> String
- * @param {string} chars The characters to trim
- * @param {string} value The string to trim
- * @return {string} Returns the trimmed string.
- * @example
- *
- * RA.trimCharsEnd('_-', '-_-abc-_-'); //=> '-_-abc'
- */
-
-const trimCharsEnd = curry((chars, value) =>
-  pipe(split(''), dropLastWhile(included(chars)), join(''))(value)
-);
-
-export default trimCharsEnd;

package/src/trimCharsStart.js

@@ -1,25 +0,0 @@
-import { curry, dropWhile, join, pipe, split } from 'ramda';
-
-import included from './included.js';
-
-/**
- * Removes specified characters from the beginning of a string.
- *
- * @func trimCharsStart
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.24.0|v2.24.0}
- * @category String
- * @sig String -> String
- * @param {string} chars The characters to trim
- * @param {string} value The string to trim
- * @return {string} Returns the trimmed string.
- * @example
- *
- * RA.trimCharsStart('_-', '-_-abc-_-'); //=> 'abc-_-'
- */
-
-const trimCharsStart = curry((chars, value) =>
-  pipe(split(''), dropWhile(included(chars)), join(''))(value)
-);
-
-export default trimCharsStart;

package/src/trimEnd.js

@@ -1,30 +0,0 @@
-import { invoker } from 'ramda';
-
-import ponyfill from './internal/ponyfills/String.trimEnd.js';
-import isFunction from './isFunction.js';
-
-export const trimEndPonyfill = ponyfill;
-
-export const trimEndInvoker = invoker(0, 'trimEnd');
-
-/**
- * Removes whitespace from the end of a string.
- *
- * @func trimEnd
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category String
- * @sig String -> String
- * @param {string} value String value to have the whitespace removed from the end
- * @return {string} A new string representing the calling string stripped of whitespace from its end (right end).
- * @see {@link RA.trimEnd|trimEnd}
- * @example
- *
- * RA.trimEnd('abc   '); //=> 'abc'
- */
-
-const trimEnd = isFunction(String.prototype.trimEnd)
-  ? trimEndInvoker
-  : trimEndPonyfill;
-
-export default trimEnd;

package/src/trimStart.js

@@ -1,29 +0,0 @@
-import { invoker } from 'ramda';
-
-import ponyfill from './internal/ponyfills/String.trimStart.js';
-import isFunction from './isFunction.js';
-
-export const trimStartPonyfill = ponyfill;
-
-export const trimStartInvoker = invoker(0, 'trimStart');
-
-/**
- * Removes whitespace from the beginning of a string.
- *
- * @func trimStart
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category String
- * @sig String -> String
- * @param {string} value String value to have the whitespace removed from the beginning
- * @return {string} A new string representing the calling string stripped of whitespace from its beginning (left end).
- * @example
- *
- * RA.trimStart('  abc'); //=> 'abc'
- */
-
-const trimStart = isFunction(String.prototype.trimStart)
-  ? trimStartInvoker
-  : trimStartPonyfill;
-
-export default trimStart;