@koine/utils 1.0.26 → 1.0.29

package/is.js

@@ -1,376 +0,0 @@
-/**
- * @file
- *
- * Same as [is-what](https://github.com/mesqueeb/is-what) plus:
- *
- * - `isFormData`
- * - `isInt`
- * - `isFloat`
- */
-/**
- * Returns the object type of the given payload
- *
- * @param {*} payload
- * @returns {string}
- */
-export function getType(payload) {
-    return Object.prototype.toString.call(payload).slice(8, -1);
-}
-/**
- * Returns whether the payload is undefined
- *
- * @param {*} payload
- * @returns {payload is undefined}
- */
-export function isUndefined(payload) {
-    return getType(payload) === "Undefined";
-}
-/**
- * Returns whether the payload is null
- *
- * @param {*} payload
- * @returns {payload is null}
- */
-export function isNull(payload) {
-    return getType(payload) === "Null";
-}
-/**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isPlainObject(payload) {
-    if (getType(payload) !== "Object")
-        return false;
-    return (payload.constructor === Object &&
-        Object.getPrototypeOf(payload) === Object.prototype);
-}
-/**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isObject(payload) {
-    return isPlainObject(payload);
-}
-/**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is { [K in any]: never }}
- */
-export function isEmptyObject(payload) {
-    return isPlainObject(payload) && Object.keys(payload).length === 0;
-}
-/**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isFullObject(payload) {
-    return isPlainObject(payload) && Object.keys(payload).length > 0;
-}
-/**
- * Returns whether the payload is an any kind of object (including special classes or objects with different prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export function isAnyObject(payload) {
-    return getType(payload) === "Object";
-}
-/**
- * Returns whether the payload is an object like a type passed in < >
- *
- * Usage: isObjectLike<{id: any}>(payload) // will make sure it's an object and has an `id` prop.
- *
- * @template T this must be passed in < >
- * @param {*} payload
- * @returns {payload is T}
- */
-export function isObjectLike(payload) {
-    return isAnyObject(payload);
-}
-/**
- * Returns whether the payload is a function (regular or async)
- *
- * @param {*} payload
- * @returns {payload is AnyFunction}
- */
-export function isFunction(payload) {
-    return typeof payload === "function";
-}
-/**
- * Returns whether the payload is an array
- *
- * @param {any} payload
- * @returns {payload is any[]}
- */
-export function isArray(payload) {
-    return getType(payload) === "Array";
-}
-/**
- * Returns whether the payload is a an array with at least 1 item
- *
- * @param {*} payload
- * @returns {payload is any[]}
- */
-export function isFullArray(payload) {
-    return isArray(payload) && payload.length > 0;
-}
-/**
- * Returns whether the payload is a an empty array
- *
- * @param {*} payload
- * @returns {payload is []}
- */
-export function isEmptyArray(payload) {
-    return isArray(payload) && payload.length === 0;
-}
-/**
- * Returns whether the payload is a string
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export function isString(payload) {
-    return getType(payload) === "String";
-}
-/**
- * Returns whether the payload is a string, BUT returns false for ''
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export function isFullString(payload) {
-    return isString(payload) && payload !== "";
-}
-/**
- * Returns whether the payload is ''
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export function isEmptyString(payload) {
-    return payload === "";
-}
-/**
- * Returns whether the payload is a number (but not NaN)
- *
- * This will return `false` for `NaN`!!
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export function isNumber(payload) {
-    return getType(payload) === "Number" && !isNaN(payload);
-}
-/**
- * Returns whether the payload is a positive number (but not 0)
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export function isPositiveNumber(payload) {
-    return isNumber(payload) && payload > 0;
-}
-/**
- * Returns whether the payload is a negative number (but not 0)
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export function isNegativeNumber(payload) {
-    return isNumber(payload) && payload < 0;
-}
-/**
- * Returns whether the payload is a boolean
- *
- * @param {*} payload
- * @returns {payload is boolean}
- */
-export function isBoolean(payload) {
-    return getType(payload) === "Boolean";
-}
-/**
- * Returns whether the payload is a regular expression (RegExp)
- *
- * @param {*} payload
- * @returns {payload is RegExp}
- */
-export function isRegExp(payload) {
-    return getType(payload) === "RegExp";
-}
-/**
- * Returns whether the payload is a Map
- *
- * @param {*} payload
- * @returns {payload is Map<any, any>}
- */
-export function isMap(payload) {
-    return getType(payload) === "Map";
-}
-/**
- * Returns whether the payload is a WeakMap
- *
- * @param {*} payload
- * @returns {payload is WeakMap<any, any>}
- */
-export function isWeakMap(payload) {
-    return getType(payload) === "WeakMap";
-}
-/**
- * Returns whether the payload is a Set
- *
- * @param {*} payload
- * @returns {payload is Set<any>}
- */
-export function isSet(payload) {
-    return getType(payload) === "Set";
-}
-/**
- * Returns whether the payload is a WeakSet
- *
- * @param {*} payload
- * @returns {payload is WeakSet<any>}
- */
-export function isWeakSet(payload) {
-    return getType(payload) === "WeakSet";
-}
-/**
- * Returns whether the payload is a Symbol
- *
- * @param {*} payload
- * @returns {payload is symbol}
- */
-export function isSymbol(payload) {
-    return getType(payload) === "Symbol";
-}
-/**
- * Returns whether the payload is a Date, and that the date is valid
- *
- * @param {*} payload
- * @returns {payload is Date}
- */
-export function isDate(payload) {
-    return getType(payload) === "Date" && !isNaN(payload);
-}
-/**
- * Returns whether the payload is a Blob
- *
- * @param {*} payload
- * @returns {payload is Blob}
- */
-export function isBlob(payload) {
-    return getType(payload) === "Blob";
-}
-/**
- * Returns whether the payload is a File
- *
- * @param {*} payload
- * @returns {payload is File}
- */
-export function isFile(payload) {
-    return getType(payload) === "File";
-}
-/**
- * Returns whether the payload is a Promise
- *
- * @param {*} payload
- * @returns {payload is Promise<any>}
- */
-export function isPromise(payload) {
-    return getType(payload) === "Promise";
-}
-/**
- * Returns whether the payload is an Error
- *
- * @param {*} payload
- * @returns {payload is Error}
- */
-export function isError(payload) {
-    return getType(payload) === "Error";
-}
-/**
- * Returns whether the payload is literally the value `NaN` (it's `NaN` and also a `number`)
- *
- * @param {*} payload
- * @returns {payload is typeof NaN}
- */
-export function isNaNValue(payload) {
-    return getType(payload) === "Number" && isNaN(payload);
-}
-/**
- * Returns whether the payload is a primitive type (eg. Boolean | Null | Undefined | Number | String | Symbol)
- *
- * @param {*} payload
- * @returns {(payload is boolean | null | undefined | number | string | symbol)}
- */
-export function isPrimitive(payload) {
-    return (isBoolean(payload) ||
-        isNull(payload) ||
-        isUndefined(payload) ||
-        isNumber(payload) ||
-        isString(payload) ||
-        isSymbol(payload));
-}
-/**
- * Returns true whether the payload is null or undefined
- *
- * @param {*} payload
- * @returns {(payload is null | undefined)}
- */
-export var isNullOrUndefined = isOneOf(isNull, isUndefined);
-export function isOneOf(a, b, c, d, e) {
-    return function (value) {
-        return a(value) ||
-            b(value) ||
-            (!!c && c(value)) ||
-            (!!d && d(value)) ||
-            (!!e && e(value));
-    };
-}
-/**
- * Does a generic check to check that the given payload is of a given type.
- * In cases like Number, it will return true for NaN as NaN is a Number (thanks javascript!);
- * It will, however, differentiate between object and null
- *
- * @template T
- * @param {*} payload
- * @param {T} type
- * @throws {TypeError} Will throw type error if type is an invalid type
- * @returns {payload is T}
- */
-export function isType(payload, type) {
-    if (!(type instanceof Function)) {
-        throw new TypeError("Type must be a function");
-    }
-    if (!Object.prototype.hasOwnProperty.call(type, "prototype")) {
-        throw new TypeError("Type is not a class");
-    }
-    // Classes usually have names (as functions usually have names)
-    var name = type.name;
-    return (getType(payload) === name ||
-        Boolean(payload && payload.constructor === type));
-}
-/**
- * Returns whether the payload is a FormData
- */
-export function isFormData(payload) {
-    return getType(payload) === "FormData";
-}
-/**
- * Returns whether the payload is an integer number
- */
-export function isInt(payload) {
-    return isNumber(payload) && payload % 1 === 0;
-}
-/**
- * Returns whether the payload is a float number
- */
-export function isFloat(payload) {
-    return isNumber(payload) && payload % 1 !== 0;
-}

