src/definitions/person.ts


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';

export type PersonEntryDefinition<T> =
  | {
      generic?: T[];
      male: T[];
      female: T[];
    }
  | {
      generic: T[];
      male?: never;
      female?: never;
    };

type SimplePersonEntryDefinition = PersonEntryDefinition<string>;
type WeightedPersonEntryDefinition = PersonEntryDefinition<{
  value: string;
  weight: number;
}>;

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

  prefix: SimplePersonEntryDefinition;
  first_name: SimplePersonEntryDefinition;
  middle_name: SimplePersonEntryDefinition;
  last_name: SimplePersonEntryDefinition;

  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: WeightedPersonEntryDefinition;

  bio_pattern: string[];

  job_descriptor: string[];
  job_area: string[];
  job_type: string[];

  job_title_pattern: string[];

  western_zodiac_sign: string[];
}>;