summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/helpers/pickset.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/chance/docs/helpers/pickset.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/helpers/pickset.md')
-rw-r--r--src/node_modules/chance/docs/helpers/pickset.md20
1 files changed, 20 insertions, 0 deletions
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']
+```