Skip to content
On this page

Person

Module to generate people's names and titles.

firstName

Returns a random first name.

Available since v8.0.0

Parameters

NameTypeDefaultDescription
sex?'female' | 'male'

The optional sex to use. Can be either 'female' or 'male'.

Returns: string

ts
faker.person.firstName(sex?: 'female' | 'male'): string
faker.person.firstName() // => "Katharina"
faker.person.firstName() // 'Antwan'
faker.person.firstName('female') // 'Victoria'
faker.person.firstName('male') // 'Tom'

fullName

Generates a random full name.

Available since v8.0.0

Parameters

NameTypeDefaultDescription
options{ ... }{}

An options object.

options.firstName?string

The optional first name to use. If not specified a random one will be chosen.

options.lastName?string

The optional last name to use. If not specified a random one will be chosen.

options.sex?'female' | 'male'

The optional sex to use. Can be either 'female' or 'male'.

Returns: string

ts
faker.person.fullName(options: {
  firstName: string,
  lastName: string,
  sex: 'female' | 'male'
} = {}): string
faker.person.fullName() // => "Terrence Rau"
faker.person.fullName() // 'Allen Brown'
faker.person.fullName({ firstName: 'Joann' }) // 'Joann Osinski'
faker.person.fullName({ firstName: 'Marcella', sex: 'female' }) // 'Mrs. Marcella Huels'
faker.person.fullName({ lastName: 'Beer' }) // 'Mr. Alfonso Beer'
faker.person.fullName({ sex: 'male' }) // 'Fernando Schaefer'

gender

Returns a random gender.

Available since v8.0.0

Returns: string

ts
faker.person.gender(): string
faker.person.gender() // => "Male to female transgender woman"
faker.person.gender() // 'Trans*Man'

jobArea

Generates a random job area.

Available since v8.0.0

Returns: string

ts
faker.person.jobArea(): string
faker.person.jobArea() // => "Infrastructure"
faker.person.jobArea() // 'Brand'

jobDescriptor

Generates a random job descriptor.

Available since v8.0.0

Returns: string

ts
faker.person.jobDescriptor(): string
faker.person.jobDescriptor() // => "Global"
faker.person.jobDescriptor() // 'Customer'

jobTitle

Generates a random job title.

Available since v8.0.0

Returns: string

ts
faker.person.jobTitle(): string
faker.person.jobTitle() // => "Global Intranet Developer"
faker.person.jobTitle() // 'Global Accounts Engineer'

jobType

Generates a random job type.

Available since v8.0.0

Returns: string

ts
faker.person.jobType(): string
faker.person.jobType() // => "Designer"
faker.person.jobType() // 'Assistant'

lastName

Returns a random last name.

Available since v8.0.0

Parameters

NameTypeDefaultDescription
sex?'female' | 'male'

The optional sex to use. Can be either 'female' or 'male'.

Returns: string

ts
faker.person.lastName(sex?: 'female' | 'male'): string
faker.person.lastName() // => "Lowe"
faker.person.lastName() // 'Hauck'
faker.person.lastName('female') // 'Grady'
faker.person.lastName('male') // 'Barton'

middleName

Returns a random middle name.

Available since v8.0.0

Parameters

NameTypeDefaultDescription
sex?'female' | 'male'

The optional sex to use. Can be either 'female' or 'male'.

Returns: string

ts
faker.person.middleName(sex?: 'female' | 'male'): string
faker.person.middleName() // => "Kyle"
faker.person.middleName() // 'James'
faker.person.middleName('female') // 'Eloise'
faker.person.middleName('male') // 'Asher'

prefix

Returns a random person prefix.

Available since v8.0.0

Parameters

NameTypeDefaultDescription
sex?'female' | 'male'

The optional sex to use. Can be either 'female' or 'male'.

Returns: string

ts
faker.person.prefix(sex?: 'female' | 'male'): string
faker.person.prefix() // => "Ms."
faker.person.prefix() // 'Miss'
faker.person.prefix('female') // 'Ms.'
faker.person.prefix('male') // 'Mr.'

sex

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.person.firstName().

Available since v8.0.0

Returns: string

ts
faker.person.sex(): string
faker.person.sex() // => "male"
faker.person.sex() // 'female'

sexType

Returns a random sex type.

Available since v8.0.0

Returns: 'female' | 'male'

ts
faker.person.sexType(): "female" | "male"
faker.person.sexType() // => "male"
faker.person.sexType() // Sex.Female

suffix

Returns a random person suffix.

Available since v8.0.0

Returns: string

ts
faker.person.suffix(): string
faker.person.suffix() // => "V"
faker.person.suffix() // 'DDS'

Released under the MIT License,本站仅做翻译,如有错误,请向我反馈 QQ:385858750