@oscarpalmer/atoms 0.184.2 → 0.185.0

package/dist/result/work/pipe.d.mts

@@ -6,7 +6,7 @@ type WrapValue<Value> = Result<UnwrapValue<Value>>;
 /**
  * Attempt to pipe a value through a function
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -14,7 +14,7 @@ declare function attemptAsyncPipe<Initial, Piped>(initial: GenericCallback | Ini
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -22,7 +22,7 @@ declare function attemptAsyncPipe<Initial, First, Second>(initial: GenericCallba
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -30,7 +30,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third>(initial: Generi
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -38,7 +38,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth>(initial
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -46,7 +46,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth>(
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -54,7 +54,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth,
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -62,7 +62,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth,
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -70,7 +70,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth,
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -78,7 +78,7 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth,
 /**
  * Attempt to pipe a value through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial value
  * @returns Piped result
  */
@@ -86,95 +86,73 @@ declare function attemptAsyncPipe<Initial, First, Second, Third, Fourth, Fifth,
 /**
  * Attempt to pipe a result through a series of functions
  *
- * Available as `attemptAsyncPipe` and `attempt.pipe.async`
+ * Available as `attemptAsyncPipe` and `attemptPipe.async`
  * @param initial Initial result
  * @returns Piped result
  */
 declare function attemptAsyncPipe<Initial>(initial: GenericCallback | Initial | Promise<Initial> | Result<Initial>, first?: (value: UnwrapValue<Initial>) => unknown, ...seconds: Array<(value: unknown) => unknown>): Promise<WrapValue<Initial>>;
 /**
  * Attempt to pipe a value through a function
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, Pipe>(initial: GenericCallback | Initial | Result<Initial>, pipe: (value: UnwrapValue<Initial>) => Pipe): WrapValue<Pipe>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second): WrapValue<Second>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third): WrapValue<Third>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth): WrapValue<Fourth>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth): WrapValue<Fifth>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth): WrapValue<Sixth>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh): WrapValue<Seventh>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth): WrapValue<Eighth>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth): WrapValue<Ninth>;
 /**
  * Attempt to pipe a value through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial value
  * @returns Piped result
  */
 declare function attemptPipe<Initial, First, Second, Third, Fourth, Fifth, Sixth, Seventh, Eighth, Ninth, Tenth>(initial: GenericCallback | Initial | Result<Initial>, first: (value: UnwrapValue<Initial>) => First, second: (value: UnwrapValue<First>) => Second, third: (value: UnwrapValue<Second>) => Third, fourth: (value: UnwrapValue<Third>) => Fourth, fifth: (value: UnwrapValue<Fourth>) => Fifth, sixth: (value: UnwrapValue<Fifth>) => Sixth, seventh: (value: UnwrapValue<Sixth>) => Seventh, eighth: (value: UnwrapValue<Seventh>) => Eighth, ninth: (value: UnwrapValue<Eighth>) => Ninth, tenth: (value: UnwrapValue<Ninth>) => Tenth): WrapValue<Tenth>;
 /**
  * Attempt to pipe a result through a series of functions
- *
- * Available as `attemptPipe` and `attempt.pipe`
  * @param initial Initial result
  * @returns Piped result
  */

package/dist/sized/set.d.mts

