es-toolkit/dist/fp/array/sample.js

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

const require_sample = require("../../array/sample.js");
//#region src/fp/array/sample.ts
/**
* Creates a function that returns one random element from an array.
*
* The returned function follows the main {@link sample} behavior. Use it with {@link pipe}.
*
* @template T - The type of elements in the array.
* @returns A function that maps a readonly array to a random element.
*
* @example
* import { pipe, sample } from 'es-toolkit/fp';
*
* pipe([1, 2, 3], sample());
* // => one of 1, 2, or 3
*/
function sample() {
	return function(array) {
		return require_sample.sample(array);
	};
}
//#endregion
exports.sample = sample;