es-toolkit/dist/array/sample.mjs

A state-of-the-art, high-performance JavaScript utility library with a small bundle size and strong type annotations.

//#region src/array/sample.ts
/**
* Returns a random element from an array.
*
* This function takes an array and returns a single element selected randomly from the array.
*
* @template T - The type of elements in the array.
* @param arr - The array to sample from.
* @returns A random element from the array.
*
* @example
* const array = [1, 2, 3, 4, 5];
* const randomElement = sample(array);
* // randomElement will be one of the elements from the array, selected randomly.
*/
function sample(arr) {
	return arr[Math.floor(Math.random() * arr.length)];
}
//#endregion
export { sample };