@oscarpalmer/atoms 0.153.0 → 0.154.0

package/package.json

@@ -54,6 +54,10 @@
 			"types": "./types/function/index.d.ts",
 			"default": "./dist/function/index.js"
 		},
+		"./function/assert": {
+			"types": "./types/function/assert.d.ts",
+			"default": "./dist/function/assert.js"
+		},
 		"./function/retry": {
 			"types": "./types/function/retry.d.ts",
 			"default": "./dist/function/retry.js"
@@ -180,5 +184,5 @@
 	},
 	"type": "module",
 	"types": "./types/index.d.ts",
-	"version": "0.153.0"
-}
+	"version": "0.154.0"
+}

package/src/function/assert.ts

@@ -1,7 +1,19 @@
 import type {Constructor} from '../models';
 
+// #region Types
+
 export type Asserter<Value> = (value: unknown) => asserts value is Value;
 
+// #endregion
+
+// #region Functions
+
+/**
+ * Asserts that a condition is true, throwing an error if it is not
+ * @param condition Condition to assert
+ * @param message Error message
+ * @param error Error constructor
+ */
 export function assert<Condition extends () => boolean>(
 	condition: Condition,
 	message: string,
@@ -12,32 +24,78 @@ export function assert<Condition extends () => boolean>(
 	}
 }
 
-assert.condition = <Value>(
+assert.condition = assertCondition;
+assert.defined = assertDefined;
+assert.instanceOf = assertInstanceOf;
+assert.is = assertIs;
+
+/**
+ * Creates an asserter that asserts a condition is true, throwing an error if it is not
+ * @param condition Condition to assert
+ * @param message Error message
+ * @param error Error constructor
+ * @returns Asserter
+ */
+function assertCondition<Value>(
 	condition: (value: unknown) => boolean,
 	message: string,
 	error?: ErrorConstructor,
-): Asserter<Value> => {
+): Asserter<Value> {
 	return value => {
 		assert(() => condition(value), message, error);
 	};
-};
+}
+
+/**
+ * Asserts that a value is defined _(not `null` or `undefined`)_, throwing an error if it is not
+ * @param value Value to assert
+ * @param message Error message
+ */
+function assertDefined<Value>(
+	value: unknown,
+	message?: string,
+): asserts value is Exclude<Value, null | undefined> {
+	assert(() => value != null, message ?? MESSAGE_DEFINED);
+}
 
-assert.instanceOf = <Value>(
+/**
+ * Creates an asserter that asserts a value is an instance of a constructor, throwing an error if it is not
+ * @param constructor Constructor to check against
+ * @param message Error message
+ * @param error Error constructor
+ * @returns Asserter
+ */
+function assertInstanceOf<Value>(
 	constructor: Constructor<Value>,
 	message: string,
 	error?: ErrorConstructor,
-): Asserter<Value> => {
+): Asserter<Value> {
 	return value => {
 		assert(() => value instanceof constructor, message, error);
 	};
-};
+}
 
-assert.is = <Value>(
+/**
+ * Creates an asserter that asserts a value is of a specific type, throwing an error if it is not
+ * @param condition Type guard function to check the value
+ * @param message Error message
+ * @param error Error constructor
+ * @returns Asserter
+ */
+function assertIs<Value>(
 	condition: (value: unknown) => value is Value,
 	message: string,
 	error?: ErrorConstructor,
-): Asserter<Value> => {
+): Asserter<Value> {
 	return value => {
 		assert(() => condition(value), message, error);
 	};
-};
+}
+
+// #endregion
+
+// #region Variables
+
+const MESSAGE_DEFINED = 'Expected value to be defined';
+
+// #endregion

package/src/math.ts

@@ -154,10 +154,6 @@ export function median(array: unknown[], key?: unknown): number {
 		return Number.NaN;
 	}
 
-	if (length === 1) {
-		return isNumber(array[0]) ? array[0] : Number.NaN;
-	}
-
 	let values: unknown[] = array;
 
 	const callback = getAggregateCallback(key);
@@ -170,6 +166,10 @@ export function median(array: unknown[], key?: unknown): number {
 
 	length = numbers.length;
 
+	if (length === 1) {
+		return numbers[0];
+	}
+
 	if (length % 2 === 0) {
 		const first = length / 2 - 1;
 		const second = length / 2;