@valkyriestudios/utils 9.0.0 → 11.0.0

package/src/number/isIntegerBetween.mjs

@@ -1,13 +0,0 @@
-'use strict';
-
-//  Check if a number is an integer between a range
-export default function isIntegerBetween (val, min, max) {
-    if (
-        !Number.isInteger(val) ||
-        !Number.isFinite(min) ||
-        !Number.isFinite(max) ||
-        min >= max
-    ) return false;
-
-    return val >= min && val <= max;
-}

package/src/number/isNumericalNaN.mjs

@@ -1,5 +0,0 @@
-'use strict';
-
-export default function isNumericalNaN (val) {
-    return Number.isNaN(val) || val === Infinity;
-}

package/src/number/randomBetween.mjs

@@ -1,11 +0,0 @@
-'use strict';
-
-//  Generate random between min and max
-export default function randomBetween (min = 0, max = 10) {
-    if (
-        !Number.isFinite(min) ||
-        !Number.isFinite(max)
-    ) throw new TypeError('Min/Max should be numeric');
-
-    return (Math.random() * (max - min)) + min;
-}

package/src/number/randomIntBetween.mjs

@@ -1,11 +0,0 @@
-'use strict';
-
-//  Generate random between min and max (max not inclusive)
-export default function randomIntBetween (min = 0, max = 10) {
-    if (
-        !Number.isFinite(min) ||
-        !Number.isFinite(max)
-    ) throw new TypeError('Min/Max should be numeric');
-
-    return Math.floor((Math.random() * (max - min)) + min);
-}

package/src/number/round.mjs

@@ -1,10 +0,0 @@
-'use strict';
-
-//  Round a numeric value to a certain precision
-export default function round (val, precision = 0) {
-    if (!Number.isFinite(val)) throw new TypeError('Value should be numeric');
-
-    const exp = Math.pow(10, Number.isInteger(precision) && precision > 0 ? precision : 0);
-    const num = (val * exp) * (1 + Number.EPSILON);
-    return Math.round(num)/exp;
-}

package/src/number/toPercentage.mjs

@@ -1,14 +0,0 @@
-'use strict';
-
-import round from './round.mjs';
-
-//  Convert a float value to a percentage
-export default function toPercentage (val, precision = 0, min = 0, max = 1) {
-    if (
-        !Number.isFinite(val) ||
-        !Number.isFinite(min) ||
-        !Number.isFinite(max)
-    ) throw new TypeError('value/min/max should be numeric');
-
-    return round(((val - min)/ (max - min)) * 100, precision);
-}

package/src/object/define.mjs

@@ -1,12 +0,0 @@
-'use strict';
-
-import {PROTO_OBJ} from './is.mjs';
-
-export default function define (props, obj = {}) {
-    if (
-        Object.prototype.toString.call(props) !== PROTO_OBJ ||
-        Object.prototype.toString.call(obj) !== PROTO_OBJ
-    ) throw new TypeError('Please pass an object as the value for props and obj');
-
-    return Object.defineProperties(obj, props);
-}

package/src/object/is.mjs

@@ -1,7 +0,0 @@
-'use strict';
-
-export const PROTO_OBJ = '[object Object]';
-
-export default function isObject (val) {
-    return Object.prototype.toString.call(val) === PROTO_OBJ;
-}

package/src/object/isNotEmpty.mjs

@@ -1,7 +0,0 @@
-'use strict';
-
-import {PROTO_OBJ} from './is.mjs';
-
-export default function isNotEmptyObject (val) {
-    return Object.prototype.toString.call(val) === PROTO_OBJ && Object.keys(val).length > 0;
-}

package/src/object/merge.mjs

@@ -1,27 +0,0 @@
-'use strict';
-
-import {PROTO_OBJ} from './is.mjs';
-
-const merge = (target, source = {}) => {
-    if (
-        Object.prototype.toString.call(target) !== PROTO_OBJ ||
-        Object.prototype.toString.call(source) !== PROTO_OBJ
-    ) throw new TypeError('Please pass a target and object to merge');
-
-    return Object.keys(target).reduce((acc, key) => {
-        if (
-            Object.prototype.toString.call(target[key]) === PROTO_OBJ &&
-            !Array.isArray(target[key])
-        ) {
-            acc[key] = merge(target[key], source[key] || {});
-        } else {
-            acc[key] = Object.prototype.hasOwnProperty.call(source, key)
-                ? source[key]
-                : target[key];
-        }
-        return acc;
-    }, {});
-};
-
-
-export default merge;

package/src/object/pick.mjs

