ramda-adjunct 5.0.0 → 5.0.1

package/src/isSafeInteger.js

@@ -1,40 +0,0 @@
-import { bind, curryN } from 'ramda';
-
-import isFunction from './isFunction.js';
-import ponyfill from './internal/ponyfills/Number.isSafeInteger.js';
-
-export const isSafeIntegerPonyfill = curryN(1, ponyfill);
-
-/**
- * Checks whether the passed value is a safe `integer`.
- *
- * @func isSafeInteger
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @example
- *
- * RA.isSafeInteger(3); //=> true
- * RA.isSafeInteger(Math.pow(2, 53)) //=> false
- * RA.isSafeInteger(Math.pow(2, 53) - 1); //=> true
- * RA.isSafeInteger(NaN); //=> false
- * RA.isSafeInteger(Infinity); //=> false
- * RA.isSafeInteger('3') //=> false
- * RA.isSafeInteger(3.1); //=> false
- * RA.isSafeInteger(3.0); //=> true
- * RA.isSafeInteger('string'); //=> false
- * RA.isSafeInteger(null); //=> false
- * RA.isSafeInteger(undefined); //=> false
- * RA.isSafeInteger({}); //=> false
- * RA.isSafeInteger(() => { }); //=> false
- * RA.isSafeInteger(true); //=> false
- */
-
-const isSafeInteger = isFunction(Number.isSafeInteger)
-  ? curryN(1, bind(Number.isSafeInteger, Number))
-  : isSafeIntegerPonyfill;
-
-export default isSafeInteger;

package/src/isSentinelValue.js

@@ -1,26 +0,0 @@
-import { curryN } from 'ramda';
-
-import isInteger32 from './isInteger32.js';
-
-/**
- * Checks whether the passed value is {@link https://github.com/getify/You-Dont-Know-JS/blob/9959fc904d584bbf0b02cf41c192f74ff4238581/types-grammar/ch4.md#the-curious-case-of-the-|a sentinel value}.
- *
- * @func isSentinelValue
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.33.0|v2.33.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @example
- *
- * RA.isSentinelValue(-1); //=> true
- *
- * RA.isSentinelValue('-1'); //=> false
- * RA.isSentinelValue(1); //=> false
- * RA.isSentinelValue([-1]); //=> false
- */
-// eslint-disable-next-line no-bitwise
-const isSentinelValue = curryN(1, (val) => isInteger32(val) && ~val === 0);
-
-export default isSentinelValue;

package/src/isSet.js

@@ -1,24 +0,0 @@
-import { type, identical, pipe, curryN } from 'ramda';
-
-/**
- * Predicate for determining if a provided value is an instance of a Set.
- *
- * @func isSet
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isMap|isMap}}
- * @example
- *
- * RA.isSet(new Map()); //=> false
- * RA.isSet(new Set()); //=> true
- * RA.isSet(new Set([1,2]); //=> true
- * RA.isSet(new Object()); //=> false
- */
-
-const isSet = curryN(1, pipe(type, identical('Set')));
-
-export default isSet;

package/src/isSparseArray.js

@@ -1,43 +0,0 @@
-import {
-  values,
-  both,
-  complement,
-  pipe,
-  converge,
-  identical,
-  length,
-} from 'ramda';
-
-import isArray from './isArray.js';
-
-/**
- * Checks if input value is a sparse Array.
- * An array with at least one "empty slot" in it is often called a "sparse array."
- * Empty slot doesn't mean that the slot contains `null` or `undefined` values,
- * but rather that the slots don't exist.
- *
- * @func isSparseArray
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.20.0|v2.20.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} list The list to test
- * @return {boolean}
- * @see {@link https://github.com/getify/You-Dont-Know-JS/blob/f0d591b6502c080b92e18fc470432af8144db610/types%20%26%20grammar/ch3.md#array|Sparse Arrays}, {@link RA.isArray|isArray}
- * @example
- *
- * RA.isSparseArray(new Array(3)); // => true
- * RA.isSparseArray([1,,3]); // => true
- *
- * const list = [1, 2, 3];
- * delete list[1];
- * RA.isSparseArray(list); // => true
- *
- * RA.isSparseArray([1, 2, 3]); // => false
- */
-const isSparseArray = both(
-  isArray,
-  converge(complement(identical), [pipe(values, length), length])
-);
-
-export default isSparseArray;

