clean-jsdoc-theme TypeDoc APIv0.0.0

sample

sample<T>(array: T[]): T | undefined

Source: array.ts:246

Picks a random element from an array

Type Parameters

  • T — Array element type

Parameters

  • array (T[]) — The input array

Returns

  • T | undefined — Random element or undefined if array is empty

Example

CODE
sample([1, 2, 3, 4, 5]) // 3 (random)
sample([]) // undefined