@@ -1,33 +0,0 @@
-'use strict';
-
-import deepGet          from '../deep/get.mjs';
-import deepSet          from '../deep/set.mjs';
-import isNotEmptyString from '../string/isNotEmpty.mjs';
-import {PROTO_OBJ}      from './is.mjs';
-
-export default function pick (obj, keys) {
-    if (
-        Object.prototype.toString.call(obj) !== PROTO_OBJ ||
-        !Array.isArray(keys) ||
-        keys.length === 0
-    ) throw new TypeError('Please pass an object to pick from and a keys array');
-
-    const map = {};
-    let key_deep = false;
-    let val;
-    for (const key of keys) {
-        if (!isNotEmptyString(key)) continue;
-        key_deep = key.match(/(\.|\[)/g);
-        val = key_deep
-            ? deepGet(obj, key.trim())
-            : obj[key.trim()];
-        if (val === undefined) continue;
-
-        if (key_deep) {
-            deepSet(map, key.trim(), val);
-        } else {
-            map[key.trim()] = val;
-        }
-    }
-    return map;
-}

package/src/regexp/is.mjs

@@ -1,7 +0,0 @@
-'use strict';
-
-export const PROTO_RGX = '[object RegExp]';
-
-export default function isRegExp (val) {
-    return Object.prototype.toString.call(val) === PROTO_RGX;
-}

package/src/regexp/sanitize.mjs

@@ -1,12 +0,0 @@
-'use strict';
-
-import isNotEmptyString from '../string/isNotEmpty.mjs';
-
-//  Escapes a value to be used inside of a regular expression (eg: new RegExp(...))
-//  For more info: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#Escaping
-//
-//  @param string   val     Value to escape
-export default function sanitizeRegExp (val) {
-    if (!isNotEmptyString(val)) return false;
-    return val.trim().replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&');
-}

package/src/string/humanizeBytes.mjs

@@ -1,29 +0,0 @@
-'use strict';
-
-import isString         from '../string/is.mjs';
-import isNotEmptyString from '../string/isNotEmpty.mjs';
-import {PROTO_OBJ}      from '../object/is.mjs';
-import humanizeNumber   from './humanizeNumber.mjs';
-
-//  Humanize a numerical byte value into a readable file size
-//
-//  @param int  val     Amount of bytes
-export default function humanizeBytes (val, options = {}) {
-    const has_opts = Object.prototype.toString.call(options) === PROTO_OBJ;
-    return humanizeNumber(val, {
-        delim: has_opts && isString(options.delim)
-            ? options.delim
-            : ',',
-        separator: has_opts && isNotEmptyString(options.separator)
-            ? options.separator
-            : '.',
-        precision: has_opts && Number.isInteger(options.precision) && options.precision >= 0
-            ? options.precision
-            : 2,
-        units: has_opts && Array.isArray(options.units) && options.units.length > 0
-            ? options.units.filter(isNotEmptyString)
-            : [' bytes', ' KB', ' MB', ' GB', ' TB', ' PB', ' EB', ' ZB', ' YB'],
-        divider: 1024,
-        real: true,
-    });
-}

package/src/string/humanizeNumber.mjs

@@ -1,84 +0,0 @@
-'use strict';
-
-import isBoolean        from '../boolean/is.mjs';
-import isString         from '../string/is.mjs';
-import isNotEmptyString from '../string/isNotEmpty.mjs';
-import round            from '../number/round.mjs';
-import {PROTO_OBJ}      from '../object/is.mjs';
-
-//  Humanize a numerical value into a unit base
-//
-//  @param int  val     Amount of bytes
-export default function humanizeNumber (val, options = {}) {
-    const has_opts = Object.prototype.toString.call(options) === PROTO_OBJ;
-    const OPTS = {
-        delim: has_opts && isString(options.delim)
-            ? options.delim
-            : ',',
-        separator: has_opts && isNotEmptyString(options.separator)
-            ? options.separator
-            : '.',
-        precision: has_opts && Number.isInteger(options.precision) && options.precision >= 0
-            ? options.precision
-            : 2,
-        units: has_opts && ((Array.isArray(options.units) && options.units.length > 0) || options.units === false)
-            ? options.units ? options.units.filter(isString) : false
-            : ['', 'k', 'm', 'b', 't', 'q'],
-        //  Have to have at least bigger than 1 to not end in infinite loop
-        divider: has_opts && Number.isInteger(options.divider) && options.divider > 1
-            ? options.divider
-            : 1000,
-        //  Should we auto parse as integer (true) or not (false)
-        real: has_opts && isBoolean(options.real)
-            ? options.real
-            : false,
-    };
-
-    //  If not a valid value, return
-    if (!(Number.isFinite(val) || isNotEmptyString(val))) {
-        return `0${OPTS.units.length > 0 ? OPTS.units[0] : ''}`;
-    }
-
-    //  Ensure we are working with an integer
-    let normalized;
-    if (OPTS.real) {
-        normalized = parseInt(isString(val) ? val.trim() : val) || 0;
-    } else {
-        normalized = parseFloat(isString(val) ? val.trim() : val) || 0;
-    }
-    if (!Number.isFinite(normalized) || normalized === 0) {
-        return `0${OPTS.units.length > 0 ? OPTS.units[0] : ''}`;
-    }
-
-    //  Determine sign
-    const sign = normalized < 0 ? '-' : '';
-
-    //  Ensure val here is absolute
-    normalized = Math.abs(normalized);
-
-    //  At each step, divide by divider, based on that we get the unit size
-    let postfix = '';
-    if (OPTS.units) {
-        let unit_ix = 0;
-        while (normalized >= OPTS.divider) {
-            unit_ix++;
-            normalized = normalized/OPTS.divider;
-            if (unit_ix === OPTS.units.length - 1) break;
-        }
-        postfix = OPTS.units[unit_ix];
-    }
-
-    //  Round with precision
-    normalized = round(normalized, OPTS.precision);
-
-    //  Humanize from eg: 10023 to 10,023
-    normalized    = `${normalized}`.split('.');
-    normalized[0] = normalized[0].split('').reverse().map((char, ix, original) => {
-        if (ix > 0 && ix < original.length && ix % 3 === 0) return char + OPTS.delim;
-        return char;
-    }).reverse().join('');
-    normalized    = normalized.join(OPTS.separator);
-
-    //  Include a decimal point and a tenths-place digit if presenting less than then of KB or greater units
-    return `${sign}${normalized}${postfix}`;
-}

package/src/string/is.mjs

@@ -1,5 +0,0 @@
-'use strict';
-
-export default function isString (val) {
-    return typeof val === 'string' || val instanceof String;
-}

package/src/string/isBetween.mjs

@@ -1,18 +0,0 @@
-'use strict';
-
-import isString from './is.mjs';
-
-//  Check if a string is between a range in length
-export default function isStringBetween (val, min, max, trimmed = true) {
-    if (
-        !isString(val) ||
-        !Number.isFinite(min) ||
-        min < 0 ||
-        !Number.isFinite(max) ||
-        max < 0 ||
-        min >= max
-    ) return false;
-
-    const length = (trimmed === true ? val.trim() : val).length;
-    return length >= min && length <= max;
-}

package/src/string/isNotEmpty.mjs

@@ -1,6 +0,0 @@
-'use strict';
-
-export default function isNotEmptyString (val, trimmed = true) {
-    if (typeof val !== 'string' && !(val instanceof String)) return false;
-    return (trimmed === true ? val.trim() : val).length > 0;
-}

package/src/string/shorten.mjs

@@ -1,21 +0,0 @@
-'use strict';
-
-import isString 		from './is.mjs';
-import isNumberAbove    from '../number/isAbove.mjs';
-
-//  Shorten a string and add a postfix if it goes over a specific length, will autotrim value
-//
-//  @param string   val         Value to shorten, returns false a string is not passed
-//  @param int      length      Length to shorten it at
-//  @param string   postfix     (default='...') Postfix to use when shortened
-export default function shorten (val, length, postfix = '...') {
-    if (
-        !isString(val) ||
-        !isString(postfix) ||
-        !isNumberAbove(length, 0)
-    ) return false;
-
-    if (val.trim().length <= length) return val.trim();
-
-    return `${val.trim().substr(0, length)}${postfix}`;
-}

package/string/humanizeBytes.js

@@ -1,23 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: !0
-});
-exports["default"] = humanizeBytes;
-var _is = _interopRequireDefault(require("../string/is.js"));
-var _isNotEmpty = _interopRequireDefault(require("../string/isNotEmpty.js"));
-var _is2 = require("../object/is.js");
-var _humanizeNumber = _interopRequireDefault(require("./humanizeNumber.js"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function humanizeBytes(val) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var has_opts = Object.prototype.toString.call(options) === _is2.PROTO_OBJ;
-  return (0, _humanizeNumber["default"])(val, {
-    delim: has_opts && (0, _is["default"])(options.delim) ? options.delim : ',',
-    separator: has_opts && (0, _isNotEmpty["default"])(options.separator) ? options.separator : '.',
-    precision: has_opts && Number.isInteger(options.precision) && options.precision >= 0 ? options.precision : 2,
-    units: has_opts && Array.isArray(options.units) && options.units.length > 0 ? options.units.filter(_isNotEmpty["default"]) : [' bytes', ' KB', ' MB', ' GB', ' TB', ' PB', ' EB', ' ZB', ' YB'],
-    divider: 1024,
-    real: !0
-  });
-}

package/string/humanizeNumber.js

@@ -1,56 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: !0
-});
-exports["default"] = humanizeNumber;
-var _is = _interopRequireDefault(require("../boolean/is.js"));
-var _is2 = _interopRequireDefault(require("../string/is.js"));
-var _isNotEmpty = _interopRequireDefault(require("../string/isNotEmpty.js"));
-var _round = _interopRequireDefault(require("../number/round.js"));
-var _is3 = require("../object/is.js");
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function humanizeNumber(val) {
-  var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-  var has_opts = Object.prototype.toString.call(options) === _is3.PROTO_OBJ;
-  var OPTS = {
-    delim: has_opts && (0, _is2["default"])(options.delim) ? options.delim : ',',
-    separator: has_opts && (0, _isNotEmpty["default"])(options.separator) ? options.separator : '.',
-    precision: has_opts && Number.isInteger(options.precision) && options.precision >= 0 ? options.precision : 2,
-    units: has_opts && (Array.isArray(options.units) && options.units.length > 0 || options.units === !1) ? options.units ? options.units.filter(_is2["default"]) : !1 : ['', 'k', 'm', 'b', 't', 'q'],
-    divider: has_opts && Number.isInteger(options.divider) && options.divider > 1 ? options.divider : 1000,
-    real: has_opts && (0, _is["default"])(options.real) ? options.real : !1
-  };
-  if (!(Number.isFinite(val) || (0, _isNotEmpty["default"])(val))) {
-    return "0".concat(OPTS.units.length > 0 ? OPTS.units[0] : '');
-  }
-  var normalized;
-  if (OPTS.real) {
-    normalized = parseInt((0, _is2["default"])(val) ? val.trim() : val) || 0;
-  } else {
-    normalized = parseFloat((0, _is2["default"])(val) ? val.trim() : val) || 0;
-  }
-  if (!Number.isFinite(normalized) || normalized === 0) {
-    return "0".concat(OPTS.units.length > 0 ? OPTS.units[0] : '');
-  }
-  var sign = normalized < 0 ? '-' : '';
-  normalized = Math.abs(normalized);
-  var postfix = '';
-  if (OPTS.units) {
-    var unit_ix = 0;
-    while (normalized >= OPTS.divider) {
-      unit_ix++;
-      normalized = normalized / OPTS.divider;
-      if (unit_ix === OPTS.units.length - 1) break;
-    }
-    postfix = OPTS.units[unit_ix];
-  }
-  normalized = (0, _round["default"])(normalized, OPTS.precision);
-  normalized = "".concat(normalized).split('.');
-  normalized[0] = normalized[0].split('').reverse().map(function (_char, ix, original) {
-    if (ix > 0 && ix < original.length && ix % 3 === 0) return _char + OPTS.delim;
-    return _char;
-  }).reverse().join('');
-  normalized = normalized.join(OPTS.separator);
-  return "".concat(sign).concat(normalized).concat(postfix);
-}