package/src/isString.js

@@ -1,21 +0,0 @@
-import { curryN, pipe, type, identical } from 'ramda';
-
-/**
- * Checks if input value is `String`.
- *
- * @func isString
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/0.4.0|v0.4.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isNotString|isNotString}
- * @example
- *
- * RA.isString('abc'); //=> true
- * RA.isString(1); //=> false
- */
-const isString = curryN(1, pipe(type, identical('String')));
-
-export default isString;

package/src/isSymbol.js

@@ -1,29 +0,0 @@
-import { type, curryN } from 'ramda';
-
-/**
- * Checks if input value is a Symbol.
- *
- * @func isSymbol
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol|MDN Symbol}
- * @example
- *
- * RA.isSymbol(Symbol('1')); //=> true
- * RA.isSymbol(Symbol(1)); //=> true
- * RA.isSymbol('string'); //=> false
- * RA.isSymbol(undefined); //=> false
- * RA.isSymbol(null); //=> false
- */
-const isSymbol = curryN(
-  1,
-  (val) =>
-    typeof val === 'symbol' ||
-    (typeof val === 'object' && type(val) === 'Symbol')
-);
-
-export default isSymbol;

package/src/isThenable.js

@@ -1,28 +0,0 @@
-import { pathSatisfies } from 'ramda';
-
-import isFunction from './isFunction.js';
-
-/**
- * Checks if input value is a `thenable`.
- * `thenable` is an object or function that defines a `then` method.
- *
- * @func isThenable
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.1.0|v2.1.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isPromise|isPromise}
- * @example
- *
- * RA.isThenable(null); // => false
- * RA.isThenable(undefined); // => false
- * RA.isThenable([]); // => false
- * RA.isThenable(Promise.resolve()); // => true
- * RA.isThenable(Promise.reject()); // => true
- * RA.isThenable({ then: () => 1 }); // => true
- */
-const isThenable = pathSatisfies(isFunction, ['then']);
-
-export default isThenable;

package/src/isTrue.js

@@ -1,27 +0,0 @@
-import { identical, curryN } from 'ramda';
-
-/**
- * Checks if input value is the Boolean primitive `true`. Will return false for Boolean objects
- * created using the `Boolean` function as a constructor.
- *
- * @func isTrue
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.6.0|v2.6.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isFalse|isFalse}, {@link RA.isTruthy|isTruthy}, {@link RA.isFalsy|isFalsy}
- * @example
- *
- * RA.isTrue(true); // => true
- * RA.isTrue(Boolean(true)); // => true
- * RA.isTrue(false); // => false
- * RA.isTrue(1); // => false
- * RA.isTrue('true'); // => false
- * RA.isTrue(new Boolean(true)); // => false
- */
-
-const isTrue = curryN(1, identical(true));
-
-export default isTrue;

package/src/isTruthy.js

@@ -1,28 +0,0 @@
-import { curryN } from 'ramda';
-
-/**
- * In JavaScript, a `truthy` value is a value that is considered true
- * when evaluated in a Boolean context. All values are truthy unless
- * they are defined as falsy (i.e., except for `false`, `0`, `""`, `null`, `undefined`, and `NaN`).
- *
- * @func isTruthy
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.2.0|v2.2.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link https://developer.mozilla.org/en-US/docs/Glossary/Truthy|truthy}, {@link RA.isFalsy|isFalsy}
- * @example
- *
- * RA.isTruthy({}); // => true
- * RA.isTruthy([]); // => true
- * RA.isTruthy(42); // => true
- * RA.isTruthy(3.14); // => true
- * RA.isTruthy('foo'); // => true
- * RA.isTruthy(new Date()); // => true
- * RA.isTruthy(Infinity); // => true
- */
-const isTruthy = curryN(1, Boolean);
-
-export default isTruthy;

package/src/isUinteger32.js

@@ -1,29 +0,0 @@
-import { curryN } from 'ramda';
-
-import toUinteger32 from './toUinteger32.js';
-
-/**
- * Checks whether the passed value is an unsigned 32 bit integer.
- *
- * @func isUinteger32
- * @aliases isUint32
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/3.2.0|v3.2.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.toUinteger32|toUinteger32}
- * @example
- *
- * RA.isUinteger32(0); //=> true
- * RA.isUinteger32(2 ** 32 - 1); //=> true
- *
- * RA.isUinteger32(Infinity); //=> false
- * RA.isUinteger32(NaN); //=> false
- * RA.isUinteger32(-1); //=> false
- * RA.isUinteger32(2 ** 32); //=> false
- */
-const isUinteger32 = curryN(1, (val) => toUinteger32(val) === val);
-
-export default isUinteger32;

