@oscarpalmer/atoms 0.166.2 → 0.166.3

package/dist/array/difference.d.mts

@@ -16,7 +16,7 @@ declare function difference<First, Second>(first: First[], second: Second[], cal
  * @param key Key to get an item's value for comparison
  * @returns Unique values from the first array
  */
-declare function difference<First extends PlainObject, Second extends PlainObject, Key extends keyof First & keyof Second>(first: First[], second: Second[], key: Key): First[];
+declare function difference<First extends PlainObject, Second extends PlainObject, SharedKey extends keyof First & keyof Second>(first: First[], second: Second[], key: SharedKey): First[];
 /**
  * Get the items from the first array that are not in the second array
  * @param first First array

package/dist/array/exists.d.mts

@@ -16,7 +16,7 @@ declare function exists<Item, Callback extends (item: Item, index: number, array
  * @param value Value to match against
  * @returns `true` if the item exists in the array, otherwise `false`
  */
-declare function exists<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): boolean;
+declare function exists<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): boolean;
 /**
  * Does an item in the array match the filter?
  * @param array Array to search in

package/dist/array/filter.d.mts

@@ -16,7 +16,7 @@ declare function filter<Item, Callback extends (item: Item, index: number, array
  * @param value Value to match against
  * @returns Filtered array of items
  */
-declare function filter<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item[];
+declare function filter<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item[];
 /**
  * Get a filtered array of items matching the filter
  * @param array Array to search in
@@ -35,7 +35,7 @@ declare namespace filter {
   var remove: typeof removeFiltered;
 }
 declare function removeFiltered<Item, Callback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], callback: Callback, value: ReturnType<Callback>): unknown[];
-declare function removeFiltered<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): unknown[];
+declare function removeFiltered<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): unknown[];
 declare function removeFiltered<Item>(array: Item[], filter: (item: Item, index: number, array: Item[]) => boolean): unknown[];
 declare function removeFiltered<Item>(array: Item[], item: Item): unknown[];
 //#endregion

package/dist/array/find.d.mts

@@ -16,7 +16,7 @@ declare function find<Item, Callback extends (item: Item, index: number, array:
  * @param value Value to match against
  * @returns First item that matches the value, or `undefined` if no match is found
  */
-declare function find<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item | undefined;
+declare function find<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item | undefined;
 /**
  * Get the first item matching the filter
  * @param array Array to search in

package/dist/array/intersection.d.mts

@@ -14,7 +14,7 @@ declare function intersection<First, Second>(first: First[], second: Second[], c
  * @param key Key to get an item's value for comparison
  * @returns Common values from both arrays
  */
-declare function intersection<First extends Record<string, unknown>, Second extends Record<string, unknown>, Key extends keyof First & keyof Second>(first: First[], second: Second[], key: Key): First[];
+declare function intersection<First extends Record<string, unknown>, Second extends Record<string, unknown>, SharedKey extends keyof First & keyof Second>(first: First[], second: Second[], key: SharedKey): First[];
 /**
  * Get the common values between two arrays
  * @param first First array

package/dist/array/move.d.mts

@@ -13,7 +13,7 @@ import { PlainObject } from "../models.mjs";
  * @param key Key to get an item's value for matching
  * @returns Original array with items moved _(or unchanged if unable to move)_
  */
-declare function move<Item extends PlainObject, Key extends keyof Item>(array: Item[], from: Item | Item[], to: Item | Item[], key: Key): Item[];
+declare function move<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], from: Item | Item[], to: Item | Item[], key: ItemKey): Item[];
 /**
  * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
  *
@@ -63,7 +63,7 @@ declare function moveIndices<Item>(array: Item[], from: number, to: number): Ite
  * @param key Key to get an item's value for matching
  * @returns Original array with items moved _(or unchanged if unable to move)_
  */
-declare function moveToIndex<Item extends PlainObject, Key extends keyof Item>(array: Item[], value: Item | Item[], index: number, key: Key): Item[];
+declare function moveToIndex<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], value: Item | Item[], index: number, key: ItemKey): Item[];
 /**
  * Move an item _(or array of items)_ to an index within an array
  *

package/dist/array/partition.d.mts

@@ -16,7 +16,7 @@ declare function partition<Item, Callback extends (item: Item, index: number, ar
  * @param value Value to match against
  * @returns Partitioned array of items
  */
-declare function partition<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item[][];
+declare function partition<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item[][];
 /**
  * Get a partitioned array of items
  * @param array Array to search in

package/dist/array/select.d.mts

@@ -18,7 +18,7 @@ declare function select<Item, FilterCallback extends (item: Item, index: number,
  * @param mapCallback Callback to map the matched items
  * @returns Filtered and mapped array of items
  */
-declare function select<Item extends PlainObject, Key extends keyof Item, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filterKey: Key, filterValue: Item[Key], mapCallback: MapCallback): Array<ReturnType<MapCallback>>;
+declare function select<Item extends PlainObject, ItemKey extends keyof Item, MapCallback extends (item: Item, index: number, array: Item[]) => unknown>(array: Item[], filterKey: ItemKey, filterValue: Item[ItemKey], mapCallback: MapCallback): Array<ReturnType<MapCallback>>;
 /**
  * Get a filtered and mapped array of items
  * @param array Array to search in

package/dist/array/slice.d.mts

@@ -8,7 +8,7 @@ import { PlainObject } from "../models.mjs";
  * @param value Value to match against
  * @returns New array with items dropped
  */
