summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/person/prefix.md
blob: 0f5c50299b14a77ec63b7f50fdf5395bd971e2e9 (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
# prefix

```js
// usage
chance.prefix()
chance.prefix({ full: true })
```

Generate a random name prefix

```js
chance.prefix();
=> 'Mrs.'
```

By default, returns the shorter version.

Optionally get back the full version.

```js
chance.prefix({ full: true });
=> 'Mister'
```

Optionally specify a gender. Valid options are `male`, `female`, or `all` (the default).

```js
chance.prefix({ gender: "male" });
=> 'Mr.'

chance.prefix({ gender: "female" });
=> 'Miss'
```

*To maintain legacy support, this also responds to chance.name_prefix().*