summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/person/first.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/person/first.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/person/first.md')
-rw-r--r--src/node_modules/chance/docs/person/first.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/person/first.md b/src/node_modules/chance/docs/person/first.md
new file mode 100644
index 0000000..cd92644
--- /dev/null
+++ b/src/node_modules/chance/docs/person/first.md
@@ -0,0 +1,31 @@
+# first
+
+```js
+// usage
+chance.first()
+chance.first({ nationality: 'us' })
+```
+
+Generate a random first name
+
+```js
+Chance.first();
+=> 'Leila'
+```
+
+Optionally specify a gender to limit first names to that gender
+
+```js
+Chance.first({ gender: "female" });
+=> 'Emma'
+```
+
+Optionally specify a nationality to limit first names to those most common of that nationality
+
+```js
+Chance.first({ nationality: "it" });
+=> 'Alberto'
+```
+
+Note, currently support for nationality is limited to: `'us', 'it'`.
+