From 46e43f4bde4a35785b4997b81e86cd19f046b69b Mon Sep 17 00:00:00 2001 From: Minteck Date: Tue, 21 Dec 2021 16:52:28 +0100 Subject: Commit --- src/node_modules/chance/docs/person/first.md | 31 ++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 src/node_modules/chance/docs/person/first.md (limited to 'src/node_modules/chance/docs/person/first.md') 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'`. + -- cgit