Use enum for male/female references

[griest024]

Clear and concise description of the problem

References to male and female are done with hardcoded strings and numbers.

faker/src/name.ts

Lines 29 to 35 in 44628ec

	if (typeof gender === 'string') {
	if (gender.toLowerCase() === 'male') {
	gender = 0;
	} else if (gender.toLowerCase() === 'female') {
	gender = 1;
	}
	}

.

Suggested solution

These should be replaced with enum values:

enum Sex {
  MALE = 'male',
  FEMALE = 'female',
  INTERSEX = 'intersex'
}

Alternative

No response

Additional context

As an aside, gender is an inaccurate name for male and female. The correct term is sex.

[Shinigami92]

I would suggest to use type literals like type Sex = 'male' | 'female'

Beside that, I would highly like to have something like type Sex = 'male' | 'female' | 'binary' in the future

[griest024]

I would suggest to use type literals like type Sex = 'male' | 'female'

Beside that, I would highly like to have something like type Sex = 'male' | 'female' | 'binary' in the future

I much prefer enums; simple types can't be used as runtime values and we can't use it to replace hardcoded values.

[Shinigami92]

I like to provide enums, but not to force the usage
So we could to

export enum Sex {
  MALE = 'male',
  FEMALE = 'female',
  INTERSEX = 'intersex'
}

export type SexType = 'male' | 'female' | 'intersex' | number

firstName(gender?: SexType): string { /*...*/ }

[griest024]

Yes as to the external usage we should accept more than just the enum. But for the internal usage I want to see case Sex.MALE: instead of case 0:.

[ST-DDT]

Please no magic numbers. Or what is your intention?

EIDT: Backwards compatibility.

[Shinigami92]

TS Playground

[pkuczynski]

What would intersex or binary mean in this case? https://en.wikipedia.org/wiki/Sex does not list those terms...

[ST-DDT]

IMO this issue is already implemented.

faker/src/modules/name/index.ts

Lines 3 to 6 in 8369e19

	export enum Gender {
	female = 'female',
	male = 'male',
	}

[pkuczynski]

I was only scanning the issues. If it's already implemented, we should close it. @griest024 wdyt?

[pkuczynski]

Btw. there is #353 suggesting renaming gender to sex...