feat(name): extract sex generator from gender to sex

src/definitions/name.ts

@@ -5,7 +5,7 @@ import type { LocaleEntry } from './definitions';
  */
 export type NameDefinitions = LocaleEntry<{
   gender: string[];
-  binary_gender: string[];
+  sex: string[];
 
   prefix?: string[];
   female_prefix?: string[];

src/locales/en/name/index.ts

@@ -3,7 +3,6 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { NameDefinitions } from '../../..';
-import binary_gender from './binary_gender';
 import female_first_name from './female_first_name';
 import female_middle_name from './female_middle_name';
 import first_name from './first_name';
@@ -14,11 +13,11 @@ import male_middle_name from './male_middle_name';
 import middle_name from './middle_name';
 import name_ from './name';
 import prefix from './prefix';
+import sex from './sex';
 import suffix from './suffix';
 import title from './title';
 
 const name: NameDefinitions = {
-  binary_gender,
   female_first_name,
   female_middle_name,
   first_name,
@@ -29,6 +28,7 @@ const name: NameDefinitions = {
   middle_name,
   name: name_,
   prefix,
+  sex,
   suffix,
   title,
 };

src/locales/en/name/sex.ts

@@ -0,0 +1 @@
+export default ['female', 'male', 'non-binary'];

src/locales/fr/name/index.ts

@@ -3,23 +3,23 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { NameDefinitions } from '../../..';
-import binary_gender from './binary_gender';
 import female_first_name from './female_first_name';
 import first_name from './first_name';
 import last_name from './last_name';
 import male_first_name from './male_first_name';
 import name_ from './name';
 import prefix from './prefix';
+import sex from './sex';
 import title from './title';
 
 const name: NameDefinitions = {
-  binary_gender,
   female_first_name,
   first_name,
   last_name,
   male_first_name,
   name: name_,
   prefix,
+  sex,
   title,
 };
 

src/locales/fr_CH/name/index.ts

@@ -3,23 +3,23 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { NameDefinitions } from '../../..';
-import binary_gender from './binary_gender';
 import female_first_name from './female_first_name';
 import first_name from './first_name';
 import last_name from './last_name';
 import male_first_name from './male_first_name';
 import name_ from './name';
 import prefix from './prefix';
+import sex from './sex';
 import title from './title';
 
 const name: NameDefinitions = {
-  binary_gender,
   female_first_name,
   first_name,
   last_name,
   male_first_name,
   name: name_,
   prefix,
+  sex,
   title,
 };
 

src/locales/pt_BR/name/index.ts

@@ -3,24 +3,24 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { NameDefinitions } from '../../..';
-import binary_gender from './binary_gender';
 import female_first_name from './female_first_name';
 import first_name from './first_name';
 import last_name from './last_name';
 import male_first_name from './male_first_name';
 import name_ from './name';
 import prefix from './prefix';
+import sex from './sex';
 import suffix from './suffix';
 import title from './title';
 
 const name: NameDefinitions = {
-  binary_gender,
   female_first_name,
   first_name,
   last_name,
   male_first_name,
   name: name_,
   prefix,
+  sex,
   suffix,
   title,
 };

src/locales/ur/name/index.ts

@@ -3,24 +3,24 @@
  * Run 'pnpm run generate:locales' to update.
  */
 import type { NameDefinitions } from '../../..';
-import binary_gender from './binary_gender';
 import female_first_name from './female_first_name';
 import first_name from './first_name';
 import last_name from './last_name';
 import male_first_name from './male_first_name';
 import name_ from './name';
 import prefix from './prefix';
+import sex from './sex';
 import suffix from './suffix';
 import title from './title';
 
 const name: NameDefinitions = {
-  binary_gender,
   female_first_name,
   first_name,
   last_name,
   male_first_name,
   name: name_,
   prefix,
+  sex,
   suffix,
   title,
 };

src/modules/name/index.ts

@@ -1,4 +1,5 @@
 import type { Faker } from '../..';
+import { deprecated } from '../../internal/deprecated';
 
 export enum Gender {
   female = 'female',
@@ -180,22 +181,34 @@ export class Name {
   /**
    * Return a random gender.
    *
-   * @param binary Whether to return only binary gender names. Defaults to `false`.
-   *
    * @example
    * faker.name.gender() // 'Trans*Man'
-   * faker.name.gender(true) // 'Female'
    */
   gender(binary?: boolean): string {
     if (binary) {
-      return this.faker.helpers.arrayElement(
-        this.faker.definitions.name.binary_gender
-      );
+      deprecated({
+        deprecated: 'faker.name.gender(true)',
+        proposed: 'faker.name.sex()',
+        since: '7.4',
+        until: '8.0',
+      });
+
+      return this.faker.name.sex();
     }
 
     return this.faker.helpers.arrayElement(this.faker.definitions.name.gender);
   }
 
+  /**
+   * Return a random sex.
+   *
+   * @example
+   * faker.name.sex() // 'female'
+   */
+  sex(): string {
+    return this.faker.helpers.arrayElement(this.faker.definitions.name.sex);
+  }
+
   /**
    * Returns a random name prefix.
    *

test/__snapshots__/name.spec.ts.snap

@@ -20,6 +20,8 @@ exports[`name > seed: 42 > middleName() 1`] = `"Greer"`;
 
 exports[`name > seed: 42 > prefix() 1`] = `"Mrs."`;
 
+exports[`name > seed: 42 > sex() 1`] = `"male"`;
+
 exports[`name > seed: 42 > suffix() 1`] = `"III"`;
 
 exports[`name > seed: 1211 > findName() 1`] = `"Claude Trantow"`;
@@ -42,6 +44,8 @@ exports[`name > seed: 1211 > middleName() 1`] = `"Sawyer"`;
 
 exports[`name > seed: 1211 > prefix() 1`] = `"Dr."`;
 
+exports[`name > seed: 1211 > sex() 1`] = `"non-binary"`;
+
 exports[`name > seed: 1211 > suffix() 1`] = `"DVM"`;
 
 exports[`name > seed: 1337 > findName() 1`] = `"Leona Cronin"`;
@@ -64,4 +68,6 @@ exports[`name > seed: 1337 > middleName() 1`] = `"Dakota"`;
 
 exports[`name > seed: 1337 > prefix() 1`] = `"Mrs."`;
 
+exports[`name > seed: 1337 > sex() 1`] = `"female"`;
+
 exports[`name > seed: 1337 > suffix() 1`] = `"I"`;

test/name.spec.ts

@@ -11,6 +11,7 @@ const functionNames = [
   'findName',
   'jobTitle',
   'gender',
+  'sex',
   'prefix',
   'suffix',
   'jobDescriptor',
@@ -243,7 +244,21 @@ describe('name', () => {
           const gender = faker.name.gender(true);
 
           expect(gender).toBeTypeOf('string');
-          expect(faker.definitions.name.binary_gender).toContain(gender);
+          expect(faker.definitions.name.sex).toContain(gender);
+        });
+      });
+
+      describe('sex()', () => {
+        beforeEach(() => {
+          faker.locale = 'en';
+          faker.localeFallback = 'en';
+        });
+
+        it('should return a sex', () => {
+          const sex = faker.name.sex();
+
+          expect(sex).toBeTypeOf('string');
+          expect(faker.definitions.name.sex).toContain(sex);
         });
       });