People

People, contact details, names, e-mail addresses, usernames and phone numbers. See all field types and the options every field takes.

person

A person as one object whose name, gender and e-mail agree. JSON and YAML nest it; other formats write compact JSON.

Parameter Values Default Description
fields list of: firstName, middleName, lastName, fullName, namePrefix, nameSuffix, gender, age, hobby, company, email, phone, street, city, country, postcode firstName, lastName, fullName, age, email Which built-in subfields to include, as a list of names. All subfields describe the same person.

Also takes the common options.

person.yaml
- { name: customer, type: person, fields: [fullName, email, age] }

contact

Contact details as one object: e-mail, phone and address.

Parameter Values Default Description
fields list of: firstName, middleName, lastName, fullName, namePrefix, nameSuffix, gender, age, hobby, company, email, phone, street, city, country, postcode email, phone, street, city, country, postcode Which built-in subfields to include, as a list of names. All subfields describe the same person.

Also takes the common options.

contact.yaml
- { name: contact, type: contact }

email

E-mail address built from a romanized name: mei.tanaka42@example.com.

Parameter Values Default Description
domain text example.com Domain after the @.

Also takes the common options and textual constraints.

email.yaml
- { name: email, type: email, domain: acme.test, unique: true }

username

Account handle such as lars.eriksson318.

Also takes the common options and textual constraints.

username.yaml
- { name: handle, type: username, unique: true }

phone

Phone number. Brazilian for country: BR (the default for por), North American otherwise.

Parameter Values Default Description
country text — BR or US. Defaults to BR for output.language: por, else US.
formatted boolean false BR only: (11) 91234-5678 instead of +5511912345678.

Also takes the common options and textual constraints.

phone.yaml
- { name: phone, type: phone, country: BR, formatted: true }

age

Human age in years.

Parameter Values Default Description
min number 0 Inclusive lower bound.
max number 100 Inclusive upper bound.

Also takes the common options.

age.yaml
- { name: age, type: age, min: 18, max: 90 }