aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorMatt Mayer <[email protected]>2022-11-06 22:11:04 +0700
committerGitHub <[email protected]>2022-11-06 15:11:04 +0000
commit1bed40369974db6a15db3e6cb8e765717e640ad1 (patch)
tree1556e6f79e2845020e0768cd90712baf2fdc9c50 /src
parent0b9989fe0ec3dcb8e511060c1fe42bb6abe2b1ba (diff)
downloadfaker-1bed40369974db6a15db3e6cb8e765717e640ad1.tar.xz
faker-1bed40369974db6a15db3e6cb8e765717e640ad1.zip
docs: update since tags for person and location (#1516)
Diffstat (limited to 'src')
-rw-r--r--src/modules/location/index.ts42
-rw-r--r--src/modules/person/index.ts26
2 files changed, 34 insertions, 34 deletions
diff --git a/src/modules/location/index.ts b/src/modules/location/index.ts
index 36553572..fcb8aabd 100644
--- a/src/modules/location/index.ts
+++ b/src/modules/location/index.ts
@@ -27,7 +27,7 @@ export class LocationModule {
* faker.location.zipCode() // '17839'
* faker.location.zipCode('####') // '6925'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
zipCode(format?: string): string {
// if zip format is not specified, use the zip format defined for the locale
@@ -55,7 +55,7 @@ export class LocationModule {
* fakerUS.location.zipCodeByState("AK") // '99595'
* fakerUS.location.zipCodeByState("??") // '47683-9880'
*
- * @since 5.0.0
+ * @since 8.0.0
*/
zipCodeByState(state: string): string {
const zipRange = this.faker.definitions.location.postcode_by_state?.[state];
@@ -71,7 +71,7 @@ export class LocationModule {
* @example
* faker.location.city() // 'East Jarretmouth'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
city(): string {
const pattern = this.faker.helpers.arrayElement(
@@ -86,7 +86,7 @@ export class LocationModule {
* @example
* faker.location.cityName() // 'San Rafael'
*
- * @since 5.5.0
+ * @since 8.0.0
*/
cityName(): string {
return this.faker.helpers.arrayElement(
@@ -100,7 +100,7 @@ export class LocationModule {
* @example
* faker.location.buildingNumber() // '379'
*
- * @since 6.2.0
+ * @since 8.0.0
*/
buildingNumber(): string {
const format = this.faker.helpers.arrayElement(
@@ -116,7 +116,7 @@ export class LocationModule {
* @example
* faker.location.street() // 'Schroeder Isle'
*
- * @since 7.0.0
+ * @since 8.0.0
*/
street(): string {
const format = this.faker.helpers.arrayElement(
@@ -131,7 +131,7 @@ export class LocationModule {
* @example
* fakerDE.location.streetName() // 'Cavill Avenue'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
streetName(): string {
return this.faker.helpers.arrayElement(
@@ -150,7 +150,7 @@ export class LocationModule {
* faker.location.streetAddress(false) // '34830 Erdman Hollow'
* faker.location.streetAddress(true) // '3393 Ronny Way Apt. 742'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
streetAddress(useFullAddress: boolean = false): string {
const formats = this.faker.definitions.location.street_address;
@@ -166,7 +166,7 @@ export class LocationModule {
* @example
* faker.location.secondaryAddress() // 'Apt. 861'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
secondaryAddress(): string {
return this.faker.helpers.replaceSymbolWithNumber(
@@ -182,7 +182,7 @@ export class LocationModule {
* @example
* faker.location.county() // 'Cambridgeshire'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
county(): string {
return this.faker.helpers.arrayElement(
@@ -196,7 +196,7 @@ export class LocationModule {
* @example
* faker.location.country() // 'Greece'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
country(): string {
return this.faker.helpers.arrayElement(
@@ -215,7 +215,7 @@ export class LocationModule {
* faker.location.countryCode('alpha-2') // 'GA'
* faker.location.countryCode('alpha-3') // 'TJK'
*
- * @since 3.0.0
+ * @since 8.0.0
*/
countryCode(alphaCode: 'alpha-2' | 'alpha-3' = 'alpha-2'): string {
const key =
@@ -232,7 +232,7 @@ export class LocationModule {
* @example
* faker.location.state() // 'Georgia'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
state(): string {
return this.faker.helpers.arrayElement(
@@ -246,7 +246,7 @@ export class LocationModule {
* @example
* faker.location.stateAbbr() // 'ND'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
stateAbbr(): string {
return this.faker.helpers.arrayElement(
@@ -265,7 +265,7 @@ export class LocationModule {
* faker.location.latitude() // -30.9501
* faker.location.latitude(10, -10, 5) // 2.68452
*
- * @since 2.0.1
+ * @since 8.0.0
*/
// TODO @xDivisionByZerox 2022-06-12 this signature should probably be an object for easier maintainability
latitude(max: number = 90, min: number = -90, precision: number = 4): number {
@@ -287,7 +287,7 @@ export class LocationModule {
* faker.location.longitude() // -154.0226
* faker.location.longitude(10, -10, 5) // -4.03620
*
- * @since 2.0.1
+ * @since 8.0.0
*/
// TODO @xDivisionByZerox 2022-06-12 this signature should probably be an object for easier maintainability
longitude(
@@ -313,7 +313,7 @@ export class LocationModule {
* faker.location.direction(false) // 'South'
* faker.location.direction(true) // 'NE'
*
- * @since 5.0.0
+ * @since 8.0.0
*/
direction(useAbbr: boolean = false): string {
if (!useAbbr) {
@@ -337,7 +337,7 @@ export class LocationModule {
* faker.location.cardinalDirection(false) // 'South'
* faker.location.cardinalDirection(true) // 'N'
*
- * @since 5.0.0
+ * @since 8.0.0
*/
cardinalDirection(useAbbr: boolean = false): string {
if (!useAbbr) {
@@ -361,7 +361,7 @@ export class LocationModule {
* faker.location.ordinalDirection(false) // 'Northwest'
* faker.location.ordinalDirection(true) // 'NE'
*
- * @since 5.0.0
+ * @since 8.0.0
*/
ordinalDirection(useAbbr: boolean = false): string {
if (!useAbbr) {
@@ -387,7 +387,7 @@ export class LocationModule {
* faker.location.nearbyGPSCoordinate([33, -170]) // [ 33.0165, -170.0636 ]
* faker.location.nearbyGPSCoordinate([33, -170], 1000, true) // [ 37.9163, -179.2408 ]
*
- * @since 5.0.0
+ * @since 8.0.0
*/
nearbyGPSCoordinate(
coordinate?: [latitude: number, longitude: number],
@@ -445,7 +445,7 @@ export class LocationModule {
* @example
* faker.location.timeZone() // 'Pacific/Guam'
*
- * @since 5.1.0
+ * @since 8.0.0
*/
timeZone(): string {
return this.faker.helpers.arrayElement(
diff --git a/src/modules/person/index.ts b/src/modules/person/index.ts
index 9938a077..023cded1 100644
--- a/src/modules/person/index.ts
+++ b/src/modules/person/index.ts
@@ -80,7 +80,7 @@ export class PersonModule {
* faker.person.firstName('female') // 'Victoria'
* faker.person.firstName('male') // 'Tom'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
firstName(sex?: SexType): string {
const { first_name, female_first_name, male_first_name } =
@@ -104,7 +104,7 @@ export class PersonModule {
* faker.person.lastName('female') // 'Grady'
* faker.person.lastName('male') // 'Barton'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
lastName(sex?: SexType): string {
const { last_name, female_last_name, male_last_name } =
@@ -128,7 +128,7 @@ export class PersonModule {
* faker.person.middleName('female') // 'Eloise'
* faker.person.middleName('male') // 'Asher'
*
- * @since 5.2.0
+ * @since 8.0.0
*/
middleName(sex?: SexType): string {
const { middle_name, female_middle_name, male_middle_name } =
@@ -156,7 +156,7 @@ export class PersonModule {
* faker.person.fullName({ lastName: 'Beer' }) // 'Mr. Alfonso Beer'
* faker.person.fullName({ sex: 'male' }) // 'Fernando Schaefer'
*
- * @since 7.4.0
+ * @since 8.0.0
*/
fullName(
options: {
@@ -202,7 +202,7 @@ export class PersonModule {
* @example
* faker.person.gender() // 'Trans*Man'
*
- * @since 5.0.0
+ * @since 8.0.0
*/
gender(): string {
return this.faker.helpers.arrayElement(
@@ -221,7 +221,7 @@ export class PersonModule {
* @example
* faker.person.sex() // 'female'
*
- * @since 7.5.0
+ * @since 8.0.0
*/
sex(): string {
return this.faker.helpers.arrayElement(this.faker.definitions.person.sex);
@@ -233,7 +233,7 @@ export class PersonModule {
* @example
* faker.person.sexType() // Sex.Female
*
- * @since 7.5.0
+ * @since 8.0.0
*/
sexType(): SexType {
return this.faker.helpers.objectValue(Sex);
@@ -249,7 +249,7 @@ export class PersonModule {
* faker.person.prefix('female') // 'Ms.'
* faker.person.prefix('male') // 'Mr.'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
prefix(sex?: SexType): string {
const { prefix, female_prefix, male_prefix } =
@@ -268,7 +268,7 @@ export class PersonModule {
* @example
* faker.person.suffix() // 'DDS'
*
- * @since 2.0.1
+ * @since 8.0.0
*/
suffix(): string {
// TODO @Shinigami92 2022-03-21: Add female_suffix and male_suffix
@@ -283,7 +283,7 @@ export class PersonModule {
* @example
* faker.person.jobTitle() // 'Global Accounts Engineer'
*
- * @since 3.0.0
+ * @since 8.0.0
*/
jobTitle(): string {
return `${this.jobDescriptor()} ${this.jobArea()} ${this.jobType()}`;
@@ -295,7 +295,7 @@ export class PersonModule {
* @example
* faker.person.jobDescriptor() // 'Customer'
*
- * @since 3.0.0
+ * @since 8.0.0
*/
jobDescriptor(): string {
return this.faker.helpers.arrayElement(
@@ -309,7 +309,7 @@ export class PersonModule {
* @example
* faker.person.jobArea() // 'Brand'
*
- * @since 3.0.0
+ * @since 8.0.0
*/
jobArea(): string {
return this.faker.helpers.arrayElement(
@@ -323,7 +323,7 @@ export class PersonModule {
* @example
* faker.person.jobType() // 'Assistant'
*
- * @since 3.0.0
+ * @since 8.0.0
*/
jobType(): string {
return this.faker.helpers.arrayElement(