package/src/isUndefined.js

@@ -1,24 +0,0 @@
-import { equals } from 'ramda';
-
-import stubUndefined from './stubUndefined.js';
-
-/**
- * Checks if input value is `undefined`.
- *
- * @func isUndefined
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/0.0.1|v0.0.1}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isNotUndefined|isNotUndefined}
- * @example
- *
- * RA.isUndefined(1); //=> false
- * RA.isUndefined(undefined); //=> true
- * RA.isUndefined(null); //=> false
- */
-const isUndefined = equals(stubUndefined());
-
-export default isUndefined;

package/src/isValidDate.js

@@ -1,29 +0,0 @@
-import { invoker, both, pipe, curryN } from 'ramda';
-
-import isDate from './isDate.js';
-import isNotNaN from './isNotNaN.js';
-
-/* eslint-disable max-len */
-/**
- * Checks if value is valid `Date` object.
- *
- * @func isValidDate
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.8.0|v1.8.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isDate|isDate}, {@link RA.isNotDate|isNotDate}, {@link RA.isNotValidDate|isNotValidDate}
- * @example
- *
- * RA.isValidDate(new Date()); //=> true
- * RA.isValidDate(new Date('a')); //=> false
- */
-/* eslint-enable max-len */
-const isValidDate = curryN(
-  1,
-  both(isDate, pipe(invoker(0, 'getTime'), isNotNaN))
-);
-
-export default isValidDate;

package/src/isValidNumber.js

@@ -1,28 +0,0 @@
-import { either, curryN } from 'ramda';
-
-import isFloat from './isFloat.js';
-import isInteger from './isInteger.js';
-
-/**
- * Checks if value is a valid `Number`. A valid `Number` is a number that is not `NaN`, `Infinity`
- * or `-Infinity`.
- *
- * @func isValidNumber
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.2.0|v2.2.0}
- * @category Type
- * @sig * -> Boolean
- * @param {*} val The value to test
- * @return {boolean}
- * @see {@link RA.isNotValidNumber|isNotValidNumber}
- * @example
- *
- * RA.isValidNumber(1); //=> true
- * RA.isValidNumber(''); //=> false
- * RA.isValidNumber(NaN); //=> false
- * RA.isValidNumber(Infinity); //=> false
- * RA.isValidNumber(-Infinity); //=> false
- */
-const isValidNumber = curryN(1, either(isInteger, isFloat));
-
-export default isValidNumber;

package/src/lastP.js

@@ -1,54 +0,0 @@
-import { bind, last, map, curryN } from 'ramda';
-
-import allP from './allP.js';
-import lengthEq from './lengthEq.js';
-import lengthGte from './lengthGte.js';
-import rejectP from './rejectP.js';
-import resolveP from './resolveP.js';
-
-/**
- * Returns a promise that is fulfilled by the last given promise to be fulfilled,
- * or rejected with an array of rejection reasons if all of the given promises are rejected.
- *
- * @func lastP
- * @memberOf RA
- * @category Function
- * @since {@link https://char0n.github.io/ramda-adjunct/2.23.0|v2.23.0}
- * @sig [Promise a] -> Promise a
- * @param {Iterable.<*>} iterable An iterable object such as an Array or String
- * @return {Promise} A promise that is fulfilled by the last given promise to be fulfilled, or rejected with an array of rejection reasons if all of the given promises are rejected.
- * @see {@link RA.anyP|anyP}
- * @example
- *
- * const delayP = timeout => new Promise(resolve => setTimeout(() => resolve(timeout), timeout));
- * delayP.reject = timeout => new Promise((resolve, reject) => setTimeout(() => reject(timeout), timeout));
- * RA.lastP([
- *   1,
- *   delayP(10),
- *   delayP(100),
- *   delayP.reject(1000),
- * ]); //=> Promise(100)
- */
-const lastP = curryN(1, (iterable) => {
-  const fulfilled = [];
-  const rejected = [];
-  const onFulfill = bind(fulfilled.push, fulfilled);
-  const onReject = bind(rejected.push, rejected);
-
-  const listOfPromises = map(
-    (p) => resolveP(p).then(onFulfill).catch(onReject),
-    [...iterable]
-  );
-
-  return allP(listOfPromises).then(() => {
-    if (lengthEq(0, fulfilled) && lengthEq(0, rejected)) {
-      return undefined;
-    }
-    if (lengthGte(1, fulfilled)) {
-      return last(fulfilled);
-    }
-    return rejectP(rejected);
-  });
-});
-
-export default lastP;