-declare function drop<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item[];
+declare function drop<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item[];
 /**
  * Drop items from the start of an array until they match a value
  * @param array Original array
@@ -59,7 +59,7 @@ declare function slice<Item>(array: Item[]): Item[];
  * @param value Value to match against
  * @returns New array with taken items
  */
-declare function take<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key, value: Item[Key]): Item[];
+declare function take<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey, value: Item[ItemKey]): Item[];
 /**
  * Take items from the start of an array until they match a value
  * @param array Original array

package/dist/array/sort.d.mts

@@ -17,11 +17,11 @@ type ArrayComparisonSorter<Item> = {
 /**
  * Sorting information for arrays _(using a key)_
  */
-type ArrayKeySorter<Item extends PlainObject, Key extends keyof Item> = {
+type ArrayKeySorter<Item extends PlainObject, ItemKey extends keyof Item> = {
   /**
    * Comparator to use when comparing items and values
    */
-  compare?: CompareCallback<Item, Item[Key]>;
+  compare?: CompareCallback<Item, Item[ItemKey]>;
   /**
    * Direction to sort by
    */
@@ -29,12 +29,12 @@ type ArrayKeySorter<Item extends PlainObject, Key extends keyof Item> = {
   /**
    * Key to sort by
    */
-  key: Key;
+  key: ItemKey;
 };
 /**
  * Sorters based on keys in an object
  */
-type ArrayKeySorters<Item extends PlainObject> = { [Key in keyof Item]: ArrayKeySorter<Item, Key> }[keyof Item];
+type ArrayKeySorters<Item extends PlainObject> = { [ItemKey in keyof Item]: ArrayKeySorter<Item, ItemKey> }[keyof Item];
 /**
  * Sorting information for arrays _(using a value callback and built-in comparison)_
  */

package/dist/array/swap.d.mts

@@ -11,7 +11,7 @@ import { PlainObject } from "../models.mjs";
  * @param key Key to get an item's value for matching
  * @returns Original array with items swapped _(or unchanged if unable to swap)_
  */
-declare function swap<Item extends PlainObject, Key extends keyof Item>(array: Item[], first: Item[], second: Item[], key: Key): Item[];
+declare function swap<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], first: Item[], second: Item[], key: ItemKey): Item[];
 /**
  * Swap two smaller arrays within a larger array
  *
@@ -43,7 +43,7 @@ declare function swap<Item>(array: Item[], first: Item[], second: Item[]): Item[
  * @param key Key to get an item's value for matching
  * @returns Original array with items swapped _(or unchanged if unable to swap)_
  */
-declare function swap<Item extends PlainObject, Key extends keyof Item>(array: Item[], first: Item, second: Item, key: Key): Item[];
+declare function swap<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], first: Item, second: Item, key: ItemKey): Item[];
 /**
  * Swap two indiced items in an array
  *

package/dist/array/to-set.d.mts

@@ -14,7 +14,7 @@ declare function toSet<Item, Callback extends (item: Item, index: number, array:
  * @param key Key to use for value
  * @returns Set of values
  */
-declare function toSet<Item extends PlainObject, Key extends keyof Item>(array: Item[], key: Key): Set<Item[Key]>;
+declare function toSet<Item extends PlainObject, ItemKey extends keyof Item>(array: Item[], key: ItemKey): Set<Item[ItemKey]>;
 /**
  * Create a Set from an array of items
  * @param array Array to convert

package/dist/array/toggle.d.mts

@@ -16,7 +16,7 @@ declare function toggle<Item>(destination: Item[], toggled: Item[], callback: (i
  * @param key Key to find existing item
  * @returns Original array
  */
-declare function toggle<Item extends PlainObject, Key extends keyof Item>(destination: Item[], toggled: Item[], key: Key): Item[];
+declare function toggle<Item extends PlainObject, ItemKey extends keyof Item>(destination: Item[], toggled: Item[], key: ItemKey): Item[];
 /**
  * Toggle an item in an array: if the item exists, it will be removed; if it doesn't, it will be added
  * @param destination Array to toggle within

package/dist/array/union.d.mts

@@ -14,7 +14,7 @@ declare function union<First, Second>(first: First[], second: Second[], callback
  * @param key Key to get an item's value for comparison
  * @returns Combined, unique values from both arrays
  */
-declare function union<First extends Record<string, unknown>, Second extends Record<string, unknown>, Key extends keyof First & keyof Second>(first: First[], second: Second[], key: Key): (First | Second)[];
+declare function union<First extends Record<string, unknown>, Second extends Record<string, unknown>, SharedKey extends keyof First & keyof Second>(first: First[], second: Second[], key: SharedKey): (First | Second)[];
 /**
  * Get the combined, unique values from two arrays
  * @param first First array

package/dist/array/update.d.mts

@@ -16,7 +16,7 @@ declare function update<Item>(destination: Item[], updated: Item[], callback: (i
  * @param key Key to find existing item
  * @returns Original array
  */
-declare function update<Item extends PlainObject, Key extends keyof Item>(destination: Item[], updated: Item[], key: Key): Item[];
+declare function update<Item extends PlainObject, ItemKey extends keyof Item>(destination: Item[], updated: Item[], key: ItemKey): Item[];
 /**
  * Update an item in an array: if the item exists, it will be updated; if it doesn't, it will be added
  * @param destination Array to update within