@hkdigital/lib-core 0.3.10 → 0.3.11

package/dist/util/array/index.js

@@ -1,436 +1,436 @@
-/* ------------------------------------------------------------------ Imports */
-
-import * as expect from '../expect/index.js';
-
-import { smallestFirst, largestFirst } from '../compare/index.js';
-
-import { objectGet, PATH_SEPARATOR } from '../object/index.js';
-
-import Selector from '../../classes/data/Selector.js';
-
-/* ---------------------------------------------------------------- Internals */
-
-const arraySlice = Array.prototype.slice;
-const arrayConcat = Array.prototype.concat;
-
-/* ------------------------------------------------------------------ Exports */
-
-export { PATH_SEPARATOR } from '../object/index.js';
-
-export { smallestFirst, largestFirst };
-
-export { arraySlice, arrayConcat };
-
-/**
- * Convert a value to an array
- * - Converts an Arguments object to plain JS array
- * - If the value is undefined or null, an empty array is returned
- * - A primitive value is "wrapped" in an array
- *
- * @param {any} value - Item to convert
- *
- * @param {number} [start]
- *   Index of the array to start extraction.
- *   (the first element of the array is at index 0)
- *
- * @param {number} [end]
- *   Index of the array where the extraction should end
- *
- * --
- *
- * @returns {Array} array
- *
- * --
- *
- * @example
- *   toArray( [ 1, 2, 3, 4, 5 ], 2, 4 ) returns [ 3, 4 ]
- */
-export function toArray(value, start, end) {
-	if (Array.isArray(value)) {
-		//
-		// Do not clone input value if it is already an array
-		//
-		// @note this behaviour differs from Array.from
-		//
-		if (undefined === start) {
-			return value;
-		}
-
-		return value.slice(start, end);
-	}
-
-	if (undefined === value || null === value) {
-		//
-		// Return an empty array if value is undefined or null
-		//
-		// ==> this behaviour differs from Array.from() <==
-		//
-		return [];
-	} else if (!(value instanceof Object)) {
-		//
-		// Wrap (non-object) in array (e.g. a string)
-		//
-		// @note this behaviour differs from Array.from
-		//
-		return [value];
-	}
-
-	if (undefined === start) {
-		//
-		// Construct a new array from the value
-		//
-		return Array.from(value);
-	} else {
-		return arraySlice.call(value, start, end);
-	}
-}
-
-/**
- * Convert an async iterator to an array
- * - If no async iterator is passed, the value will be processed by `from()`
- *
- * @param {AsyncIterator|any} value
- *   Async iterator or value to convert to array
- *
- * @returns {Promise<Array>} list of items returned by the iterator
- */
-export async function toArrayAsync(value) {
-	if (
-		value instanceof Object &&
-		typeof value[Symbol.asyncIterator] === 'function'
-	) {
-		// value is an async iterator
-
-		const arr = [];
-
-		for await (const item of value) {
-			arr.push(item);
-		}
-
-		return arr;
-	} else {
-		// value is not an async iterator
-
-		return toArray(value);
-	}
-}
-
-/**
- * Convert a path string to an array path
- * - The path string will be spit at the `pathSeparator` token
- * - If the supplied path is already an array, the original array will
- *   be returned
- *
- * @param {string|string[]} path
- *   String or array path (e.g. "some.path.to")
- *
- * @param {string} [pathSeparator=PATH_SEPARATOR]
- *   A custom path separator to use instead of the default "."
- *
- * @returns {string[]} array path (e.g. ["some", "path", "to"])
- */
-export function toArrayPath(path, pathSeparator = PATH_SEPARATOR) {
-	if (typeof path === 'string') {
-		return path.split(pathSeparator);
-	} else if (Array.isArray(path)) {
-		// path is already an array
-		return path;
-	} else {
-		throw new Error(
-			'Missing or invalid parameter [path] (expected string or array)'
-		);
-	}
-}
-
-/**
- * Push a value to an array if it is not null, undefined or an empty string
- *
- * @template {array} T
- * @param {T} arr
- * @param {any} value
- *
- * @returns {T} arr
- */
-export function pushNotEmpty(arr, value) {
-	expect.array(arr);
-
-	if (value !== null && value !== undefined && value !== '') {
-		arr.push(value);
-	}
-
-	return arr;
-}
-
-/**
- * Loop over the supplied array and call the callback for every element
- * - The callback will receive the current element of the array as
- *   first argument
- * - Via [additionalArguments], additional arguments may be supplied that
- *   will be passed to the callback function
- *
- * @param {array} arr - The array to loop
- * @param {function} callback - Callback to call for every element
- * @param {array} additionalArguments  The additional arguments
- */
-export function loop(arr, callback, additionalArguments) {
-	expect.function(callback);
-
-	if (!arr) {
-		return;
-	}
-
-	expect.array(arr);
-
-	if (!arr.length) {
-		// Nothing to do
-		return;
-	}
-
-	// >> CASE A: no additional arguments
-
-	if (!additionalArguments) {
-		for (let j = 0, n = arr.length; j < n; j = j + 1) {
-			callback(arr[j]);
-		}
-
-		return;
-	}
-
-	// >> CASE B: additional arguments
-
-	expect.arrayLike(additionalArguments);
-
-	const args = [null, ...additionalArguments];
-
-	for (let j = 0, n = arr.length; j < n; j = j + 1) {
-		args[0] = arr[j];
-		callback(...args);
-	}
-}
-
-/**
- * Get a list of all values from the items in the array at the
- * specified path
- *
- * @param {object[]} items
- *
- * @param {object} [options]
- *
- * @param {boolean} [options.outputAsSet=false]
- *   Output a Set instead of an array
- *
- * @param {string} [options.pathSeparator=PATH_SEPARATOR]
- *   A custom path separator to use instead of the default "."
- *
- *
- *
- * @returns {any[]|Set<any>} values
- */
-export function pathValues(items, path, options = {}) {
-	// == Process parameters
-
-	expect.array(items);
-
-	const { outputAsSet = false, pathSeparator = PATH_SEPARATOR } = options;
-
-	if (typeof path === 'string') {
-		path = toArrayPath(path, pathSeparator);
-	} else {
-		expect.stringArray(path);
-	}
-
-	// >> CASE A: Output as plain Array
-
-	if (!outputAsSet) {
-		const values = [];
-
-		for (let j = 0, n = items.length; j < n; j = j + 1) {
-			const item = items[j];
-
-			expect.object(item);
-
-			values.push(objectGet(item, path));
-		}
-
-		return values;
-	}
-
-	// >> CASE B: Output as Set
-
-	const values = new Set();
-
-	for (let j = 0, n = items.length; j < n; j = j + 1) {
-		const item = items[j];
-
-		expect.object(item);
-
-		values.add(objectGet(item, path));
-	}
-
-	return values;
-}
-
-/**
- * Sort function that sorts a list of objects by values encountered at the
- * specified key values of the object.
- * - Sorts array inline (no new array is returned)
- * - This method is faster than `sortByPathValue` since the value lookup in the
- *   items can be done faster
- *
- * @param {Object[]} items - List of items to sort
- *
- * @param {string} key
- *   Object key to use for getting the values in the items to compare.
- *
- * @param {function} [compareFn=smallestFirst]
- *   Function to use to compare values. See `compare.js`.
- */
-export function sortByKeyValue(items, key, compareFn = smallestFirst) {
-	expect.function(compareFn);
-
-	expect.array(items);
-
-	expect.string(key);
-
-	items.sort((itemA, itemB) => {
-		return compareFn(itemA[key], itemB[key]);
-	});
-}
-
-/**
- * Sort function that sorts a list of objects by values encountered at the
- * specified key values of the object.
- * - Sorts array inline (no new array is returned)
- * - This method is faster than `sortByPathValue` since the value lookup in the
- *   items can be done faster
- *
- * @param {Object[]} items - List of items to sort
- *
- * @param {string} key
- *   Object key to use for getting the values in the items to compare.
- *
- * @param {function} [compareFn=smallestFirst]
- *   Function to use to compare values. See `compare.js`.
- */
-export function sortByKeyValueReversed(items, key, compareFn = largestFirst) {
-	expect.function(compareFn);
-
-	expect.array(items);
-
-	expect.string(key);
-
-	items.sort((itemA, itemB) => {
-		return compareFn(itemA[key], itemB[key]);
-	});
-}
-
-/**
- * Sort function that sorts a list of objects by values encountered at the
- * specified object path.
- * - Sorts array inline (no new array is returned)
- *
- * @param {Object[]} items - List of items to sort
- *
- * @param {string[]|string} path
- *   Path to use for getting the values in the items to compare.
- *   If a string path has been supplied, the default path separator
- *   (PATH_SEPARATOR) is assumed. Use `toArrayPath` to convert paths with
- *   custom path separators.
- *
- * @param {function} [compareFn=smallestFirst]
- *   Function to use to compare values. See `compare.js`.
- */
-export function sortByPathValue(items, path, compareFn = smallestFirst) {
-	expect.function(compareFn);
-
-	expect.array(items);
-
-	if (typeof path === 'string') {
-		path = toArrayPath(path);
-	} else {
-		expect.stringArray(path);
-	}
-
-	const cache = new Map();
-
-	items.sort((itemA, itemB) => {
-		let valueA = cache.get(itemA);
-
-		if (undefined === valueA) {
-			valueA = objectGet(itemA, path);
-
-			if (undefined !== valueA) {
-				cache.set(itemA, valueA);
-			}
-		}
-
-		let valueB = cache.get(itemB);
-
-		if (undefined === valueB) {
-			valueB = objectGet(itemB, path);
-
-			if (undefined !== valueB) {
-				cache.set(itemB, valueB);
-			}
-		}
-
-		return compareFn(valueA, valueB);
-	});
-
-	cache.clear();
-}
-
-/**
- * Find the first item in the list of objects that matches the selector
- * - All items in the supplied array must be objects
- *
- * @template {object} T
- * @param {T[]} arr
- * @param {object|null} selector
- *
- * @returns {T|null} first matched item
- */
-export function findFirst(arr, selector) {
-	const selectorObj = new Selector(selector);
-
-	return selectorObj.findFirst(arr);
-}
-
-/**
- * Returns all items from the list of items that match the selector
- * - All items in the supplied array must be objects
- *
- * @template {object} T
- * @param {T[]} arr
- * @param {object|null} selector
- *
- * @returns {T[]} matching items
- */
-export function findAll(arr, selector) {
-	const selectorObj = new Selector(selector);
-
-	return selectorObj.findAll(arr);
-}
-
-/**
- * Convert array to an object using a list of keys for each index
- *
- * @param {array} arr
- * @param {string[]} keys
- *
- * @returns {object}
- */
-export function arrayToObject(arr, keys) {
-	expect.array(arr);
-	expect.array(keys);
-
-	const obj = {};
-
-	const n = Math.min(arr.length, keys.length);
-
-	for (let j = 0; j < n; j = j + 1) {
-		obj[keys[j]] = arr[j];
-	}
-
-	return obj;
-}
+/* ------------------------------------------------------------------ Imports */
+
+import * as expect from '../expect/index.js';
+
+import { smallestFirst, largestFirst } from '../compare/index.js';
+
+import { objectGet, PATH_SEPARATOR } from '../object/index.js';
+
+import Selector from '../../classes/data/Selector.js';
+
+/* ---------------------------------------------------------------- Internals */
+
+const arraySlice = Array.prototype.slice;
+const arrayConcat = Array.prototype.concat;
+
+/* ------------------------------------------------------------------ Exports */
+
+export { PATH_SEPARATOR } from '../object/index.js';
+
+export { smallestFirst, largestFirst };
+
+export { arraySlice, arrayConcat };
+
+/**
+ * Convert a value to an array
+ * - Converts an Arguments object to plain JS array
+ * - If the value is undefined or null, an empty array is returned
+ * - A primitive value is "wrapped" in an array
+ *
+ * @param {any} value - Item to convert
+ *
+ * @param {number} [start]
+ *   Index of the array to start extraction.
+ *   (the first element of the array is at index 0)
+ *
+ * @param {number} [end]
+ *   Index of the array where the extraction should end
+ *
+ * --
+ *
+ * @returns {Array} array
+ *
+ * --
+ *
+ * @example
+ *   toArray( [ 1, 2, 3, 4, 5 ], 2, 4 ) returns [ 3, 4 ]
+ */
+export function toArray(value, start, end) {
+	if (Array.isArray(value)) {
+		//
+		// Do not clone input value if it is already an array
+		//
+		// @note this behaviour differs from Array.from
+		//
+		if (undefined === start) {
+			return value;
+		}
+
+		return value.slice(start, end);
+	}
+
+	if (undefined === value || null === value) {
+		//
+		// Return an empty array if value is undefined or null
+		//
+		// ==> this behaviour differs from Array.from() <==
+		//
+		return [];
+	} else if (!(value instanceof Object)) {
+		//
+		// Wrap (non-object) in array (e.g. a string)
+		//
+		// @note this behaviour differs from Array.from
+		//
+		return [value];
+	}
+
+	if (undefined === start) {
+		//
+		// Construct a new array from the value
+		//
+		return Array.from(value);
+	} else {
+		return arraySlice.call(value, start, end);
+	}
+}
+
+/**
+ * Convert an async iterator to an array
+ * - If no async iterator is passed, the value will be processed by `from()`
+ *
+ * @param {AsyncIterator|any} value
+ *   Async iterator or value to convert to array
+ *
+ * @returns {Promise<Array>} list of items returned by the iterator
+ */
+export async function toArrayAsync(value) {
+	if (
+		value instanceof Object &&
+		typeof value[Symbol.asyncIterator] === 'function'
+	) {
+		// value is an async iterator
+
+		const arr = [];
+
+		for await (const item of value) {
+			arr.push(item);
+		}
+
+		return arr;
+	} else {
+		// value is not an async iterator
+
+		return toArray(value);
+	}
+}
+
+/**
+ * Convert a path string to an array path
+ * - The path string will be spit at the `pathSeparator` token
+ * - If the supplied path is already an array, the original array will
+ *   be returned
+ *
+ * @param {string|string[]} path
+ *   String or array path (e.g. "some.path.to")
+ *
+ * @param {string} [pathSeparator=PATH_SEPARATOR]
+ *   A custom path separator to use instead of the default "."
+ *
+ * @returns {string[]} array path (e.g. ["some", "path", "to"])
+ */
+export function toArrayPath(path, pathSeparator = PATH_SEPARATOR) {
+	if (typeof path === 'string') {
+		return path.split(pathSeparator);
+	} else if (Array.isArray(path)) {
+		// path is already an array
+		return path;
+	} else {
+		throw new Error(
+			'Missing or invalid parameter [path] (expected string or array)'
+		);
+	}
+}
+
+/**
+ * Push a value to an array if it is not null, undefined or an empty string
+ *
+ * @template {array} T
+ * @param {T} arr
+ * @param {any} value
+ *
+ * @returns {T} arr
+ */
+export function pushNotEmpty(arr, value) {
+	expect.array(arr);
+
+	if (value !== null && value !== undefined && value !== '') {
+		arr.push(value);
+	}
+
+	return arr;
+}
+
+/**
+ * Loop over the supplied array and call the callback for every element
+ * - The callback will receive the current element of the array as
+ *   first argument
+ * - Via [additionalArguments], additional arguments may be supplied that
+ *   will be passed to the callback function
+ *
+ * @param {array} arr - The array to loop
+ * @param {function} callback - Callback to call for every element
+ * @param {array} additionalArguments  The additional arguments
+ */
+export function loop(arr, callback, additionalArguments) {
+	expect.function(callback);
+
+	if (!arr) {
+		return;
+	}
+
+	expect.array(arr);
+
+	if (!arr.length) {
+		// Nothing to do
+		return;
+	}
+
+	// >> CASE A: no additional arguments
+
+	if (!additionalArguments) {
+		for (let j = 0, n = arr.length; j < n; j = j + 1) {
+			callback(arr[j]);
+		}
+
+		return;
+	}
+
+	// >> CASE B: additional arguments
+
+	expect.arrayLike(additionalArguments);
+
+	const args = [null, ...additionalArguments];
+
+	for (let j = 0, n = arr.length; j < n; j = j + 1) {
+		args[0] = arr[j];
+		callback(...args);
+	}
+}
+
+/**
+ * Get a list of all values from the items in the array at the
+ * specified path
+ *
+ * @param {object[]} items
+ *
+ * @param {object} [options]
+ *
+ * @param {boolean} [options.outputAsSet=false]
+ *   Output a Set instead of an array
+ *
+ * @param {string} [options.pathSeparator=PATH_SEPARATOR]
+ *   A custom path separator to use instead of the default "."
+ *
+ *
+ *
+ * @returns {any[]|Set<any>} values
+ */
+export function pathValues(items, path, options = {}) {
+	// == Process parameters
+
+	expect.array(items);
+
+	const { outputAsSet = false, pathSeparator = PATH_SEPARATOR } = options;
+
+	if (typeof path === 'string') {
+		path = toArrayPath(path, pathSeparator);
+	} else {
+		expect.stringArray(path);
+	}
+
+	// >> CASE A: Output as plain Array
+
+	if (!outputAsSet) {
+		const values = [];
+
+		for (let j = 0, n = items.length; j < n; j = j + 1) {
+			const item = items[j];
+
+			expect.object(item);
+
+			values.push(objectGet(item, path));
+		}
+
+		return values;
+	}
+
+	// >> CASE B: Output as Set
+
+	const values = new Set();
+
+	for (let j = 0, n = items.length; j < n; j = j + 1) {
+		const item = items[j];
+
+		expect.object(item);
+
+		values.add(objectGet(item, path));
+	}
+
+	return values;
+}
+
+/**
+ * Sort function that sorts a list of objects by values encountered at the
+ * specified key values of the object.
+ * - Sorts array inline (no new array is returned)
+ * - This method is faster than `sortByPathValue` since the value lookup in the
+ *   items can be done faster
+ *
+ * @param {Object[]} items - List of items to sort
+ *
+ * @param {string} key
+ *   Object key to use for getting the values in the items to compare.
+ *
+ * @param {function} [compareFn=smallestFirst]
+ *   Function to use to compare values. See `compare.js`.
+ */
+export function sortByKeyValue(items, key, compareFn = smallestFirst) {
+	expect.function(compareFn);
+
+	expect.array(items);
+
+	expect.string(key);
+
+	items.sort((itemA, itemB) => {
+		return compareFn(itemA[key], itemB[key]);
+	});
+}
+
+/**
+ * Sort function that sorts a list of objects by values encountered at the
+ * specified key values of the object.
+ * - Sorts array inline (no new array is returned)
+ * - This method is faster than `sortByPathValue` since the value lookup in the
+ *   items can be done faster
+ *
+ * @param {Object[]} items - List of items to sort
+ *
+ * @param {string} key
+ *   Object key to use for getting the values in the items to compare.
+ *
+ * @param {function} [compareFn=smallestFirst]
+ *   Function to use to compare values. See `compare.js`.
+ */
+export function sortByKeyValueReversed(items, key, compareFn = largestFirst) {
+	expect.function(compareFn);
+
+	expect.array(items);
+
+	expect.string(key);
+
+	items.sort((itemA, itemB) => {
+		return compareFn(itemA[key], itemB[key]);
+	});
+}
+
+/**
+ * Sort function that sorts a list of objects by values encountered at the
+ * specified object path.
+ * - Sorts array inline (no new array is returned)
+ *
+ * @param {Object[]} items - List of items to sort
+ *
+ * @param {string[]|string} path
+ *   Path to use for getting the values in the items to compare.
+ *   If a string path has been supplied, the default path separator
+ *   (PATH_SEPARATOR) is assumed. Use `toArrayPath` to convert paths with
+ *   custom path separators.
+ *
+ * @param {function} [compareFn=smallestFirst]
+ *   Function to use to compare values. See `compare.js`.
+ */
+export function sortByPathValue(items, path, compareFn = smallestFirst) {
+	expect.function(compareFn);
+
+	expect.array(items);
+
+	if (typeof path === 'string') {
+		path = toArrayPath(path);
+	} else {
+		expect.stringArray(path);
+	}
+
+	const cache = new Map();
+
+	items.sort((itemA, itemB) => {
+		let valueA = cache.get(itemA);
+
+		if (undefined === valueA) {
+			valueA = objectGet(itemA, path);
+
+			if (undefined !== valueA) {
+				cache.set(itemA, valueA);
+			}
+		}
+
+		let valueB = cache.get(itemB);
+
+		if (undefined === valueB) {
+			valueB = objectGet(itemB, path);
+
+			if (undefined !== valueB) {
+				cache.set(itemB, valueB);
+			}
+		}
+
+		return compareFn(valueA, valueB);
+	});
+
+	cache.clear();
+}
+
+/**
+ * Find the first item in the list of objects that matches the selector
+ * - All items in the supplied array must be objects
+ *
+ * @template {object} T
+ * @param {T[]} arr
+ * @param {object|null} selector
+ *
+ * @returns {T|null} first matched item
+ */
+export function findFirst(arr, selector) {
+	const selectorObj = new Selector(selector);
+
+	return selectorObj.findFirst(arr);
+}
+
+/**
+ * Returns all items from the list of items that match the selector
+ * - All items in the supplied array must be objects
+ *
+ * @template {object} T
+ * @param {T[]} arr
+ * @param {object|null} selector
+ *
+ * @returns {T[]} matching items
+ */
+export function findAll(arr, selector) {
+	const selectorObj = new Selector(selector);
+
+	return selectorObj.findAll(arr);
+}
+
+/**
+ * Convert array to an object using a list of keys for each index
+ *
+ * @param {array} arr
+ * @param {string[]} keys
+ *
+ * @returns {object}
+ */
+export function arrayToObject(arr, keys) {
+	expect.array(arr);
+	expect.array(keys);
+
+	const obj = {};
+
+	const n = Math.min(arr.length, keys.length);
+
+	for (let j = 0; j < n; j = j + 1) {
+		obj[keys[j]] = arr[j];
+	}
+
+	return obj;
+}