@oscarpalmer/atoms 0.186.2 → 0.187.0

package/dist/array/filter.d.mts

@@ -4,7 +4,7 @@ import { PlainObject } from "../models.mjs";
 /**
  * Get a filtered array of items that do not match the value
  *
- * Available as `exclude` and `filter.remove`
+ * _Available as `exclude` and `filter.remove`_
  *
  * @param array Array to search in
  * @param callback Callback to get an item's value for matching
@@ -24,7 +24,7 @@ declare function exclude<Item, Callback extends (item: Item, index: number, arra
 /**
  * Get a filtered array of items that do not match the value
  *
- * Available as `exclude` and `filter.remove`
+ * _Available as `exclude` and `filter.remove`_
  *
  * @param array Array to search in
  * @param key Key to get an item's value for matching
@@ -44,7 +44,7 @@ declare function exclude<Item extends PlainObject, ItemKey extends keyof Item>(a
 /**
  * Get a filtered array of items that do not match the filter
  *
- * Available as `exclude` and `filter.remove`
+ * _Available as `exclude` and `filter.remove`_
  *
  * @param array Array to search in
  * @param filter Filter callback to match items
@@ -62,7 +62,7 @@ declare function exclude<Item>(array: Item[], filter: (item: Item, index: number
 /**
  * Get a filtered array of items that do not match the given item
  *
- * Available as `exclude` and `filter.remove`
+ * _Available as `exclude` and `filter.remove`_
  *
  * @param array Array to search in
  * @param item Item to match against

package/dist/array/find.d.mts

@@ -72,7 +72,7 @@ declare namespace find {
 /**
  * Get the last item matching the given value
  *
- * Available as `findLast` and `find.last`
+ * _Available as `findLast` and `find.last`_
  *
  * @param array Array to search in
  * @param callback Callback to get an item's value for matching
@@ -92,7 +92,7 @@ declare function findLast<Item, Callback extends (item: Item, index: number, arr
 /**
  * Get the last item matching the given value by key
  *
- * Available as `findLast` and `find.last`
+ * _Available as `findLast` and `find.last`_
  *
  * @param array Array to search in
  * @param key Key to get an item's value for matching
@@ -112,7 +112,7 @@ declare function findLast<Item extends PlainObject, ItemKey extends keyof Item>(
 /**
  * Get the last item matching the filter
  *
- * Available as `findLast` and `find.last`
+ * _Available as `findLast` and `find.last`_
  *
  * @param array Array to search in
  * @param filter Filter callback to match items
@@ -130,7 +130,7 @@ declare function findLast<Item>(array: Item[], filter: (item: Item, index: numbe
 /**
  * Get the last item matching the given value
  *
- * Available as `findLast` and `find.last`
+ * _Available as `findLast` and `find.last`_
  *
  * @param array Array to search in
  * @param value Value to match against

package/dist/array/first.d.mts

@@ -74,7 +74,7 @@ declare namespace first {
 /**
  * Get the first item matching the given value, or a default value if no match is found
  *
- * Available as `firstOrDefault` and `first.default`
+ * _Available as `firstOrDefault` and `first.default`_
  *
  * @param array Array to search in
  * @param defaultValue Default value to return if no match is found
@@ -96,7 +96,7 @@ declare function firstOrDefault<Item, Callback extends (item: Item, index: numbe
 /**
  * Get the first item matching the given value by key, or a default value if no match is found
  *
- * Available as `firstOrDefault` and `first.default`
+ * _Available as `firstOrDefault` and `first.default`_
  *
  * @param array Array to search in
  * @param defaultValue Default value to return if no match is found
@@ -118,7 +118,7 @@ declare function firstOrDefault<Item extends PlainObject, ItemKey extends keyof
 /**
  * Get the first item matching the filter, or a default value if no match is found
  *
- * Available as `firstOrDefault` and `first.default`
+ * _Available as `firstOrDefault` and `first.default`_
  *
  * @param array Array to search in
  * @param defaultValue Default value to return if no match is found
@@ -138,7 +138,7 @@ declare function firstOrDefault<Item>(array: Item[], defaultValue: Item, filter:
 /**
  * Get the first item from an array, or a default value if the array is empty
  *
- * Available as `firstOrDefault` and `first.default`
+ * _Available as `firstOrDefault` and `first.default`_
  *
  * @param array Array to get from
  * @param defaultValue Default value to return if the array is empty

package/dist/array/get.d.mts

@@ -14,6 +14,20 @@ import { NumericalKeys, PlainObject } from "../models.mjs";
  * ```
  */
 declare function getArray<Value extends PlainObject>(value: Value, indiced: true): Value[NumericalKeys<Value>][];