package/src/lengthEq.js

@@ -1,24 +0,0 @@
-import { equals } from 'ramda';
-
-import compareLength from './internal/compareLength.js';
-
-/**
- * Returns `true` if the supplied list or string has a length equal to `valueLength`.
- *
- * @func lengthEq
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @category List
- * @sig Number -> [*] -> Boolean
- * @param {number} valueLength The length of the list or string
- * @param {Array|string} value The list or string
- * @return {boolean}
- * @see {@link RA.lengthNotEq|lengthNotEq}, {@link RA.lengthLt|lengthLt}, {@link RA.lengthGt|lengthGt}, {@link RA.lengthLte|lengthLte}, {@link RA.lengthGte|lengthGte},, {@link http://ramdajs.com/docs/#equals|equals}, {@link http://ramdajs.com/docs/#length|length}
- * @example
- *
- * RA.lengthEq(3, [1,2,3]); //=> true
- * RA.lengthEq(3, [1,2,3,4]); //=> false
- */
-const lengthEq = compareLength(equals);
-
-export default lengthEq;

package/src/lengthGt.js

@@ -1,24 +0,0 @@
-import { flip, gt } from 'ramda';
-
-import compareLength from './internal/compareLength.js';
-
-/**
- * Returns `true` if the supplied list or string has a length greater than `valueLength`.
- *
- * @func lengthGt
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @category List
- * @sig Number -> [*] -> Boolean
- * @param {number} valueLength The length of the list or string
- * @param {Array|string} value The list or string
- * @return {boolean}
- * @see {@link RA.lengthEq|lengthEq}, {@link RA.lengthNotEq|lengthNotEq}, {@link RA.lengthLt|lengthLt}, {@link RA.lengthLte|lengthLte}, {@link RA.lengthGte|lengthGte}, {@link http://ramdajs.com/docs/#gt|gt},  {@link http://ramdajs.com/docs/#length|length}
- * @example
- *
- * RA.lengthGt(3, [1,2,3,4]); //=> true
- * RA.lengthGt(3, [1,2,3]); //=> false
- */
-const lengthGt = compareLength(flip(gt));
-
-export default lengthGt;

package/src/lengthGte.js

@@ -1,26 +0,0 @@
-import { flip, gte } from 'ramda';
-
-import compareLength from './internal/compareLength.js';
-
-/**
- * Returns `true` if the supplied list or string has a length greater than or equal to
- * `valueLength`.
- *
- * @func lengthGte
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @category List
- * @sig Number -> [*] -> Boolean
- * @param {number} valueLength The length of the list or string
- * @param {Array|string} value The list or string
- * @return {boolean}
- * @see {@link RA.lengthEq|lengthEq}, {@link RA.lengthNotEq|lengthNotEq}, {@link RA.lengthLt|lengthLt}, {@link RA.lengthGt|lengthGt}, {@link RA.lengthLte|lengthLte}, {@link http://ramdajs.com/docs/#gte|gte}, {@link http://ramdajs.com/docs/#length|length}
- * @example
- *
- * RA.lengthGte(3, [1,2,3,4]); //=> true
- * RA.lengthGte(3, [1,2,3]); //=> true
- * RA.lengthGte(3, [1,2]); //=> false
- */
-const lengthGte = compareLength(flip(gte));
-
-export default lengthGte;

package/src/lengthLt.js

