@technobuddha > library > Random > Pick

Function: randomDraw()

function randomDraw<T>(list: readonly T[], random: () => number): 
  | undefined
  | {
  draw: T;
  list: T[];
};

Defined in: random-draw.ts:15

Draw a random item from a list. Returning both the item and the list without the drawn item.

Type Parameters

Type Parameter	Default type
T	unknown

Parameters

Parameter	Type	Default value	Description
list	readonly T[]	undefined	Array of items to pick from
random	() => number	Math.random	Random number generator

Returns

undefined

{
  draw: T;
  list: T[];
}

Name	Type	Description	Defined in
draw	T	The item that was randomly drawn from the list	src/random-draw.ts:21
list	T[]	The list with the drawn item removed	src/random-draw.ts:23

Randomly selected item & the list without the drawn item

Example

const items = ['a', 'b', 'c'];
randomDraw(items, () => 0.5); // deterministic for example
// { draw: 'b', list: ['a', 'c'] }