pip-services3-commons-nodex/src/random/RandomArray.ts

Portable abstractions and patterns for Pip.Services in Node.js / ES2017

/** @module random */
import { RandomInteger } from './RandomInteger';

/**
 * Random generator for array objects.
 * 
 * ### Example ###
 * 
 *     let value1 = RandomArray.pick([1, 2, 3, 4]); // Possible result: 3
 */
export class RandomArray {
    
    /**
     * Picks a random element from specified array.
     * 
     * @param values    an array of any type
     * @returns         a randomly picked item.
     */
    public static pick<T>(values: T[]): T {
        if (values == null || values.length == 0) {
            return null;
        }

        return values[RandomInteger.nextInteger(values.length)];
    }
}