summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/person/name.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/name.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/person/name.md')
-rw-r--r--src/node_modules/chance/docs/person/name.md63
1 files changed, 63 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/person/name.md b/src/node_modules/chance/docs/person/name.md
new file mode 100644
index 0000000..46ae9e9
--- /dev/null
+++ b/src/node_modules/chance/docs/person/name.md
@@ -0,0 +1,63 @@
+# name
+
+```js
+// usage
+chance.name()
+chance.name({ middle: true })
+chance.name({ middle_initial: true })
+chance.name({ prefix: true })
+chance.name({ nationality: 'en' })
+```
+
+Generate a random name
+
+```js
+ chance.name();
+ => 'Dafi Vatemi'
+```
+
+Optionally include the middle name
+
+```js
+ chance.name({ middle: true });
+ => 'Nelgatwu Powuku Heup'
+```
+
+
+Optionally include the middle initial
+
+```js
+ chance.name({ middle_initial: true });
+ => 'Ezme I Iza'
+```
+
+Optionally include the prefix
+
+```js
+ chance.name({ prefix: true });
+ => 'Doctor Suosat Am'
+```
+
+Optionally include the suffix
+
+```js
+ chance.name({ suffix: true });
+ => 'Fanny Baker Esq.'
+```
+
+Optionally specify a gender
+
+```js
+ chance.name({ gender: 'male' });
+ => "Patrick Copeland"
+```
+
+Optionally specify a nationality
+
+```js
+ chance.name({ nationality: 'it' });
+ => "Roberta Mazzetti"
+```
+
+Note, currently support for nationality is limited to: `'en', 'it'`.
+