ramda-adjunct 2.36.0 → 3.2.0

package/types/index.d.ts

@@ -360,6 +360,12 @@ declare namespace RamdaAdjunct {
          */
         isInteger32(val: any): boolean;
 
+        /**
+         * Checks whether the passed value is an unsigned 32 bit integer number.
+         */
+        isUinteger32(val: any): boolean;
+        isUint32(val: any): boolean; // alias
+
         /**
          * Checks whether the passed value is complement of `integer`.
          */
@@ -370,6 +376,12 @@ declare namespace RamdaAdjunct {
          */
         isBigInt(val: any): boolean;
 
+        /**
+         * Returns `true` if the given value is its type's empty value, `false`, `undefined`
+         * as well as strings containing only whitespace characters; `false` otherwise.
+         */
+        isBlank(val: any): boolean;
+
         /**
          * Checks whether the passed value is a `float`.
          */
@@ -629,19 +641,6 @@ declare namespace RamdaAdjunct {
             (key: string): (obj: object) => object;
         };
 
-        /**
-         * Create a new object with the own properties of the second object merged with
-         * the own properties of the first object. If a key exists in both objects,
-         * the value from the first object will be used. *
-         * Putting it simply: it sets properties only if they don't exist.
-         */
-        mergeRight(source: object, destination: object): object;
-        mergeRight(source: object): (destination: object) => object;
-        mergeLeft(source: object, destination: object): object; // alias
-        mergeLeft(source: object): (destination: object) => object; // alias
-        resetToDefault(defaultOptions: object, options: object): object; // alias of mergeRight
-        resetToDefault(defaultOptions: object): (options: object) => object; // alias of mergeRight
-
         /**
          * Functional equivalent of merging object properties with object spread.
          */
@@ -901,12 +900,6 @@ declare namespace RamdaAdjunct {
             (high: number): (value: number) => boolean;
         };
 
-        /**
-         * Returns whether or not an object has an own property with the specified name at a given path.
-         */
-        hasPath(path: Array<string | number>, obj: object): boolean;
-        hasPath(path: Array<string | number>): (obj: object) => boolean;
-
         /**
          * Spreads object under property path onto provided object.
          */
@@ -1018,16 +1011,6 @@ declare namespace RamdaAdjunct {
         catchP<A, B = unknown>(onRejected: (error: any) => B | Promise<B>, promise: Promise<A>): Promise<A | B>;
         catchP<A, B = unknown>(onRejected: (error: any) => B | Promise<B>): (promise: Promise<A>) => Promise<A | B>;
 
-        /**
-         * Composable shortcut for `Promise.then`.
-         * The thenP function returns a Promise. It takes two arguments: a callback function for the success of the Promise
-         * and the promise instance itself.
-         */
-        thenP<T>(onFulfilled: Function, thenable: Promise<T>): Promise<T>;
-        thenP<T>(onFulfilled: Function): (thenable: Promise<T>) => Promise<T>;
-        then<T>(onFulfilled: Function, thenable: Promise<T>): Promise<T>;
-        then<T>(onFulfilled: Function): (thenable: Promise<T>) => Promise<T>;
-
         /**
          * Composable shortcut for `Promise.then` that allows for success and failure call backs.
          * The thenCatchP function returns a Promise. It takes three arguments: a callback function for the success of the Promise,
@@ -1323,12 +1306,10 @@ declare namespace RamdaAdjunct {
          * to at least one element of the given list or false otherwise.
          * Given list can be a string.
          *
-         * Like {@link http://ramdajs.com/docs/#contains|R.contains} but with argument order reversed.
+         * Like {@link http://ramdajs.com/docs/#contains|R.includes} but with argument order reversed.
          */
-        contained<T>(list: T[], val: T): boolean;
-        contained<T>(list: T[]): (val: T) => boolean;
-        included<T>(list: T[], val: T): boolean; // alias
-        included<T>(list: T[]): (val: T) => boolean; // alias
+        included<T>(list: T[], val: T): boolean;
+        included<T>(list: T[]): (val: T) => boolean;
 
         /**
          * Can be used as a way to compose multiple invokers together to form polymorphic functions,
@@ -1508,6 +1489,12 @@ declare namespace RamdaAdjunct {
         skipTake<T>(n: number, list: T[]): T[];
         skipTake<T>(n: number): (list: T[]) => T[];
 
+        /**
+         * Sort a list of objects by a list of paths (if first path value is equivalent, sort by second, etc).
+         */
+        sortByPaths(props: string[][], list: object[]): object[];
+        sortByPaths(props: string[][]): (list: object[]) => object[];
+
         /**
          * Determine if input value is an indexed data type.
          */

package/es/contained.js

@@ -1,29 +0,0 @@
-import { flip, contains } from 'ramda';
-/**
- * Returns true if the specified value is equal, in R.equals terms,
- * to at least one element of the given list or false otherwise.
- * Given list can be a string.
- *
- * Like {@link http://ramdajs.com/docs/#contains|R.contains} but with argument order reversed.
- *
- * @func contained
- * @aliases included
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @deprecated since v2.12.0; please use RA.included alias
- * @category List
- * @sig [a] -> a -> Boolean
- * @param {Array|String} list The list to consider
- * @param {*} a The item to compare against
- * @return {boolean} Returns Boolean `true` if an equivalent item is in the list or `false` otherwise
- * @see {@link http://ramdajs.com/docs/#contains|R.contains}
- * @example
- *
- * RA.contained([1, 2, 3], 3); //=> true
- * RA.contained([1, 2, 3], 4); //=> false
- * RA.contained([{ name: 'Fred' }], { name: 'Fred' }); //=> true
- * RA.contained([[42]], [42]); //=> true
- */
-
-var contained = flip(contains);
-export default contained;

package/es/hasPath.js

@@ -1,38 +0,0 @@
-import { length, has, path, head, tail, curryN } from 'ramda';
-import isObj from './isObj';
-/**
- * Returns whether or not an object has an own property with the specified name at a given path.
- *
- * @func hasPath
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.14.0|v1.14.0}
- * @deprecated since v2.12.0; ramda@0.26.0 contains hasPath
- * @category Object
- * @typedef Idx = String | Int
- * @sig [Idx] -> {a} -> Boolean
- * @param {Array.<string|number>} path The path of the nested property
- * @param {Object} obj The object to test
- * @return {boolean}
- * @see {@link http://ramdajs.com/docs/#has|R.has}
- * @example
- *
- * RA.hasPath(['a', 'b'], { a: { b: 1 } }); //=> true
- * RA.hasPath(['a', 'b', 'c'], { a: { b: 1 } }); //=> false
- * RA.hasPath(['a', 'b'], { a: { } }); //=> false
- * RA.hasPath([0], [1, 2]); //=> true
- */
-
-var hasPath = curryN(2, function (objPath, obj) {
-  var prop = head(objPath); // termination conditions
-
-  if (length(objPath) === 0 || !isObj(obj)) {
-    return false;
-  }
-
-  if (length(objPath) === 1) {
-    return has(prop, obj);
-  }
-
-  return hasPath(tail(objPath), path([prop], obj)); // base case
-});
-export default hasPath;

package/es/mergeRight.js

@@ -1,26 +0,0 @@
-import { merge, flip } from 'ramda';
-/**
- * Create a new object with the own properties of the second object merged with
- * the own properties of the first object. If a key exists in both objects,
- * the value from the first object will be used. *
- * Putting it simply: it sets properties only if they don't exist.
- *
- * @func mergeRight
- * @deprecated since v2.12.0; available in ramda@0.26.0 as R.mergeLeft
- * @aliases mergeLeft, resetToDefault
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.6.0|v1.6.0}
- * @category Object
- * @sig {k: v} -> {k: v} -> {k: v}
- * @param {Object} r Destination
- * @param {Object} l Source
- * @return {Object}
- * @see {@link http://ramdajs.com/docs/#merge|R.merge}, {@link https://github.com/ramda/ramda/wiki/Cookbook#set-properties-only-if-they-dont-exist|Ramda Cookbook}
- * @example
- *
- * RA.mergeRight({ 'age': 40 }, { 'name': 'fred', 'age': 10 });
- * //=> { 'name': 'fred', 'age': 40 }
- */
-
-var mergeRight = flip(merge);
-export default mergeRight;

package/es/thenP.js

@@ -1,28 +0,0 @@
-import { invoker } from 'ramda';
-/**
- * Composable shortcut for `Promise.then`.
- * The thenP function returns a Promise. It takes two arguments: a callback function for the success of the Promise
- * and the promise instance itself.
- *
- * @func thenP
- * @memberOf RA
- * @aliases then
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @deprecated since v2.12.0; available in ramda@0.26.0 as R.then
- * @category Function
- * @sig (a -> Promise b | b) -> Promise b
- * @param {Function} onFulfilled A Function called if the Promise is fulfilled. This function has one argument, the fulfillment value
- * @param {Promise} promise Any Promise or Thenable object
- * @return {Promise} A Promise in the pending status
-
- * @see {@link RA.resolveP|resolveP}, {@link RA.rejectP|rejectP}, {@link RA.allP|allP}
- * @example
- *
- * const promise = Promise.resolve(1);
- * const add1 = v => v + 1;
- *
- * RA.thenP(add1, promise); // => Promise(2)
- */
-
-var thenP = invoker(1, 'then');
-export default thenP;

package/lib/contained.js

@@ -1,35 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports["default"] = void 0;
-
-var _ramda = require("ramda");
-
-/**
- * Returns true if the specified value is equal, in R.equals terms,
- * to at least one element of the given list or false otherwise.
- * Given list can be a string.
- *
- * Like {@link http://ramdajs.com/docs/#contains|R.contains} but with argument order reversed.
- *
- * @func contained
- * @aliases included
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @deprecated since v2.12.0; please use RA.included alias
- * @category List
- * @sig [a] -> a -> Boolean
- * @param {Array|String} list The list to consider
- * @param {*} a The item to compare against
- * @return {boolean} Returns Boolean `true` if an equivalent item is in the list or `false` otherwise
- * @see {@link http://ramdajs.com/docs/#contains|R.contains}
- * @example
- *
- * RA.contained([1, 2, 3], 3); //=> true
- * RA.contained([1, 2, 3], 4); //=> false
- * RA.contained([{ name: 'Fred' }], { name: 'Fred' }); //=> true
- * RA.contained([[42]], [42]); //=> true
- */
-var contained = (0, _ramda.flip)(_ramda.contains);
-var _default = contained;
-exports["default"] = _default;

package/lib/hasPath.js

@@ -1,47 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports["default"] = void 0;
-
-var _ramda = require("ramda");
-
-var _isObj = _interopRequireDefault(require("./isObj"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-
-/**
- * Returns whether or not an object has an own property with the specified name at a given path.
- *
- * @func hasPath
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.14.0|v1.14.0}
- * @deprecated since v2.12.0; ramda@0.26.0 contains hasPath
- * @category Object
- * @typedef Idx = String | Int
- * @sig [Idx] -> {a} -> Boolean
- * @param {Array.<string|number>} path The path of the nested property
- * @param {Object} obj The object to test
- * @return {boolean}
- * @see {@link http://ramdajs.com/docs/#has|R.has}
- * @example
- *
- * RA.hasPath(['a', 'b'], { a: { b: 1 } }); //=> true
- * RA.hasPath(['a', 'b', 'c'], { a: { b: 1 } }); //=> false
- * RA.hasPath(['a', 'b'], { a: { } }); //=> false
- * RA.hasPath([0], [1, 2]); //=> true
- */
-var hasPath = (0, _ramda.curryN)(2, function (objPath, obj) {
-  var prop = (0, _ramda.head)(objPath); // termination conditions
-
-  if ((0, _ramda.length)(objPath) === 0 || !(0, _isObj["default"])(obj)) {
-    return false;
-  }
-
-  if ((0, _ramda.length)(objPath) === 1) {
-    return (0, _ramda.has)(prop, obj);
-  }
-
-  return hasPath((0, _ramda.tail)(objPath), (0, _ramda.path)([prop], obj)); // base case
-});
-var _default = hasPath;
-exports["default"] = _default;

package/lib/mergeRight.js

@@ -1,32 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports["default"] = void 0;
-
-var _ramda = require("ramda");
-
-/**
- * Create a new object with the own properties of the second object merged with
- * the own properties of the first object. If a key exists in both objects,
- * the value from the first object will be used. *
- * Putting it simply: it sets properties only if they don't exist.
- *
- * @func mergeRight
- * @deprecated since v2.12.0; available in ramda@0.26.0 as R.mergeLeft
- * @aliases mergeLeft, resetToDefault
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.6.0|v1.6.0}
- * @category Object
- * @sig {k: v} -> {k: v} -> {k: v}
- * @param {Object} r Destination
- * @param {Object} l Source
- * @return {Object}
- * @see {@link http://ramdajs.com/docs/#merge|R.merge}, {@link https://github.com/ramda/ramda/wiki/Cookbook#set-properties-only-if-they-dont-exist|Ramda Cookbook}
- * @example
- *
- * RA.mergeRight({ 'age': 40 }, { 'name': 'fred', 'age': 10 });
- * //=> { 'name': 'fred', 'age': 40 }
- */
-var mergeRight = (0, _ramda.flip)(_ramda.merge);
-var _default = mergeRight;
-exports["default"] = _default;

package/lib/thenP.js

@@ -1,34 +0,0 @@
-"use strict";
-
-exports.__esModule = true;
-exports["default"] = void 0;
-
-var _ramda = require("ramda");
-
-/**
- * Composable shortcut for `Promise.then`.
- * The thenP function returns a Promise. It takes two arguments: a callback function for the success of the Promise
- * and the promise instance itself.
- *
- * @func thenP
- * @memberOf RA
- * @aliases then
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @deprecated since v2.12.0; available in ramda@0.26.0 as R.then
- * @category Function
- * @sig (a -> Promise b | b) -> Promise b
- * @param {Function} onFulfilled A Function called if the Promise is fulfilled. This function has one argument, the fulfillment value
- * @param {Promise} promise Any Promise or Thenable object
- * @return {Promise} A Promise in the pending status
-
- * @see {@link RA.resolveP|resolveP}, {@link RA.rejectP|rejectP}, {@link RA.allP|allP}
- * @example
- *
- * const promise = Promise.resolve(1);
- * const add1 = v => v + 1;
- *
- * RA.thenP(add1, promise); // => Promise(2)
- */
-var thenP = (0, _ramda.invoker)(1, 'then');
-var _default = thenP;
-exports["default"] = _default;

package/src/contained.js

@@ -1,30 +0,0 @@
-import { flip, contains } from 'ramda';
-
-/**
- * Returns true if the specified value is equal, in R.equals terms,
- * to at least one element of the given list or false otherwise.
- * Given list can be a string.
- *
- * Like {@link http://ramdajs.com/docs/#contains|R.contains} but with argument order reversed.
- *
- * @func contained
- * @aliases included
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @deprecated since v2.12.0; please use RA.included alias
- * @category List
- * @sig [a] -> a -> Boolean
- * @param {Array|String} list The list to consider
- * @param {*} a The item to compare against
- * @return {boolean} Returns Boolean `true` if an equivalent item is in the list or `false` otherwise
- * @see {@link http://ramdajs.com/docs/#contains|R.contains}
- * @example
- *
- * RA.contained([1, 2, 3], 3); //=> true
- * RA.contained([1, 2, 3], 4); //=> false
- * RA.contained([{ name: 'Fred' }], { name: 'Fred' }); //=> true
- * RA.contained([[42]], [42]); //=> true
- */
-const contained = flip(contains);
-
-export default contained;

package/src/hasPath.js

@@ -1,40 +0,0 @@
-import { length, has, path, head, tail, curryN } from 'ramda';
-
-import isObj from './isObj';
-
-/**
- * Returns whether or not an object has an own property with the specified name at a given path.
- *
- * @func hasPath
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.14.0|v1.14.0}
- * @deprecated since v2.12.0; ramda@0.26.0 contains hasPath
- * @category Object
- * @typedef Idx = String | Int
- * @sig [Idx] -> {a} -> Boolean
- * @param {Array.<string|number>} path The path of the nested property
- * @param {Object} obj The object to test
- * @return {boolean}
- * @see {@link http://ramdajs.com/docs/#has|R.has}
- * @example
- *
- * RA.hasPath(['a', 'b'], { a: { b: 1 } }); //=> true
- * RA.hasPath(['a', 'b', 'c'], { a: { b: 1 } }); //=> false
- * RA.hasPath(['a', 'b'], { a: { } }); //=> false
- * RA.hasPath([0], [1, 2]); //=> true
- */
-const hasPath = curryN(2, (objPath, obj) => {
-  const prop = head(objPath);
-
-  // termination conditions
-  if (length(objPath) === 0 || !isObj(obj)) {
-    return false;
-  }
-  if (length(objPath) === 1) {
-    return has(prop, obj);
-  }
-
-  return hasPath(tail(objPath), path([prop], obj)); // base case
-});
-
-export default hasPath;

package/src/mergeRight.js

@@ -1,27 +0,0 @@
-import { merge, flip } from 'ramda';
-
-/**
- * Create a new object with the own properties of the second object merged with
- * the own properties of the first object. If a key exists in both objects,
- * the value from the first object will be used. *
- * Putting it simply: it sets properties only if they don't exist.
- *
- * @func mergeRight
- * @deprecated since v2.12.0; available in ramda@0.26.0 as R.mergeLeft
- * @aliases mergeLeft, resetToDefault
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.6.0|v1.6.0}
- * @category Object
- * @sig {k: v} -> {k: v} -> {k: v}
- * @param {Object} r Destination
- * @param {Object} l Source
- * @return {Object}
- * @see {@link http://ramdajs.com/docs/#merge|R.merge}, {@link https://github.com/ramda/ramda/wiki/Cookbook#set-properties-only-if-they-dont-exist|Ramda Cookbook}
- * @example
- *
- * RA.mergeRight({ 'age': 40 }, { 'name': 'fred', 'age': 10 });
- * //=> { 'name': 'fred', 'age': 40 }
- */
-const mergeRight = flip(merge);
-
-export default mergeRight;

package/src/thenP.js

@@ -1,29 +0,0 @@
-import { invoker } from 'ramda';
-
-/**
- * Composable shortcut for `Promise.then`.
- * The thenP function returns a Promise. It takes two arguments: a callback function for the success of the Promise
- * and the promise instance itself.
- *
- * @func thenP
- * @memberOf RA
- * @aliases then
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @deprecated since v2.12.0; available in ramda@0.26.0 as R.then
- * @category Function
- * @sig (a -> Promise b | b) -> Promise b
- * @param {Function} onFulfilled A Function called if the Promise is fulfilled. This function has one argument, the fulfillment value
- * @param {Promise} promise Any Promise or Thenable object
- * @return {Promise} A Promise in the pending status
-
- * @see {@link RA.resolveP|resolveP}, {@link RA.rejectP|rejectP}, {@link RA.allP|allP}
- * @example
- *
- * const promise = Promise.resolve(1);
- * const add1 = v => v + 1;
- *
- * RA.thenP(add1, promise); // => Promise(2)
- */
-const thenP = invoker(1, 'then');
-
-export default thenP;