diff options
Diffstat (limited to 'src/modules')
| -rw-r--r-- | src/modules/name/index.ts | 33 |
1 files changed, 27 insertions, 6 deletions
diff --git a/src/modules/name/index.ts b/src/modules/name/index.ts index 0a67c382..b42de3db 100644 --- a/src/modules/name/index.ts +++ b/src/modules/name/index.ts @@ -245,25 +245,46 @@ export class Name { } /** - * Return a random gender. + * Returns a random gender. * - * @param binary Whether to return only binary gender names. Defaults to `false`. + * @param binary (deprecated) Whether to return only binary gender names. Defaults to `false`. + * + * @see faker.name.sex() if you would like to generate binary-gender value * * @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.5', + until: '8.0', + }); + + return this.faker.name.sex(); } return this.faker.helpers.arrayElement(this.faker.definitions.name.gender); } /** + * Returns a random sex. + * + * Output of this method is localised, so it should not be used to fill the parameter `sex` + * available in some other modules for example `faker.name.firstName()`. + * + * @see faker.name.gender() if you would like to generate gender related values. + * + * @example + * faker.name.sex() // 'female' + */ + sex(): string { + return this.faker.helpers.arrayElement(this.faker.definitions.name.sex); + } + + /** * Returns a random name prefix. * * @param sex The optional sex to use. Can be either `'female'` or `'male'`. |
