Apidog Docs
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ ζ—₯本θͺž
  1. Learning Center
  • Back to home
  • Dynamic values Modules
  • Airline
  • Animal
  • Color
  • Commerce
  • Company
  • Database
  • Datatype
  • Date
  • Finance
  • Food
  • Git
  • Hacker
  • Helpers
  • Image
  • Internet
  • Location
  • Lorem
  • Music
  • Number
  • Person
  • Phone
  • Science
  • String
  • System
  • Vehicle
  • Word
  1. Learning Center

Person

Module to generate people's personal information such as names and job titles.
Overview
To generate a full name, use {{$person.fullName}}. Note that this is not the same as simply concatenating {{$person.firstName}} and {{$person.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 {{$person.prefix}}, {{$person.firstName}}, {{$person.middleName}}, {{$person.lastName}}, and {{$person.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 {{$person.jobTitle}}.
This module can also generate other personal information which might appear in user profiles, such as {{$person.gender}}, {{$person.zodiacSign}}, and {{$person.bio}}.
Related modules
For personal contact information like phone numbers and email addresses, see the Phone and Internet modules.

bio#

Returns a random short biography
Returns: string
Examples

firstName#

Returns a random first name.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

fullName#

Generates a random full name.
Parameters
NameTypeDefaultDescription
firstNamestring{{$person.firstName}}The optional first name to use. If not specified a random one will be chosen.
lastNamestring{{$person.lastName}}The optional last name to use. If not specified a random one will be chosen.
sex'female' | 'male'{{$helpers.arrayElement(['female','male'])}}The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

gender#

Returns a random gender.
Returns: string
Examples

jobArea#

Generates a random job area.
Returns: string
Examples

jobDescriptor#

Generates a random job descriptor.
Returns: string
Examples

jobTitle#

Generates a random job title.
Returns: string
Examples

lastName#

Returns a random last name.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

middleName#

Returns a random middle name.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

prefix#

Returns a random person prefix.
Parameters
NameTypeDefaultDescription
sex'female' | 'male'The optional sex to use. Can be either 'female' or 'male'.
Returns: string
Examples

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 {{$person.firstName}}.
Returns: string
Examples

sexType#

Returns a random sex type. The SexType is intended to be used in parameters and conditions.
Returns: 'female' | 'male'
Examples

suffix#

Returns a random person suffix.
Returns: string
Examples

zodiacSign#

Returns a random zodiac sign.
Returns: string
Examples
Previous
Number
Next
Phone
Built with