@@ -1,24 +0,0 @@
-import { flip, lt } from 'ramda';
-
-import compareLength from './internal/compareLength.js';
-
-/**
- * Returns `true` if the supplied list or string has a length less than `valueLength`.
- *
- * @func lengthLt
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @category List
- * @sig Number -> [*] -> Boolean
- * @param {number} valueLength The length of the list or string
- * @param {Array|string} value The list or string
- * @return {boolean}
- * @see {@link RA.lengthEq|lengthEq}, {@link RA.lengthNotEq|lengthNotEq}, {@link RA.lengthGt|lengthGt}, {@link RA.lengthLte|lengthLte}, {@link RA.lengthGte|lengthGte}, {@link http://ramdajs.com/docs/#lt|lt}, {@link http://ramdajs.com/docs/#length|length}
- * @example
- *
- * RA.lengthLt(3, [1,2]); //=> true
- * RA.lengthLt(3, [1,2,3]); //=> false
- */
-const lengthLt = compareLength(flip(lt));
-
-export default lengthLt;

package/src/lengthLte.js

@@ -1,25 +0,0 @@
-import { flip, lte } from 'ramda';
-
-import compareLength from './internal/compareLength.js';
-
-/**
- * Returns `true` if the supplied list or string has a length less than or equal to `valueLength`.
- *
- * @func lengthLte
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @category List
- * @sig Number -> [*] -> Boolean
- * @param {number} valueLength The length of the list or string
- * @param {Array|string} value The list or string
- * @return {boolean}
- * @see {@link RA.lengthEq|lengthEq}, {@link RA.lengthNotEq|lengthNotEq}, {@link RA.lengthLt|lengthLt}, {@link RA.lengthGt|lengthGt}, {@link RA.lengthGte|lengthGte}, {@link http://ramdajs.com/docs/#lte|lte}, {@link http://ramdajs.com/docs/#length|length}
- * @example
- *
- * RA.lengthLte(3, [1,2]); //=> true
- * RA.lengthLte(3, [1,2,3]); //=> true
- * RA.lengthLte(3, [1,2,3,4]); //=> false
- */
-const lengthLte = compareLength(flip(lte));
-
-export default lengthLte;

package/src/lengthNotEq.js

@@ -1,24 +0,0 @@
-import { complement, equals } from 'ramda';
-
-import compareLength from './internal/compareLength.js';
-
-/**
- * Returns `true` if the supplied list or string has a length not equal to `valueLength`.
- *
- * @func lengthNotEq
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/2.8.0|v2.8.0}
- * @category List
- * @sig Number -> [*] -> Boolean
- * @param {number} valueLength The length of the list or string
- * @param {Array|string} value The list or string
- * @return {boolean}
- * @see {@link RA.lengthEq|lengthEq}, {@link RA.lengthLt|lengthLt}, {@link RA.lengthGt|lengthGt}, {@link RA.lengthLte|lengthLte}, {@link RA.lengthGte|lengthGte}, {@link http://ramdajs.com/docs/#equals|equals}, {@link http://ramdajs.com/docs/#length|length}
- * @example
- *
- * RA.lengthNotEq(3, [1,2,3,4]); //=> true
- * RA.lengthNotEq(3, [1,2,3]); //=> false
- */
-const lengthNotEq = compareLength(complement(equals));
-
-export default lengthNotEq;

package/src/lensEq.js

@@ -1,28 +0,0 @@
-import { view, curryN, equals, pipe } from 'ramda';
-
-/**
- * Returns `true` if data structure focused by the given lens equals provided value.
- *
- * @func lensEq
- * @memberOf RA
- * @since {@link https://char0n.github.io/ramda-adjunct/1.13.0|1.13.0}
- * @category Relation
- * @typedef Lens s a = Functor f => (a -> f a) -> s -> f s
- * @sig  Lens s a -> b -> s -> Boolean
- * @see {@link RA.lensNotEq|lensNotEq}
- * @param {function} lens Van Laarhoven lens
- * @param {*} value The value to compare the focused data structure with
- * @param {*} data The data structure
- * @return {boolean} `true` if the focused data structure equals value, `false` otherwise
- *
- * @example
- *
- * RA.lensEq(R.lensIndex(0), 1, [0, 1, 2]); // => false
- * RA.lensEq(R.lensIndex(1), 1, [0, 1, 2]); // => true
- * RA.lensEq(R.lensPath(['a', 'b']), 'foo', { a: { b: 'foo' } }) // => true
- */
-const lensEq = curryN(3, (lens, val, data) =>
-  pipe(view(lens), equals(val))(data)
-);
-
-export default lensEq;