aboutsummaryrefslogtreecommitdiff
path: root/src/definitions/person.ts
blob: 709d0cf34f1c0948f32291271b064f12d5e10c4f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
import type { LocaleEntry } from './definitions';

/**
 * The possible definitions related to people's names.
 */
export type PersonDefinition = LocaleEntry<{
  gender: string[];
  sex: string[];

  prefix: string[];
  female_prefix: string[];
  male_prefix: string[];

  first_name: string[];
  female_first_name: string[];
  male_first_name: string[];

  middle_name: string[];
  female_middle_name: string[];
  male_middle_name: string[];

  last_name: string[];
  female_last_name: string[];
  male_last_name: string[];

  suffix: string[];

  /**
   * A weighted list of patterns used to generate names.
   */
  name: Array<{ value: string; weight: number }>;

  /**
   * A weighted list of patterns used to generate last names.
   */
  last_name_pattern: Array<{ value: string; weight: number }>;
  male_last_name_pattern: Array<{ value: string; weight: number }>;
  female_last_name_pattern: Array<{ value: string; weight: number }>;

  bio_pattern: string[];

  title: PersonTitleDefinition;

  western_zodiac_sign: string[];
}>;

/**
 * The possible definitions related to people's titles.
 */
export type PersonTitleDefinition = LocaleEntry<{
  descriptor: string[];
  job: string[];
  level: string[];
}>;