feat: add item function (#265)

Author: ignatiusmb

workspace/mauss/src/random/index.ts

@@ -1,12 +1,20 @@
 import type { IndexSignature, TypedIntArray } from '../typings/aliases.js';
 
-/** Generates a random floating point number between `min` and `max` */
+/**
+ * Generates a random floating point number between `min` and `max`
+ * @default max=1
+ * @default min=0
+ */
 export function float(max = 1, min = 0): number {
 	[min, max] = [Math.ceil(min), Math.floor(max)];
 	return Math.random() * (max - min) + min;
 }
 
-/** Generates a random integer between `min` and `max` */
+/**
+ * Generates a random integer between `min` and `max`
+ * @default max=1
+ * @default min=0
+ */
 export function int(max = 1, min = 0): number {
 	return Math.floor(float(max, min));
 }
@@ -33,6 +41,11 @@ export function val<T>(dict: Record<IndexSignature, T>): T {
 	return values[int(values.length)];
 }
 
+/** Gets a random item from a list */
+export function item<T>(list: T[]): T {
+	return list[int(list.length)];
+}
+
 /** Generates a random hexadecimal color code */
 export function hex(): string {
 	return `#${~~(float() * (1 << 24)).toString(16)}`;