es-toolkit/docs/reference/array/sample.md
Minsoo Kim cf65b2c601
style(*): Setup prettier and apply formatting (#24)
* chore: add prettierrc

* chore: apply format with prettier config

* chore: eslint error fix
2024-06-04 17:19:26 +09:00

503 B

sample

Returns a random element from an array.

This function takes an array and returns a single element selected randomly from the array.

Signature

function sample<T>(arr: T[]): T;

Parameters

  • arr (T[]): The array to sample from.

Returns

(T): A random element from the array.

Examples

const array = [1, 2, 3, 4, 5];
const randomElement = sample(array);
// randomElement will be one of the elements from the array, selected randomly.