@@ -1,7 +1,8 @@
 //#region src/sized/set.d.ts
 /**
- * - A Set with a maximum size
- * - Behavior is similar to a _LRU_-cache, where the oldest values are removed
+ * A Set with a maximum size
+ *
+ * Behavior is similar to a _LRU_-cache, where the oldest values are removed
  */
 declare class SizedSet<Value = unknown> extends Set<Value> {
   #private;

package/dist/sized/set.mjs

@@ -1,8 +1,9 @@
 import { getSizedMaximum } from "../internal/sized.mjs";
 //#region src/sized/set.ts
 /**
-* - A Set with a maximum size
-* - Behavior is similar to a _LRU_-cache, where the oldest values are removed
+* A Set with a maximum size
+*
+* Behavior is similar to a _LRU_-cache, where the oldest values are removed
 */
 var SizedSet = class extends Set {
 	/**

package/dist/value/handle.mjs

@@ -1,4 +1,4 @@
-import { getValue } from "../internal/value/get.mjs";
 import { hasValue } from "../internal/value/has.mjs";
+import { getValue } from "../internal/value/get.mjs";
 import { setValue } from "../internal/value/set.mjs";
 export { getValue, hasValue, setValue };

package/dist/value/shake.d.mts

@@ -1,6 +1,9 @@
 import { PlainObject } from "../models.mjs";
 
 //#region src/value/shake.d.ts
+/**
+ * A shaken object, without any `undefined` values
+ */
 type Shaken<Value extends PlainObject> = { [Key in keyof Value]: Value[Key] extends undefined ? never : Value[Key] };
 /**
  * Shake an object, removing all keys with `undefined` values

package/dist/value/smush.d.mts

@@ -1,6 +1,9 @@
 import { NestedKeys, NestedValue, PlainObject, Simplify, ToString } from "../models.mjs";
 
 //#region src/value/smush.d.ts
+/**
+ * A smushed object, with all nested objects flattened into a single level, using dot notation keys
+ */
 type Smushed<Value extends PlainObject> = Simplify<{ [NestedKey in NestedKeys<Value>]: NestedValue<Value, ToString<NestedKey>> }>;
 /**
  * Smush an object into a flat object that uses dot notation keys

package/dist/value/transform.d.mts

@@ -1,8 +1,17 @@
 import { PlainObject } from "../models.mjs";
 
 //#region src/value/transform.d.ts
+/**
+ * A callback transform an object's properties
+ */
 type TransformCallback<Value extends PlainObject, Key extends keyof Value> = (key: Key, value: Value[Key]) => Value[Key];
+/**
+ * A collection of keyed callbacks to transform an object's properties
+ */
 type TransformCallbacks<Value extends PlainObject> = Partial<{ [Key in keyof Value]: (value: Value[Key]) => Value[Key] }>;
+/**
+ * A transformer function for an object, with predefined callbacks for transforming its properties
+ */
 type Transformer<Value extends PlainObject> = {
   (value: Value): Value;
 };

package/dist/value/unsmush.d.mts

@@ -9,6 +9,9 @@ type KeysOfUnion<ObjectType> = keyof UnionToIntersection<ObjectType extends unkn
  * Thanks, type-fest!
  */
 type UnionToIntersection<Union> = (Union extends unknown ? (distributedUnion: Union) => void : never) extends ((mergedIntersection: infer Intersection) => void) ? Intersection & Union : never;
+/**
+ * An unsmushed object, with all dot notation keys turned into nested keys
+ */
 type Unsmushed<Value extends PlainObject> = Simplify<Omit<{ [UnionKey in KeysOfUnion<Value>]: Value[UnionKey] }, `${string}.${string}`>>;
 /**
  * Unsmush a smushed object _(turning dot notation keys into nested keys)_

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@oscarpalmer/atoms",
-	"version": "0.184.2",
+	"version": "0.185.0",
 	"description": "Atomic utilities for making your JavaScript better.",
 	"keywords": [
 		"helper",
@@ -253,7 +253,7 @@
 		"watch": "npx vite build --watch"
 	},
 	"devDependencies": {
-		"@oxlint/plugins": "^1.61",
+		"@oxlint/plugins": "^1.62",
 		"@types/node": "^25.6",
 		"@vitest/coverage-istanbul": "^4.1",
 		"eslint": "^10.2",

package/src/array/difference.ts

@@ -1,6 +1,8 @@
 import {COMPARE_SETS_DIFFERENCE, compareSets} from '../internal/array/sets';
 import type {PlainObject} from '../models';
 
+// #region Functions
+
 /**
  * Get the items from the first array that are not in the second array
  * @param first First array
@@ -38,3 +40,5 @@ export function difference<First, Second>(first: First[], second: Second[]): Fir
 export function difference(first: unknown[], second: unknown[], key?: unknown): unknown[] {
 	return compareSets(COMPARE_SETS_DIFFERENCE, first, second, key);
 }
+
+// #endregion

package/src/array/from.ts

@@ -1,3 +1,5 @@
+// #region Functions
+
 /**
  * Get an array with a specified length, filled with indices
  * @param length Length of the array
@@ -87,3 +89,5 @@ export function times(length: number, value?: unknown): unknown[] {
 
 	return values;
 }
+
+// #endregion

package/src/array/index.ts

@@ -12,7 +12,7 @@ export * from './get';
 export * from './insert';
 export * from './intersection';
 export * from './partition';
-export * from './position';
+export * from './match';
 export * from './push';
 export * from './reverse';
 export * from './select';

package/src/array/intersection.ts

@@ -1,5 +1,7 @@
 import {COMPARE_SETS_INTERSECTION, compareSets} from '../internal/array/sets';
 
+// #region Functions
+
 /**
  * Get the common values between two arrays
  * @param first First array
@@ -37,3 +39,5 @@ export function intersection<First, Second>(first: First[], second: Second[]): F
 export function intersection(first: unknown[], second: unknown[], key?: unknown): unknown[] {
 	return compareSets(COMPARE_SETS_INTERSECTION, first, second, key);
 }
+
+// #endregion

package/src/array/{position.ts → match.ts}

@@ -1,9 +1,12 @@
-// #region Types
-
 import {getArrayCallback} from '../internal/array/callbacks';
 import type {PlainObject} from '../models';
 
-export type ArrayPosition = 'end' | 'inside' | 'invalid' | 'outside' | 'same' | 'start';
+// #region Types
+
+/**
+ * Comparison of an array within another array
+ */
+export type ArrayComparison = 'end' | 'inside' | 'invalid' | 'outside' | 'same' | 'start';
 
 // #endregion
 
@@ -54,11 +57,11 @@ export function endsWithArray(haystack: unknown[], needle: unknown[], key?: unkn
  * @param key Key to get an item's value for matching
  * @returns Position of the needle within the haystack
  */
-export function getArrayPosition<Item extends PlainObject>(
+export function getArrayComparison<Item extends PlainObject>(
 	haystack: Item[],
 	needle: Item[],
 	key: keyof Item,
-): ArrayPosition;
+): ArrayComparison;
 
 /**
  * Get the position of an array within another array
@@ -67,11 +70,11 @@ export function getArrayPosition<Item extends PlainObject>(
  * @param callback Callback to get an item's value for matching
  * @returns Position of the needle within the haystack
  */
-export function getArrayPosition<Item>(
+export function getArrayComparison<Item>(
 	haystack: Item[],
 	needle: Item[],
 	callback: (item: Item, index: number, array: Item[]) => unknown,
-): ArrayPosition;
+): ArrayComparison;
 
 /**
  * Get the position of an array within another array
@@ -79,29 +82,29 @@ export function getArrayPosition<Item>(
  * @param needle Needle array
  * @returns Position of the needle within the haystack
  */
-export function getArrayPosition<Item>(haystack: Item[], needle: Item[]): ArrayPosition;
+export function getArrayComparison<Item>(haystack: Item[], needle: Item[]): ArrayComparison;
 
-export function getArrayPosition(
+export function getArrayComparison(
 	haystack: unknown[],
 	needle: unknown[],
 	key?: unknown,
-): ArrayPosition {
+): ArrayComparison {
 	return getPosition(haystack, needle, key)[1];
 }
 
-function getName(start: number, haystack: number, needle: number): ArrayPosition {
+function getName(start: number, haystack: number, needle: number): ArrayComparison {
 	if (start === 0) {
-		return haystack === needle ? POSITION_SAME : POSITION_START;
+		return haystack === needle ? COMPARISON_SAME : COMPARISON_START;
 	}
 
-	return start + needle === haystack ? POSITION_END : POSITION_INSIDE;
+	return start + needle === haystack ? COMPARISON_END : COMPARISON_INSIDE;
 }
 
 function getPosition(
 	haystack: unknown[],
 	needle: unknown[],
 	key?: unknown,
-): readonly [number, ArrayPosition] {
+): readonly [number, ArrayComparison] {
 	if (!Array.isArray(haystack) || !Array.isArray(needle)) {
 		return invalid;
 	}
@@ -278,26 +281,26 @@ export function startsWithArray(haystack: unknown[], needle: unknown[], key?: un
 
 // #region Variables
 
-const POSITION_END: ArrayPosition = 'end';
+const COMPARISON_END: ArrayComparison = 'end';
 
-const POSITION_INSIDE: ArrayPosition = 'inside';
+const COMPARISON_INSIDE: ArrayComparison = 'inside';
 
-const POSITION_INVALID: ArrayPosition = 'invalid';
+const COMPARISON_INVALID: ArrayComparison = 'invalid';
 
-const POSITION_OUTSIDE: ArrayPosition = 'outside';
+const COMPARISON_OUTSIDE: ArrayComparison = 'outside';
 
-const POSITION_SAME: ArrayPosition = 'same';
+const COMPARISON_SAME: ArrayComparison = 'same';
 
-const POSITION_START: ArrayPosition = 'start';
+const COMPARISON_START: ArrayComparison = 'start';
 
-const endings = new Set<ArrayPosition>([POSITION_END, POSITION_SAME]);
+const endings = new Set<ArrayComparison>([COMPARISON_END, COMPARISON_SAME]);
 
-const invalid = [-1, POSITION_INVALID] as const;
+const invalid = [-1, COMPARISON_INVALID] as const;
 
-const outside = [-1, POSITION_OUTSIDE] as const;
+const outside = [-1, COMPARISON_OUTSIDE] as const;
 
-const outsides = new Set<ArrayPosition>([POSITION_INVALID, POSITION_OUTSIDE]);
+const outsides = new Set<ArrayComparison>([COMPARISON_INVALID, COMPARISON_OUTSIDE]);
 
-const starts = new Set<ArrayPosition>([POSITION_START, POSITION_SAME]);
+const starts = new Set<ArrayComparison>([COMPARISON_START, COMPARISON_SAME]);
 
 // #endregion

package/src/array/move.ts

@@ -1,6 +1,8 @@
 import {arraysOverlap} from '../internal/array/overlap';
 import type {PlainObject} from '../models';
-import {indexOfArray} from './position';
+import {indexOfArray} from './match';
+
+// #region Functions
 
 /**
  * Move an item _(or array of items)_ to the position of another item _(or array of items)_ within an array
@@ -239,3 +241,5 @@ export function moveToIndex(
 
 	return array;
 }
+
+// #endregion

package/src/array/reverse.ts

@@ -1,3 +1,5 @@
+// #region Functions
+
 /**
  * Reverse the order of items in an array
  * @param array Array to reverse
@@ -26,3 +28,5 @@ export function reverse<Item>(array: Item[]): Item[] {
 
 	return array;
 }
+
+// #endregion Functions

package/src/array/select.ts

@@ -1,6 +1,8 @@
 import {FIND_VALUES_ALL, findValues} from '../internal/array/find';
 import type {PlainObject} from '../models';
 
+// #region Functions
+
 /**
  * Get a filtered and mapped array of items
  * @param array Array to search in

package/src/array/sort.ts

@@ -104,6 +104,11 @@ type InternalSorterCompare = {
  */
 export type SortDirection = 'ascending' | 'descending';
 
+/**
+ * Sorter for an array with predefined sorters
+ *
+ * Can be used to sort an array, get the predicted index for an item, and check if an array is sorted
+ */
 export type Sorter<Item> = {
 	/**
 	 * Sort an array of items
@@ -245,7 +250,7 @@ function getObjectSorter(obj: PlainObject, modifier: number): InternalSorter | u
  *
  * _(If the array is not sorted, it will be treated as sorted, and the result may be inaccurate)_
  *
- * Available as `getSortedIndex` and `sort.index`
+ * Available as `getSortedIndex` and `sort.getIndex`
  * @param array Array to get the index from
  * @param item Item to get the index for
  * @param sorters Sorters to use to determine sorting
@@ -264,7 +269,7 @@ export function getSortedIndex<Item>(
  *
  * _(If the array is not sorted, it will be treated as sorted, and the result may be inaccurate)_
  *
- * Available as `getSortedIndex` and `sort.index`
+ * Available as `getSortedIndex` and `sort.getIndex`
  * @param array Array to get the index from
  * @param item Item to get the index for
  * @param sorter Sorter to use to determine sorting
@@ -283,7 +288,7 @@ export function getSortedIndex<Item>(
  *
  * _(If the array is not sorted, it will be treated as sorted, and the result may be inaccurate)_
  *
- * Available as `getSortedIndex` and `sort.index`
+ * Available as `getSortedIndex` and `sort.getIndex`
  * @param array Array to get the index from
  * @param item Item to get the index for
  * @param descending Sorted in descending order? _(defaults to `false`)_
@@ -552,7 +557,7 @@ function sortArray(array: unknown[], sorters: InternalSorter[]): unknown[] {
 		: array;
 }
 
-sort.index = getSortedIndex;
+sort.getIndex = getSortedIndex;
 sort.initialize = initializeSorter;
 sort.is = isSorted;
 

package/src/array/swap.ts

@@ -2,7 +2,9 @@ import {getArrayCallback} from '../internal/array/callbacks';
 import {indexOf} from '../internal/array/index-of';
 import {arraysOverlap} from '../internal/array/overlap';
 import type {PlainObject} from '../models';
-import {indexOfArray} from './position';
+import {indexOfArray} from './match';
+
+// #region Functions
 
 /**
  * Swap two smaller arrays within a larger array
@@ -211,3 +213,5 @@ function swapValues(array: unknown[], from: unknown, to: unknown, key?: unknown)
 
 	return swapIndices(array, first, second);
 }
+
+// #endregion

package/src/array/toggle.ts

@@ -1,6 +1,8 @@
 import {updateInArray} from '../internal/array/update';
 import type {PlainObject} from '../models';
 
+// #region Functions
+
 /**
  * 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
@@ -38,3 +40,5 @@ export function toggle<Item>(destination: Item[], toggled: Item[]): Item[];
 export function toggle(array: unknown[], values: unknown[], key?: unknown): unknown[] {
 	return updateInArray(array, values, key, false);
 }
+
+// #endregion

package/src/array/union.ts

@@ -1,5 +1,7 @@
 import {COMPARE_SETS_UNION, compareSets} from '../internal/array/sets';
 
+// #region Functions
+
 /**
  * Get the combined, unique values from two arrays
  * @param first First array
@@ -37,3 +39,5 @@ export function union<First, Second>(first: First[], second: Second[]): (First |
 export function union(first: unknown[], second: unknown[], key?: unknown): unknown[] {
 	return compareSets(COMPARE_SETS_UNION, first, second, key);
 }
+
+// #endregion

package/src/beacon.ts

@@ -4,6 +4,9 @@ import type {PlainObject} from './models';
 
 // #region Types
 
+/**
+ * A beacon is a lighthouse, holding an observable value that can be subscribed to and emitted from
+ */
 class Beacon<Value> {
 	readonly #options: Options;
 	readonly #state: BeaconState<Value>;
@@ -122,6 +125,9 @@ type BeaconState<Value> = {
 	value: Value;
 };
 
+/**
+ * An observable holds a value and allows observers to subscribe to changes in that value
+ */
 class Observable<Value> {
 	readonly #state: ObservableState<Value>;
 
@@ -186,6 +192,9 @@ type ObservableState<Value> = {
 	observers: Map<Subscription<Value>, Observer<Value>>;
 };
 
+/**
+ * An observer receives notifications from an observable
+ */
 type Observer<Value> = {
 	/**
 	 * Callback for when the observable is completed
@@ -203,6 +212,9 @@ type Observer<Value> = {
 
 type Options = Required<BeaconOptions<unknown>>;
 
+/**
+ * A subscription represents an active subscription to an observable, holding its state and allowing it to be destroyed or unsubscribed from
+ */
 class Subscription<Value> {
 	readonly #state: SubscriptionState<Value>;
 

package/src/color/index.ts

@@ -39,11 +39,8 @@ export {
 } from './misc/is';
 
 export {getNormalizedHex, hexToHsl, hexToHsla, hexToRgb, hexToRgba} from './space/hex';
-
 export {hslToHex, hslToRgb, hslToRgba} from './space/hsl';
-
 export {rgbToHex, rgbToHsl, rgbToHsla} from './space/rgb';
-
 export type {Color, HSLAColor, HSLColor, RGBAColor, RGBColor};
 
 // #endregion