Merge pull request #366 from joonhocho/master

[api] Add `faker.random.arrayElements`

1 files changed, 28 insertions, 0 deletions

diff --git a/lib/random.js b/lib/random.js
index 21151213..84c39911 100644
--- a/lib/random.js
+++ b/lib/random.js
@@ -69,6 +69,34 @@ function Random (faker, seed) {
   }
 
   /**
+   * 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
    *
    * @method faker.random.objectElement