@koine/utils 1.0.26 → 1.0.29

package/arrays.js

@@ -1,153 +0,0 @@
-import { __spreadArray } from "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]
- */
-export function shuffle(array) {
-    var length = array == null ? 0 : array.length;
-    if (!length) {
-        return [];
-    }
-    var index = -1;
-    var lastIndex = length - 1;
-    var result = __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;
-}
-/**
- * Maps an array of objects into a map keyed with the given key
- */
-export 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;
-    }, {});
-}
-/**
- * Maps a simple flat array to a lookup dictionary object
- */
-export function arrayToLookup(array) {
-    if (array === void 0) { array = []; }
-    return array.reduce(function (obj, item) {
-        obj[item] = 1;
-        return obj;
-    }, {});
-}
-/**
- * Remove duplicated array objects, equality is determined by a strict (`===`)
- * comparison of each object's given key
- */
-export 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;
-}
-export function addOrReplaceAtIdx(list, newItem, newIdx) {
-    if (list.length === 0) {
-        return [newItem];
-    }
-    if (typeof newIdx === "undefined" || list.length - 1 < newIdx) {
-        return __spreadArray(__spreadArray([], list, true), [newItem], false);
-    }
-    return list.map(function (item, idx) {
-        if (idx === newIdx) {
-            return newItem;
-        }
-        return item;
-    });
-}
-/**
- * @see https://stackoverflow.com/a/40682136/1938970
- */
-export function chunkBySize(arr, size) {
-    var output = [];
-    for (var i = 0; i < arr.length; i += size) {
-        output.push(arr.slice(i, i + size));
-    }
-    return output;
-}
-/**
- * TODO: untested
- * @see https://stackoverflow.com/a/8189268/1938970
- */
-export 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;
-}
-export function removeDuplicatesComparing(from, to) {
-    var indexes = findDuplicatedIndexes(from);
-    return removeIndexesFromArray(to, indexes);
-}
-export 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;
-}
-export 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;
-}

package/is.d.ts

