ramda-adjunct 5.0.0 → 5.0.1

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;

package/src/trunc.js

@@ -1,33 +0,0 @@
-import { bind, curryN } from 'ramda';
-
-import ponyfill from './internal/ponyfills/Math.trunc.js';
-import isFunction from './isFunction.js';
-
-export const truncPonyfill = curryN(1, ponyfill);
-
-/**
- * Returns the integer part of a number by removing any fractional digits.
- *
- * @func trunc
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.15.0|v2.15.0}
- * @category Math
- * @sig Number | String -> Number
- * @param {number|string} number The number to trunc
- * @return {number} The integer part of the given number
- * @example
- *
- * RA.trunc(13.37); //=> 13
- * RA.trunc(42.84); //=> 42
- * RA.trunc(0.123); //=>  0
- * RA.trunc(-0.123); //=> -0
- * RA.trunc('-1.123'); //=> -1
- * RA.trunc(NaN); //=> NaN
- * RA.trunc('foo'); //=> NaN
- */
-
-const trunc = isFunction(Math.trunc)
-  ? curryN(1, bind(Math.trunc, Math))
-  : truncPonyfill;
-
-export default trunc;

package/src/unzipObjWith.js

@@ -1,40 +0,0 @@
-import {
-  apply,
-  curryN,
-  flip,
-  map,
-  pipe,
-  toPairs,
-  transpose,
-  when,
-} from 'ramda';
-
-import lengthEq from './lengthEq.js';
-
-/**
- * Creates a new list out of the supplied object by applying the function to each key/value pairing.
- *
- * @func unzipObjWith
- * @memberOf RA
- * @category Object
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @sig  (v, k) => [k, v] -> { k: v } -> [[k], [v]]
- * @param {Function} fn The function to transform each value-key pair
- * @param {Object} obj Object to unzip
- * @return {Array} A pair of tw lists: a list of keys and a list of values
- * @see {@link https://ramdajs.com/docs/#zipObj|zipObj}, {@link RA.zipObjWith|zipObjWith}
- * @example
- *
- * RA.unzipObjWith((v, k) => [`new${k.toUpperCase()}`, 2 * v], { a: 1, b: 2, c: 3 });
- * //=> [['newA', 'newB', 'newC'], [2, 4, 6]]
- */
-const unzipObjWith = curryN(2, (fn, obj) =>
-  pipe(
-    toPairs,
-    map(pipe(flip, apply)(fn)),
-    transpose,
-    when(lengthEq(0), () => [[], []])
-  )(obj)
-);
-
-export default unzipObjWith;

package/src/viewOr.js

@@ -1,32 +0,0 @@
-import { view, defaultTo, curryN } from 'ramda';
-
-/**
- * Returns a "view" of the given data structure, determined by the given lens.
- * The lens's focus determines which portion of the data structure is visible.
- * Returns the defaultValue if "view" is null, undefined or NaN; otherwise the "view" is returned.
- *
- * @func viewOr
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.13.0|1.13.0}
- * @category Object
- * @typedef Lens s b = Functor f => (b -> f b) -> s -> f s
- * @sig a -> Lens s b -> s -> b | a
- * @see {@link http://ramdajs.com/docs/#view|R.view}
- * @param {*} defaultValue The default value
- * @param {Function} lens Van Laarhoven lens
- * @param {*} data The data structure
- * @returns {*} "view" or defaultValue
- *
- * @example
- *
- * RA.viewOr('N/A', R.lensProp('x'), {}); // => 'N/A'
- * RA.viewOr('N/A', R.lensProp('x'), { x: 1 }); // => 1
- * RA.viewOr('some', R.lensProp('y'), { y: null }); // => 'some'
- * RA.viewOr('some', R.lensProp('y'), { y: false }); // => false
- */
-
-const viewOr = curryN(3, (defaultValue, lens, data) =>
-  defaultTo(defaultValue, view(lens, data))
-);
-
-export default viewOr;

package/src/weave.js

@@ -1,35 +0,0 @@
-import { curryN } from 'ramda';
-
-/**
- * Weaves a configuration into function returning the runnable monad like `Reader` or `Free`.
- * This allows us to pre-bind the configuration in advance and use the weaved function
- * without need to explicitly pass the configuration on every call.
- *
- * @func weave
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.7.0|v1.7.0}
- * @category Function
- * @sig (*... -> *) -> * -> (*... -> *)
- * @param {Function} fn The function to weave
- * @param {*} config The configuration to weave into fn
- * @return {Function} Auto-curried weaved function
- * @example
- *
- * const { Reader: reader } = require('monet');
- *
- * const log = value => reader(
- *   config => config.log(value)
- * );
- *
- * // no weaving
- * log('test').run(console); //=> prints 'test'
- *
- * // weaving
- * const wlog = RA.weave(log, console);
- * wlog('test'); //=> prints 'test'
- */
-const weave = curryN(2, (fn, config) =>
-  curryN(fn.length, (...args) => fn(...args).run(config))
-);
-
-export default weave;

package/src/weaveLazy.js

@@ -1,37 +0,0 @@
-import { curryN } from 'ramda';
-
-/**
- * Weaves a configuration into function returning the runnable monad like `Reader` or `Free`.
- * This allows us to pre-bind the configuration in advance and use the weaved function
- * without need to explicitly pass the configuration on every call.
- *
- * @func weaveLazy
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.10.0|v1.10.0}
- * @category Function
- * @sig (*... -> *) -> (* -> *) -> (*... -> *)
- * @param {Function} fn The function to weave
- * @param {Function} configAccessor The function that returns the configuration object
- * @return {Function} Auto-curried weaved function
- * @example
- *
- * const { Reader: reader } = require('monet');
- *
- * const log = value => reader(
- *   config => config.log(value)
- * );
- *
- * const consoleAccessor = R.always(console);
- *
- * // no weaving
- * log('test').run(console); //=> prints 'test'
- *
- * // weaving
- * const wlog = RA.weaveLazy(log, consoleAccessor);
- * wlog('test'); //=> prints 'test'
- */
-const weaveLazy = curryN(2, (fn, configAccessor) =>
-  curryN(fn.length, (...args) => fn(...args).run(configAccessor()))
-);
-
-export default weaveLazy;

package/src/zipObjWith.js

@@ -1,27 +0,0 @@
-import { apply, curryN, fromPairs, map, pipe, zip } from 'ramda';
-
-/**
- * Creates a new object out of a list of keys and a list of values by applying the function
- * to each equally-positioned pair in the lists.
- * Key/value pairing is truncated to the length of the shorter of the two lists.
- *
- * @func zipObjWith
- * @memberOf RA
- * @category Object
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @sig (b, a) -> [k, v] -> [a] -> [b] -> { k: v }
- * @param {Function} fn The function to transform each value-key pair
- * @param {Array} keys Array to transform into the properties on the output object
- * @param {Array} values Array to transform into the values on the output object
- * @return {Object}  The object made by pairing up and transforming same-indexed elements of `keys` and `values`.
- * @see {@link https://ramdajs.com/docs/#zipObj|zipObj}, {@link RA.unzipObjWith|unzipObjWith}
- * @example
- *
- * RA.zipObjWith((value, key) => [key, `${key}${value + 1}`]), ['a', 'b', 'c'], [1, 2, 3]);
- *  // => { a: 'a2', b: 'b3', c: 'c4' }
- */
-const zipObjWith = curryN(3, (fn, keys, values) =>
-  pipe(zip, map(apply(fn)), fromPairs)(values, keys)
-);
-
-export default zipObjWith;