From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001
From: Minteck <contact@minteck.org>
Date: Tue, 21 Dec 2021 16:52:28 +0100
Subject: Commit

---
 src/node_modules/chance/docs/helpers/pickset.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)
 create mode 100644 src/node_modules/chance/docs/helpers/pickset.md

(limited to 'src/node_modules/chance/docs/helpers/pickset.md')

diff --git a/src/node_modules/chance/docs/helpers/pickset.md b/src/node_modules/chance/docs/helpers/pickset.md
new file mode 100644
index 0000000..3c3b393
--- /dev/null
+++ b/src/node_modules/chance/docs/helpers/pickset.md
@@ -0,0 +1,20 @@
+# pickset
+
+```js
+// usage
+chance.pickset(array, quantity)
+```
+
+Given an array, pick some random elements and return them in a new array
+
+```js
+chance.pickset(['alpha', 'bravo', 'charlie', 'delta', 'echo'], 3);
+=> ['echo', 'alpha', 'bravo']
+```
+
+Optionally omit the quantity to retrieve a set with length 1
+
+```js
+chance.pickset(['alpha', 'bravo', 'charlie', 'delta', 'echo']);
+=> ['delta']
+```
-- 
cgit