@@ -1,288 +0,0 @@
-/**
- * @file
- *
- * Same as [is-what](https://github.com/mesqueeb/is-what) plus:
- *
- * - `isFormData`
- * - `isInt`
- * - `isFloat`
- */
-export declare type AnyFunction = (...args: any[]) => any;
-export declare type AnyAsyncFunction = (...args: any[]) => Promise<any>;
-export declare type AnyClass = new (...args: any[]) => any;
-export declare type PlainObject = Record<string | number | symbol, any>;
-declare type TypeGuard<A, B extends A> = (payload: A) => payload is B;
-/**
- * Returns the object type of the given payload
- *
- * @param {*} payload
- * @returns {string}
- */
-export declare function getType(payload: any): string;
-/**
- * Returns whether the payload is undefined
- *
- * @param {*} payload
- * @returns {payload is undefined}
- */
-export declare function isUndefined(payload: any): payload is undefined;
-/**
- * Returns whether the payload is null
- *
- * @param {*} payload
- * @returns {payload is null}
- */
-export declare function isNull(payload: any): payload is 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 declare function isPlainObject(payload: any): payload is PlainObject;
-/**
- * Returns whether the payload is a plain JavaScript object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export declare function isObject(payload: any): payload is PlainObject;
-/**
- * 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 declare function isEmptyObject(payload: any): payload is {
-    [K in any]: never;
-};
-/**
- * Returns whether the payload is a an empty object (excluding special classes or objects with other prototypes)
- *
- * @param {*} payload
- * @returns {payload is PlainObject}
- */
-export declare function isFullObject(payload: any): payload is PlainObject;
-/**
- * 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 declare function isAnyObject(payload: any): payload is PlainObject;
-/**
- * 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 declare function isObjectLike<T extends PlainObject>(payload: any): payload is T;
-/**
- * Returns whether the payload is a function (regular or async)
- *
- * @param {*} payload
- * @returns {payload is AnyFunction}
- */
-export declare function isFunction(payload: any): payload is AnyFunction;
-/**
- * Returns whether the payload is an array
- *
- * @param {any} payload
- * @returns {payload is any[]}
- */
-export declare function isArray(payload: any): payload is any[];
-/**
- * Returns whether the payload is a an array with at least 1 item
- *
- * @param {*} payload
- * @returns {payload is any[]}
- */
-export declare function isFullArray(payload: any): payload is any[];
-/**
- * Returns whether the payload is a an empty array
- *
- * @param {*} payload
- * @returns {payload is []}
- */
-export declare function isEmptyArray(payload: any): payload is [];
-/**
- * Returns whether the payload is a string
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export declare function isString(payload: any): payload is string;
-/**
- * Returns whether the payload is a string, BUT returns false for ''
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export declare function isFullString(payload: any): payload is string;
-/**
- * Returns whether the payload is ''
- *
- * @param {*} payload
- * @returns {payload is string}
- */
-export declare function isEmptyString(payload: any): payload is string;
-/**
- * Returns whether the payload is a number (but not NaN)
- *
- * This will return `false` for `NaN`!!
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export declare function isNumber(payload: any): payload is number;
-/**
- * Returns whether the payload is a positive number (but not 0)
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export declare function isPositiveNumber(payload: any): payload is number;
-/**
- * Returns whether the payload is a negative number (but not 0)
- *
- * @param {*} payload
- * @returns {payload is number}
- */
-export declare function isNegativeNumber(payload: any): payload is number;
-/**
- * Returns whether the payload is a boolean
- *
- * @param {*} payload
- * @returns {payload is boolean}
- */
-export declare function isBoolean(payload: any): payload is boolean;
-/**
- * Returns whether the payload is a regular expression (RegExp)
- *
- * @param {*} payload
- * @returns {payload is RegExp}
- */
-export declare function isRegExp(payload: any): payload is RegExp;
-/**
- * Returns whether the payload is a Map
- *
- * @param {*} payload
- * @returns {payload is Map<any, any>}
- */
-export declare function isMap(payload: any): payload is Map<any, any>;
-/**
- * Returns whether the payload is a WeakMap
- *
- * @param {*} payload
- * @returns {payload is WeakMap<any, any>}
- */
-export declare function isWeakMap(payload: any): payload is WeakMap<any, any>;
-/**
- * Returns whether the payload is a Set
- *
- * @param {*} payload
- * @returns {payload is Set<any>}
- */
-export declare function isSet(payload: any): payload is Set<any>;
-/**
- * Returns whether the payload is a WeakSet
- *
- * @param {*} payload
- * @returns {payload is WeakSet<any>}
- */
-export declare function isWeakSet(payload: any): payload is WeakSet<any>;
-/**
- * Returns whether the payload is a Symbol
- *
- * @param {*} payload
- * @returns {payload is symbol}
- */
-export declare function isSymbol(payload: any): payload is symbol;
-/**
- * Returns whether the payload is a Date, and that the date is valid
- *
- * @param {*} payload
- * @returns {payload is Date}
- */
-export declare function isDate(payload: any): payload is Date;
-/**
- * Returns whether the payload is a Blob
- *
- * @param {*} payload
- * @returns {payload is Blob}
- */
-export declare function isBlob(payload: any): payload is Blob;
-/**
- * Returns whether the payload is a File
- *
- * @param {*} payload
- * @returns {payload is File}
- */
-export declare function isFile(payload: any): payload is File;
-/**
- * Returns whether the payload is a Promise
- *
- * @param {*} payload
- * @returns {payload is Promise<any>}
- */
-export declare function isPromise(payload: any): payload is Promise<any>;
-/**
- * Returns whether the payload is an Error
- *
- * @param {*} payload
- * @returns {payload is Error}
- */
-export declare function isError(payload: any): payload is 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 declare function isNaNValue(payload: any): payload is typeof NaN;
-/**
- * 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 declare function isPrimitive(payload: any): payload is boolean | null | undefined | number | string | symbol;
-/**
- * Returns true whether the payload is null or undefined
- *
- * @param {*} payload
- * @returns {(payload is null | undefined)}
- */
-export declare const isNullOrUndefined: TypeGuard<any, null | undefined>;
-export declare function isOneOf<A, B extends A, C extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>): TypeGuard<A, B | C>;
-export declare function isOneOf<A, B extends A, C extends A, D extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>, c: TypeGuard<A, D>): TypeGuard<A, B | C | D>;
-export declare function isOneOf<A, B extends A, C extends A, D extends A, E extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>, c: TypeGuard<A, D>, d: TypeGuard<A, E>): TypeGuard<A, B | C | D | E>;
-export declare function isOneOf<A, B extends A, C extends A, D extends A, E extends A, F extends A>(a: TypeGuard<A, B>, b: TypeGuard<A, C>, c: TypeGuard<A, D>, d: TypeGuard<A, E>, e: TypeGuard<A, F>): TypeGuard<A, B | C | D | E | F>;
-/**
- * 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 declare function isType<T extends AnyFunction | AnyClass>(payload: any, type: T): payload is T;
-/**
- * Returns whether the payload is a FormData
- */
-export declare function isFormData(payload: any): payload is FormData;
-/**
- * Returns whether the payload is an integer number
- */
-export declare function isInt(payload: any): payload is number;
-/**
- * Returns whether the payload is a float number
- */
-export declare function isFloat(payload: any): payload is number;
-export {};