package/math.d.ts

@@ -1,28 +0,0 @@
-/**
- * Get random int (min and max included)
- */
-export declare function randomInt(min: number, max: number): number;
-/**
- * Returns a number whose value is limited to the given range.
- *
- * @see https://stackoverflow.com/a/11409944/1938970
- */
-export declare function clamp(num: number, min: number, max: number): number;
-/**
- * Round to given number of the given number of decimals
- *
- * @see https://stackoverflow.com/a/15762794/1938970
- */
-export declare function roundTo(num: number, decimals?: number): string;
-/**
- * Convert range of a number
- *
- * e.g. converting number 5 in a scale/range from 0 10 to a scale/range from 50
- * to 100 would return 75
- * ```
- * convertRange(5, [0, 10], [50, 100]);
- * ```
- *
- * @see https://stackoverflow.com/a/14224813
- */
-export declare function convertRange(num: number, r1: number[], r2: number[]): number;

package/node/arrays.js

@@ -1,166 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeIndexesFromArray = exports.findDuplicatedIndexes = exports.removeDuplicatesComparing = exports.chunkByChunks = exports.chunkBySize = exports.addOrReplaceAtIdx = exports.removeDuplicatesByKey = exports.arrayToLookup = exports.mapListBy = exports.shuffle = void 0;
-var tslib_1 = require("tslib");
-/**
- * Creates an array of shuffled values, using a version of the
- * [Fisher-Yates shuffle](https://en.wikipedia.org/wiki/Fisher-Yates_shuffle).
- *
- * @see lodash.shuffle
- * @since 0.1.0
- * @category Array
- * @param {Array} array The array to shuffle.
- * @returns {Array} Returns the new shuffled array.
- * @example
- *
- * shuffle([1, 2, 3, 4])
- * // => [4, 1, 3, 2]
- */
-function shuffle(array) {
-    var length = array == null ? 0 : array.length;
-    if (!length) {
-        return [];
-    }
-    var index = -1;
-    var lastIndex = length - 1;
-    var result = tslib_1.__spreadArray([], array, true);
-    while (++index < length) {
-        var rand = index + Math.floor(Math.random() * (lastIndex - index + 1));
-        var value = result[rand];
-        result[rand] = result[index];
-        result[index] = value;
-    }
-    return result;
-}
-exports.shuffle = shuffle;
-/**
- * Maps an array of objects into a map keyed with the given key
- */
-function mapListBy(array, key) {
-    if (array === void 0) { array = []; }
-    if (key === void 0) { key = ""; }
-    return array.reduce(function (obj, item) {
-        obj[item[key]] = item;
-        return obj;
-    }, {});
-}
-exports.mapListBy = mapListBy;
-/**
- * Maps a simple flat array to a lookup dictionary object
- */
-function arrayToLookup(array) {
-    if (array === void 0) { array = []; }
-    return array.reduce(function (obj, item) {
-        obj[item] = 1;
-        return obj;
-    }, {});
-}
-exports.arrayToLookup = arrayToLookup;
-/**
- * Remove duplicated array objects, equality is determined by a strict (`===`)
- * comparison of each object's given key
- */
-function removeDuplicatesByKey(array, key) {
-    if (array === void 0) { array = []; }
-    if (key === void 0) { key = ""; }
-    var keysMap = {};
-    var output = [];
-    for (var i = 0; i < array.length; i++) {
-        var item = array[i];
-        if (!keysMap[item[key]]) {
-            output.push(item);
-            keysMap[item[key]] = true;
-        }
-    }
-    return output;
-}
-exports.removeDuplicatesByKey = removeDuplicatesByKey;
-function addOrReplaceAtIdx(list, newItem, newIdx) {
-    if (list.length === 0) {
-        return [newItem];
-    }
-    if (typeof newIdx === "undefined" || list.length - 1 < newIdx) {
-        return tslib_1.__spreadArray(tslib_1.__spreadArray([], list, true), [newItem], false);
-    }
-    return list.map(function (item, idx) {
-        if (idx === newIdx) {
-            return newItem;
-        }
-        return item;
-    });
-}
-exports.addOrReplaceAtIdx = addOrReplaceAtIdx;
-/**
- * @see https://stackoverflow.com/a/40682136/1938970
- */
-function chunkBySize(arr, size) {
-    var output = [];
-    for (var i = 0; i < arr.length; i += size) {
-        output.push(arr.slice(i, i + size));
-    }
-    return output;
-}
-exports.chunkBySize = chunkBySize;
-/**
- * TODO: untested
- * @see https://stackoverflow.com/a/8189268/1938970
- */
-function chunkByChunks(arr, nrOfChunks, balanced) {
-    if (nrOfChunks < 2)
-        return [arr];
-    var len = arr.length;
-    var output = [];
-    var i = 0;
-    var size;
-    if (len % nrOfChunks === 0) {
-        size = Math.floor(len / nrOfChunks);
-        while (i < len) {
-            output.push(arr.slice(i, (i += size)));
-        }
-    }
-    else if (balanced) {
-        while (i < len) {
-            size = Math.ceil((len - i) / nrOfChunks--);
-            output.push(arr.slice(i, (i += size)));
-        }
-    }
-    else {
-        nrOfChunks--;
-        size = Math.floor(len / nrOfChunks);
-        if (len % size === 0)
-            size--;
-        while (i < size * nrOfChunks) {
-            output.push(arr.slice(i, (i += size)));
-        }
-        output.push(arr.slice(size * nrOfChunks));
-    }
-    return output;
-}
-exports.chunkByChunks = chunkByChunks;
-function removeDuplicatesComparing(from, to) {
-    var indexes = findDuplicatedIndexes(from);
-    return removeIndexesFromArray(to, indexes);
-}
-exports.removeDuplicatesComparing = removeDuplicatesComparing;
-function findDuplicatedIndexes(arr) {
-    var indexes = {};
-    for (var i = 0; i < arr.length; i++) {
-        var idxInArray = arr.indexOf(arr[i]);
-        if (idxInArray !== i && idxInArray !== -1) {
-            indexes[i] = true;
-        }
-    }
-    return indexes;
-}
-exports.findDuplicatedIndexes = findDuplicatedIndexes;
-function removeIndexesFromArray(arr, indexes) {
-    var output = [];
-    for (var i = 0; i < arr.length; i++) {
-        // eslint-disable-next-line no-prototype-builtins
-        if (!indexes.hasOwnProperty(i)) {
-            output.push(arr[i]);
-        }
-    }
-    return output;
-}
-exports.removeIndexesFromArray = removeIndexesFromArray;