Gender 2.0.0

Author: Awilum

CHANGELOG.md

@@ -1,3 +1,10 @@
+<a name="2.0.0"></a>
+# [2.0.0](https://github.com/faker-javascript/gender) (2022-01-09)
+
+### BREAKING CHANGES
+
+* New function `gender` istead of `fakeGender`
+
 <a name="1.0.0"></a>
 # [1.0.0](https://github.com/faker-javascript/gender) (2022-01-09)
 * Initial release

README.md

@@ -15,15 +15,15 @@ $ npm install --save @fakerjs/gender
 ## Usage
 
 ```js
-import fakeGender from '@fakerjs/gender';
+import gender from '@fakerjs/gender';
 
-fakeGender();
+gender();
 //=> Female
 
-fakeGender({locale: 'ru_RU'});
+gender({locale: 'ru_RU'});
 //=> Женский
 
-fakeGender({extra: ['Gender'], locale: 'en_US'});
+gender({extra: ['Gender'], locale: 'en_US'});
 //=> Gender
 
 // Allowed extra: valid array

index.js

@@ -10,7 +10,7 @@ export default function fakeGender(options) {
             "Женский"
         ],
     };
-    let locale = ((options.locale === undefined) ? 'en_US' : options.locale);
+    let locale = options.locale || 'en_US';
     let gendersWithExtra = genders[locale].concat(options.extra || []);
     let randomGender = gendersWithExtra[Math.floor(Math.random() * gendersWithExtra.length)];
     return randomGender;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fakerjs/gender",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "Gender package provides functionality to generate a fake gender value.",
   "license": "MIT",
   "repository": "faker-javascript/gender",
@@ -25,6 +25,7 @@
   ],
   "keywords": [
     "fakerjs",
+    "faker",
     "fake",
     "random",
     "gender"

test.js

@@ -1,10 +1,15 @@
-import fakeGender from './index.js';
+import gender from './index.js';
 import test from 'ava';
 
-test('fakeGender return type to be string', t => {
-	t.is(typeof fakeGender(), 'string');
+test('gender return type to be string', t => {
+	t.is(typeof gender(), 'string');
 });
 
-test('fakeGender with locale and extra return type to be string', t => {
-	t.is(typeof fakeGender({locale: 'ru_RU', extra: ['gender']}), 'string');
+test('gender with locale and extra return type to be string', t => {
+	t.is(typeof gender({locale: 'ru_RU', extra: ['gender']}), 'string');
 });
+
+test('gender with locale ru_RU includes', t => {
+	t.true(["Женский", "Мужской"].includes(gender({locale: 'ru_RU'})));
+	t.false(["foo", "bar"].includes(gender({locale: 'ru_RU'})));
+});