package/string/is.js

@@ -1,9 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: !0
-});
-exports["default"] = isString;
-function isString(val) {
-  return typeof val === 'string' || val instanceof String;
-}

package/string/isBetween.js

@@ -1,14 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: !0
-});
-exports["default"] = isStringBetween;
-var _is = _interopRequireDefault(require("./is.js"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function isStringBetween(val, min, max) {
-  var trimmed = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : !0;
-  if (!(0, _is["default"])(val) || !Number.isFinite(min) || min < 0 || !Number.isFinite(max) || max < 0 || min >= max) return !1;
-  var length = (trimmed === !0 ? val.trim() : val).length;
-  return length >= min && length <= max;
-}

package/string/isNotEmpty.js

@@ -1,11 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: !0
-});
-exports["default"] = isNotEmptyString;
-function isNotEmptyString(val) {
-  var trimmed = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : !0;
-  if (typeof val !== 'string' && !(val instanceof String)) return !1;
-  return (trimmed === !0 ? val.trim() : val).length > 0;
-}

package/string/shorten.js

@@ -1,15 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, "__esModule", {
-  value: !0
-});
-exports["default"] = shorten;
-var _is = _interopRequireDefault(require("./is.js"));
-var _isAbove = _interopRequireDefault(require("../number/isAbove.js"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
-function shorten(val, length) {
-  var postfix = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : '...';
-  if (!(0, _is["default"])(val) || !(0, _is["default"])(postfix) || !(0, _isAbove["default"])(length, 0)) return !1;
-  if (val.trim().length <= length) return val.trim();
-  return "".concat(val.trim().substr(0, length)).concat(postfix);
-}