summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/miscellaneous/n.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/miscellaneous/n.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/miscellaneous/n.md')
-rw-r--r--src/node_modules/chance/docs/miscellaneous/n.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/miscellaneous/n.md b/src/node_modules/chance/docs/miscellaneous/n.md
new file mode 100644
index 0000000..9c5249f
--- /dev/null
+++ b/src/node_modules/chance/docs/miscellaneous/n.md
@@ -0,0 +1,35 @@
+# n
+
+```js
+// usage
+chance.n(chance.email, 5)
+chance.n(chance.email, 5, { domain: "socialradar.com" })
+```
+
+Provide any function that generates random stuff (usually another **Chance** function) and a number and `n()` will generate an array of items with a length matching the length you specified.
+
+For example, to generate 5 email addresses:
+
+```js
+chance.n(chance.email, 5);
+=> [ 'nese@me.gov',
+'tukvogi@novew.co.uk',
+'worzi@jotok.edu',
+'wicumafom@lalu.edu',
+'hifebwo@abecusa.com' ]
+```
+
+Any options that would be sent to the random function can be added following the number.
+
+For example, `chance.email()` has options which can be specified, so you can generate 5 emails with a known domain as follows:
+
+```js
+chance.n(chance.email, 5, { domain: "socialradar.com" })
+=> [ 'nuvvu@socialradar.com',
+'icolul@socialradar.com',
+'rig@socialradar.com',
+'ca@socialradar.com',
+'uc@socialradar.com' ]
+```
+
+Note, these items are not guaranteed to be unique. If that is the intent, see [`chance.unique()`](http://chancejs.com/#unique)