forked from denoland/std
-
Notifications
You must be signed in to change notification settings - Fork 0
/
sample.ts
23 lines (21 loc) · 700 Bytes
/
sample.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
// This module is browser compatible.
import { randomInteger } from "./_utils.ts";
/**
* Returns a random element from the given array
*
* @example
* ```ts
* import { sample } from "https://deno.land/std@$STD_VERSION/collections/sample.ts";
* import { assert } from "https://deno.land/std@$STD_VERSION/assert/assert.ts";
*
* const numbers = [1, 2, 3, 4];
* const random = sample(numbers);
*
* assert(numbers.includes(random as number));
* ```
*/
export function sample<T>(array: readonly T[]): T | undefined {
const length = array.length;
return length ? array[randomInteger(0, length - 1)] : undefined;
}