+/**
+ * Get an array from a map
+ *
+ * @param value Map to convert to an array
+ * @returns Array holding the entries of the map
+ *
+ * @example
+ * ```typescript
+ * getArray(
+ *   new Map([['a', 1], ['b', 2], ['c', 3]]),
+ * ); // => [['a', 1], ['b', 2], ['c', 3]]
+ * ```
+ */
+declare function getArray<Key, Value>(map: Map<Key, Value>): [Key, Value][];
 /**
  * Get an array from an object
  *
@@ -26,7 +40,19 @@ declare function getArray<Value extends PlainObject>(value: Value, indiced: true
  * getArray({a: 'a', b: 'b', c: 'c', d: 'd'}); // => ['a', 'b', 'c', 'd']
  * ```
  */
-declare function getArray<Value extends PlainObject>(value: Value): Value[keyof Value][];
+declare function getArray<Value extends PlainObject>(value: Value): [keyof Value, Value[keyof Value]][];
+/**
+ * Get an array from a set
+ *
+ * @param value Set to convert to an array
+ * @returns Array holding the values of the set
+ *
+ * @example
+ * ```typescript
+ * getArray(new Set([123, 456, 789])); // => [123, 456, 789]
+ * ```
+ */
+declare function getArray<Value>(set: Set<Value>): Value[];
 /**
  * Get an array from a value
  *

package/dist/array/get.mjs

@@ -2,15 +2,17 @@ import { isNonPlainObject } from "../internal/is.mjs";
 //#region src/array/get.ts
 function getArray(value, indiced) {
 	if (Array.isArray(value)) return value;
-	if (value instanceof Map || value instanceof Set) return [...value.values()];
+	if (value instanceof Map) return [...value.entries()];
+	if (value instanceof Set) return [...value.values()];
 	if (isNonPlainObject(value)) return [value];
-	if (indiced !== true) return Object.values(value);
+	if (indiced !== true) return Object.entries(value);
 	const keys = Object.keys(value);
 	const { length } = keys;
 	const array = [];
 	for (let index = 0; index < length; index += 1) {
 		const key = keys[index];
-		if (!Number.isNaN(Number(key))) array.push(value[key]);
+		const asNumber = Number.parseInt(key, 10);
+		if (!Number.isNaN(asNumber)) array[asNumber] = value[key];
 	}
 	return array;
 }

package/dist/array/group-by.d.mts

@@ -137,7 +137,7 @@ declare namespace groupBy {
 /**
  * Create a record from an array of items using a specific key and value, grouping values into arrays
  *
- * Available as `groupArraysBy` and `groupBy.arrays`
+ * _Available as `groupArraysBy` and `groupBy.arrays`_
  *
  * @param array Array to group
  * @param key Callback to get an item's grouping key
@@ -160,7 +160,7 @@ declare function groupArraysBy<Item, KeyCallback extends (item: Item, index: num
 /**
  * Create a record from an array of items using a specific key and value, grouping values into arrays
  *
- * Available as `groupArraysBy` and `groupBy.arrays`
+ * _Available as `groupArraysBy` and `groupBy.arrays`_
  *
  * @param array Array to group
  * @param key Callback to get an item's grouping key
@@ -183,7 +183,7 @@ declare function groupArraysBy<Item extends PlainObject, KeyCallback extends (it
 /**
  * Create a record from an array of items using a specific key and value, grouping values into arrays
  *
- * Available as `groupArraysBy` and `groupBy.arrays`
+ * _Available as `groupArraysBy` and `groupBy.arrays`_
  *
  * @param array Array to group
  * @param key Key to use for grouping
@@ -206,7 +206,7 @@ declare function groupArraysBy<Item extends PlainObject, ItemKey extends keyof I
 /**
  * Create a record from an array of items using a specific key and value, grouping values into arrays
  *
- * Available as `groupArraysBy` and `groupBy.arrays`
+ * _Available as `groupArraysBy` and `groupBy.arrays`_
  *
  * @param array Array to group
  * @param key Key to use for grouping
@@ -229,7 +229,7 @@ declare function groupArraysBy<Item extends PlainObject, ItemKey extends keyof I
 /**
  * Create a record from an array of items using a specific key, grouping items into arrays
  *
- * Available as `groupArraysBy` and `groupBy.arrays`
+ * _Available as `groupArraysBy` and `groupBy.arrays`_
  *
  * @param array Array to group
  * @param callback Callback to get an item's grouping key
@@ -250,7 +250,7 @@ declare function groupArraysBy<Item, Callback extends (item: Item, index: number
 /**
  * Create a record from an array of items using a specific key, grouping items into arrays
  *
- * Available as `groupArraysBy` and `groupBy.arrays`
+ * _Available as `groupArraysBy` and `groupBy.arrays`_
  *
  * @param array Array to group
  * @param key Key to use for grouping

package/dist/array/last.d.mts

@@ -72,7 +72,7 @@ declare namespace last {
 /**
  * Get the last item matching the given value
  *
- * Available as `lastOrDefault` and `last.default`
+ * _Available as `lastOrDefault` and `last.default`_
  *
  * @param array Array to search in
  * @param defaultValue Default value to return if no match is found
@@ -94,7 +94,7 @@ declare function lastOrDefault<Item, Callback extends (item: Item, index: number
 /**
  * Get the last item matching the given value by key
  *
- * Available as `lastOrDefault` and `last.default`
+ * _Available as `lastOrDefault` and `last.default`_
  *
  * @param array Array to search in
  * @param defaultValue Default value to return if no match is found
@@ -116,7 +116,7 @@ declare function lastOrDefault<Item extends PlainObject, ItemKey extends keyof I
 /**
  * Get the last item matching the filter
  *
- * Available as `lastOrDefault` and `last.default`
+ * _Available as `lastOrDefault` and `last.default`_
  *
  * @param array Array to search in
  * @param defaultValue Default value to return if no match is found
@@ -136,7 +136,7 @@ declare function lastOrDefault<Item>(array: Item[], defaultValue: Item, filter:
 /**
  * Get the last item from an array
  *
- * Available as `lastOrDefault` and `last.default`
+ * _Available as `lastOrDefault` and `last.default`_
  *
  * @param array Array to get from
  * @param defaultValue Default value to return if the array is empty

package/dist/array/match.d.mts

@@ -6,7 +6,8 @@ import { PlainObject } from "../models.mjs";
  */
 type ArrayComparison = 'end' | 'inside' | 'invalid' | 'outside' | 'same' | 'start';
 /**
- * Does the needle array end the haystack array?
+ * Is the needle array at the end of the haystack array?
+ *
  * @param haystack Haystack array
  * @param needle Needle array
  * @param callback Callback to get an item's value for matching
@@ -23,7 +24,7 @@ type ArrayComparison = 'end' | 'inside' | 'invalid' | 'outside' | 'same' | 'star
  */
 declare function endsWithArray<Item>(haystack: Item[], needle: Item[], callback: (item: Item, index: number, array: Item[]) => unknown): boolean;
 /**
- * Does the needle array end the haystack array?
+ * Is the needle array at the end of the haystack array?
  *
  * @param haystack Haystack array
  * @param needle Needle array
@@ -41,7 +42,7 @@ declare function endsWithArray<Item>(haystack: Item[], needle: Item[], callback:
  */
 declare function endsWithArray<Item extends PlainObject>(haystack: Item[], needle: Item[], key: keyof Item): boolean;
 /**
- * Does the needle array end the haystack array?
+ * Is the needle array at the end of the haystack array?
  *
  * @param haystack Haystack array
  * @param needle Needle array
@@ -201,7 +202,7 @@ declare function indexOfArray<Item extends PlainObject>(haystack: Item[], needle
  */
 declare function indexOfArray<Item>(haystack: Item[], needle: Item[]): number;
 /**
- * Does the needle array start the haystack array?
+ * Is the needle array at the start of the haystack array?
  *
  * @param haystack Haystack array
  * @param needle Needle array
@@ -219,7 +220,7 @@ declare function indexOfArray<Item>(haystack: Item[], needle: Item[]): number;
  */
 declare function startsWithArray<Item>(haystack: Item[], needle: Item[], callback: (item: Item, index: number, array: Item[]) => unknown): boolean;
 /**
- * Does the needle array start the haystack array?
+ * Is the needle array at the start of the haystack array?
  *
  * @param haystack Haystack array
  * @param needle Needle array
@@ -237,7 +238,7 @@ declare function startsWithArray<Item>(haystack: Item[], needle: Item[], callbac
  */
 declare function startsWithArray<Item extends PlainObject>(haystack: Item[], needle: Item[], key: keyof Item): boolean;
 /**
- * Does the needle array start the haystack array?
+ * Is the needle array at the start of the haystack array?
  *
  * @param haystack Haystack array
  * @param needle Needle array

package/dist/array/move.d.mts

@@ -4,7 +4,7 @@ import { PlainObject } from "../models.mjs";
 /**
  * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
  *
- * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item.
+ * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item
  *
  * If either of values are not present in the array, or if they overlap, the array will be returned unchanged
  *
@@ -27,7 +27,7 @@ declare function move<Item>(array: Item[], from: Item | Item[], to: Item | Item[
 /**
  * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
  *
- * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item.
+ * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item
  *
  * If either of values are not present in the array, or if they overlap, the array will be returned unchanged
  *
@@ -50,7 +50,7 @@ declare function move<Item extends PlainObject, ItemKey extends keyof Item>(arra
 /**
  * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
  *
- * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item.
+ * When moving to the front of the array, the moved items will be placed __before__ the target item. When moving to the back of the array, the moved items will be placed __after__ the target item
  *
  * If either of values are not present in the array, or if they overlap, the array will be returned unchanged
  *
@@ -78,7 +78,7 @@ declare namespace move {
  *
  * If the from index is out of bounds, the array will be returned unchanged
  *
- * Available as `moveIndices` and `move.indices`
+ * _Available as `moveIndices` and `move.indices`_
  *
  * @param array Array to move within
  * @param from Index to move from
@@ -100,7 +100,7 @@ declare function moveIndices<Item>(array: Item[], from: number, to: number): Ite
  *
  * If the value is not present in the array, or if the index is out of bounds, the array will be returned unchanged
  *
- * Available as `moveToIndex` and `move.toIndex`
+ * _Available as `moveToIndex` and `move.toIndex`_
  *
  * @example
  * ```typescript
@@ -123,7 +123,7 @@ declare function moveToIndex<Item>(array: Item[], value: Item | Item[], index: n
  *
  * If the value is not present in the array, or if the index is out of bounds, the array will be returned unchanged
  *
- * Available as `moveToIndex` and `move.toIndex`
+ * _Available as `moveToIndex` and `move.toIndex`_
  *
  * @param array Array to move within
  * @param value Item or items to move
@@ -146,7 +146,7 @@ declare function moveToIndex<Item extends PlainObject, ItemKey extends keyof Ite
  *
  * If the value is not present in the array, or if the index is out of bounds, the array will be returned unchanged
  *
- * Available as `moveToIndex` and `move.toIndex`
+ * _Available as `moveToIndex` and `move.toIndex`_
  *
  * @param array Array to move within
  * @param value Item or items to move

package/dist/array/move.mjs

@@ -30,7 +30,7 @@ move.toIndex = moveToIndex;
 *
 * If the from index is out of bounds, the array will be returned unchanged
 *
-* Available as `moveIndices` and `move.indices`
+* _Available as `moveIndices` and `move.indices`_
 *
 * @param array Array to move within
 * @param from Index to move from

package/dist/array/select.d.mts

@@ -101,6 +101,7 @@ declare function select<Item extends PlainObject, ItemKey extends keyof Item, Ma
 declare function select<Item, FilterCallback extends (item: Item, index: number, array: Item[]) => unknown, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filterCallback: FilterCallback, filterValue: ReturnType<FilterCallback>, mapCallback: MapCallback): Array<ReturnType<MapCallback>>;
 /**
  * Get a filtered and mapped array of items
+ *
  * @param array Array to search in
  * @param filterCallback Filter callback to match items
  * @param mapKey Key to get an item's value for mapping

package/dist/array/slice.d.mts

@@ -68,7 +68,7 @@ declare function drop<Item extends PlainObject>(array: Item[], callback: (item:
  */
 declare function drop(array: unknown[], count: number): unknown[];
 /**
- * Slice an array, returning a new array with a specified range of items
+ * Slice an array _(returning a new array with a specified range of items)_
  *
  * @param array Original array
  * @param start Start index _(inclusive)_
@@ -82,7 +82,7 @@ declare function drop(array: unknown[], count: number): unknown[];
  */
 declare function slice<Item>(array: Item[], start: number, end: number): Item[];
 /**
- * Slice an array, returning a new array with a specified number of items _(from the start)_
+ * Slice an array _(returning a new array with a specified number of items, from the start)_
  *
  * @param array Original array
  * @param count Maximum size of the new array
@@ -95,7 +95,7 @@ declare function slice<Item>(array: Item[], start: number, end: number): Item[];
  */
 declare function slice<Item>(array: Item[], count: number): Item[];
 /**
- * Slice an array
+ * Slice an array _(returning a new array with all items)_
  *
  * @param array Array to slice
  * @returns Sliced array

package/dist/array/sort.d.mts

@@ -101,7 +101,7 @@ type Sorter<Item> = {
  *
  * _(If the array is not sorted, it will be treated as sorted, and the result may be inaccurate)_
  *
- * Available as `getSortedIndex` and `sort.getIndex`
+ * _Available as `getSortedIndex` and `sort.getIndex`_
  *
  * @param array Array to get the index from
  * @param item Item to get the index for
@@ -115,7 +115,7 @@ declare function getSortedIndex<Item>(array: Item[], item: Item, sorters: Array<
  *
  * _(If the array is not sorted, it will be treated as sorted, and the result may be inaccurate)_
  *
- * Available as `getSortedIndex` and `sort.getIndex`
+ * _Available as `getSortedIndex` and `sort.getIndex`_
  *
  * @param array Array to get the index from
  * @param item Item to get the index for
@@ -129,7 +129,7 @@ declare function getSortedIndex<Item>(array: Item[], item: Item, sorter: ArraySo
  *
  * _(If the array is not sorted, it will be treated as sorted, and the result may be inaccurate)_
  *
- * Available as `getSortedIndex` and `sort.getIndex`
+ * _Available as `getSortedIndex` and `sort.getIndex`_
  *
  * @param array Array to get the index from
  * @param item Item to get the index for
@@ -140,7 +140,7 @@ declare function getSortedIndex<Item>(array: Item[], item: Item, descending?: bo
 /**
  * Initialize a sort handler with sorters _(and an optional default direction)_
  *
- * Available as `initializeSorter` and `sort.initialize`
+ * _Available as `initializeSorter` and `sort.initialize`_
  *
  * @param sorters Sorters to use for sorting
  * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
@@ -150,7 +150,7 @@ declare function initializeSorter<Item>(sorters: Array<ArraySorter<Item>>, desce
 /**
  * Initialize a sort handler with a sorter _(and an optional default direction)_
  *
- * Available as `initializeSorter` and `sort.initialize`
+ * _Available as `initializeSorter` and `sort.initialize`_
  *
  * @param sorter Sorter to use for sorting
  * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
@@ -160,7 +160,7 @@ declare function initializeSorter<Item>(sorter: ArraySorter<Item>, descending?:
 /**
  * Initialize a sort handler _(with an optional default direction)_
  *
- * Available as `initializeSorter` and `sort.initialize`
+ * _Available as `initializeSorter` and `sort.initialize`_
  *
  * @param descending Sort in descending order? _(defaults to `false`)_
  * @returns Sort handler
@@ -187,7 +187,7 @@ declare function isSorted<Item>(array: Item[], sorter: ArraySorter<Item>, descen
 /**
  * Is the array sorted?
  *
- * Available as `isSorted` and `sort.is`
+ * _Available as `isSorted` and `sort.is`_
  *
  * @param array Array to check
  * @param descending Sorted in descending order? _(defaults to `false`)_
@@ -213,6 +213,7 @@ declare function isSorted<Item>(array: Item[], descending?: boolean): boolean;
 declare function sort<Item>(array: Item[], comparator: (first: Item, second: Item) => number, descending?: boolean): Item[];
 /**
  * Sort an array of items, using multiple sorters to sort by specific values
+ *
  * @param array Array to sort
  * @param sorters Sorters to use for sorting
  * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
@@ -221,6 +222,7 @@ declare function sort<Item>(array: Item[], comparator: (first: Item, second: Ite
 declare function sort<Item>(array: Item[], sorters: Array<ArraySorter<Item>>, descending?: boolean): Item[];
 /**
  * Sort an array of items, using a single sorter to sort by a specific value
+ *
  * @param array Array to sort
  * @param sorter Sorter to use for sorting
  * @param descending Sort in descending order? _(defaults to `false`; overridden by individual sorters)_
@@ -229,6 +231,7 @@ declare function sort<Item>(array: Item[], sorters: Array<ArraySorter<Item>>, de
 declare function sort<Item>(array: Item[], sorter: ArraySorter<Item>, descending?: boolean): Item[];
 /**
  * Sort an array of items
+ *
  * @param array Array to sort
  * @param descending Sort in descending order? _(defaults to `false`)_
  * @returns Sorted array

package/dist/array/sort.mjs

@@ -6,7 +6,7 @@ function getComparisonSorter(callback, modifier) {
 		modifier,
 		compare: { simple: callback },
 		get: false,
-		identifier: String(callback)
+		identifier: callback.toString()
 	};
 }
 function getComparisonValue(first, second, sorters, length) {
@@ -75,11 +75,12 @@ function getSorters(value, modifier) {
 	return sorters.filter((value, index, array) => array.findIndex((next) => next.identifier === value.identifier) === index);
 }
 function getValueSorter(value, modifier) {
+	const isFunction = typeof value === "function";
 	return {
 		modifier,
 		get: true,
-		identifier: String(value),
-		value: typeof value === "function" ? value : (item) => item[value]
+		identifier: isFunction ? value.toString() : value,
+		value: isFunction ? value : (item) => item[value]
 	};
 }
 function initializeSorter(first, second) {

package/dist/array/swap.d.mts

@@ -175,7 +175,7 @@ declare namespace swap {
  *
  * If either index is out of bounds, the array will be returned unchanged
  *
- * Available as `swapIndices` and `swap.indices`
+ * _Available as `swapIndices` and `swap.indices`_
  *
  * @param array Array of items to swap
  * @param first First index _(can be negative to count from the end)_

package/dist/array/swap.mjs

@@ -33,7 +33,7 @@ function swapArrays(array, from, to, key) {
 *
 * If either index is out of bounds, the array will be returned unchanged
 *
-* Available as `swapIndices` and `swap.indices`
+* _Available as `swapIndices` and `swap.indices`_
 *
 * @param array Array of items to swap
 * @param first First index _(can be negative to count from the end)_