sample | /collections/sample.ts | std@0.181.0 | Deno

std/collections/sample.ts>sample

Deno standard library

denoland/deno_std

Menu

mod.ts (default module)

DeepMergeOptions

JoinToStringOptions

MergingStrategy

aggregateGroups

firstNotNullishOf

aggregate_groups.ts

aggregateGroups

associate_by.ts

associate_with.ts

binary_search_node.ts

BinarySearchNode

binary_search_tree.ts

BinarySearchTree

DeepMergeOptions

MergingStrategy

drop_last_while.ts

filter_entries.ts

filter_values.ts

first_not_nullish_of.ts

firstNotNullishOf

includes_value.ts

join_to_string.ts

JoinToStringOptions

map_not_nullish.ts

permutations.ts

red_black_node.ts

red_black_tree.ts

reduce_groups.ts

running_reduce.ts

sliding_windows.ts

take_last_while.ts

function sample

import { sample } from "https://dotland.deno.dev/std@0.181.0/collections/sample.ts";

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

Returns a random element from the given array

Examples

Example 1

import { sample } from "https://deno.land/std@0.181.0/collections/sample.ts";
import { assert } from "https://deno.land/std@0.181.0/testing/asserts.ts";

const numbers = [1, 2, 3, 4];
const random = sample(numbers);

assert(numbers.includes(random as number));

Type Parameters

T

Parameters

array: readonly T[]

Returns

T | undefined