From fb8653c95016d393ccbbe6441f9952ed333d8e2d Mon Sep 17 00:00:00 2001 From: Joon Ho Cho Date: Fri, 8 Apr 2016 18:45:51 -0700 Subject: add faker.random.arrayElements --- lib/random.js | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) (limited to 'lib') diff --git a/lib/random.js b/lib/random.js index d3cbf3ea..6b5544da 100644 --- a/lib/random.js +++ b/lib/random.js @@ -66,6 +66,34 @@ function Random (faker, seed) { return array[r]; } + /** + * takes an array and returns a subset with random elements of the array + * + * @method faker.random.arrayElement + * @param {array} array + * @param {number} count number of elements to pick + */ + this.arrayElements = function (array, count) { + array = array || ["a", "b", "c"]; + + if (typeof count !== 'number') { + count = faker.random.number({ min: 1, max: array.length }); + } else if (count > array.length) { + count = array.length; + } else if (count < 0) { + count = 0; + } + + var arrayCopy = array.slice(); + var countToRemove = arrayCopy.length - count; + for (var i = 0; i < countToRemove; i++) { + var indexToRemove = faker.random.number({ max: arrayCopy.length - 1 }); + arrayCopy.splice(indexToRemove, 1); + } + + return arrayCopy; + } + /** * takes an object and returns the randomly key or value * -- cgit v1.2.3