interface-forge - v2.5.0
    Preparing search index...

    Class PersonModule

    Module to generate people's personal information such as names and job titles. Prior to Faker 8.0.0, this module was known as faker.name.

    To generate a full name, use fullName. Note that this is not the same as simply concatenating firstName and lastName, as the full name may contain a prefix, suffix, or both. Additionally, different supported locales will have differing name patterns. For example, the last name may appear before the first name, or there may be a double or hyphenated first or last name.

    You can also generate the parts of a name separately, using prefix, firstName, middleName, lastName, and suffix. Not all locales support all of these parts.

    Many of the methods in this module can optionally choose either female, male or mixed names.

    Job-related data is also available. To generate a job title, use jobTitle.

    This module can also generate other personal information which might appear in user profiles, such as gender, zodiacSign, and bio.

    For personal contact information like phone numbers and email addresses, see the faker.phone and faker.internet modules.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    faker

    Methods

    bio firstName fullName gender jobArea jobDescriptor jobTitle jobType lastName middleName prefix sex sexType suffix zodiacSign

    Constructors

    Properties

    faker: Faker

    Methods

    • Returns a random short biography

      Returns string

      faker.person.bio() // 'oatmeal advocate, veteran 🐠'

      8.0.0

    • Returns a random first name.

      Parameters

      • Optionalsex: "female" | "male"

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

      Returns string

      faker.person.firstName() // 'Antwan'
      faker.person.firstName('female') // 'Victoria'
      faker.person.firstName('male') // 'Tom'

      8.0.0

    • Generates a random full name.

      Parameters

      • Optionaloptions: { firstName?: string; lastName?: string; sex?: "female" | "male" }

        An options object.

        • OptionalfirstName?: string

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

          faker.person.firstName(sex)
        • OptionallastName?: string

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

          faker.person.lastName(sex)
        • Optionalsex?: "female" | "male"

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

          faker.helpers.arrayElement(['female', 'male'])

      Returns string

      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'

      8.0.0

    • Returns a random gender.

      Returns string

      faker.person.sex(): For generating a binary-gender value.

      faker.person.gender() // 'Trans*Man'

      8.0.0

    • Generates a random job area.

      Returns string

      faker.person.jobArea() // 'Brand'

      8.0.0

    • Generates a random job descriptor.

      Returns string

      faker.person.jobDescriptor() // 'Customer'

      8.0.0

    • Generates a random job title.

      Returns string

      faker.person.jobTitle() // 'Global Accounts Engineer'

      8.0.0

    • Generates a random job type.

      Returns string

      faker.person.jobType() // 'Assistant'

      8.0.0

    • Returns a random last name.

      Parameters

      • Optionalsex: "female" | "male"

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

      Returns string

      faker.person.lastName() // 'Hauck'
      faker.person.lastName('female') // 'Grady'
      faker.person.lastName('male') // 'Barton'

      8.0.0

    • Returns a random middle name.

      Parameters

      • Optionalsex: "female" | "male"

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

      Returns string

      faker.person.middleName() // 'James'
      faker.person.middleName('female') // 'Eloise'
      faker.person.middleName('male') // 'Asher'

      8.0.0

    • Returns a random person prefix.

      Parameters

      • Optionalsex: "female" | "male"

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

      Returns string

      faker.person.prefix() // 'Miss'
      faker.person.prefix('female') // 'Ms.'
      faker.person.prefix('male') // 'Mr.'

      8.0.0

    • 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().

      Returns string

      • faker.person.gender(): For generating a gender related value.
      • faker.person.sexType(): For generating a sex value to be used as a parameter.
      faker.person.sex() // 'female'

      8.0.0

    • Returns a random sex type. The SexType is intended to be used in parameters and conditions.

      Returns "female" | "male"

      • faker.person.gender(): For generating a gender related value in forms.
      • faker.person.sex(): For generating a binary-gender value in forms.
      faker.person.sexType() // Sex.Female

      8.0.0

    • Returns a random person suffix.

      Returns string

      faker.person.suffix() // 'DDS'

      8.0.0

    • Returns a random zodiac sign.

      Returns string

      faker.person.zodiacSign() // 'Pisces'

      8.0.0

    Settings

    Member Visibility

    On This Page

    OverviewRelated modules
    Constructors
    Properties
    Methods