es-toolkit/dist/fp/array/sample.d.mts

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

//#region src/fp/array/sample.d.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
 */
declare function sample<T>(): (array: readonly T[]) => T;
//#endregion
export { sample };