@technobuddha/library/dist/random-draw.d.ts

A large library of useful functions

/**
 * Draw a random item from a list.  Returning both the item and the list without the drawn item.
 * @param list - Array of items to pick from
 * @param random - Random number generator
 * @returns Randomly selected item & the list without the drawn item
 * @group Random
 * @category Pick
 * @example
 * ```typescript
 * const items = ['a', 'b', 'c'];
 * randomDraw(items, () => 0.5); // deterministic for example
 * // { draw: 'b', list: ['a', 'c'] }
 * ```
 */
export declare function randomDraw<T = unknown>(list: readonly T[], random?: () => number): {
    /** The item that was randomly drawn from the list */
    draw: T;
    /** The list with the drawn item removed */
    list: T[];
} | undefined;