Skip to content

Commit

Permalink
jsdocs change
Browse files Browse the repository at this point in the history
  • Loading branch information
suyashgulati committed Oct 28, 2024
1 parent df5befd commit 5644bca
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions src/modules/animal/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,6 @@ export class AnimalModule extends ModuleBase {
return this.faker.helpers.arrayElement(this.faker.definitions.animal.lion);
}

/**
* Returns a random pet name.
*
* @example
* faker.animal.petName() // 'Coco'
*
* @since 5.5.0
*/
petName(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.animal.pet_name
);
}

/**
* Returns a random cetacean species.
*
Expand Down Expand Up @@ -215,4 +201,18 @@ export class AnimalModule extends ModuleBase {
type(): string {
return this.faker.helpers.arrayElement(this.faker.definitions.animal.type);
}

/**
* Returns a random pet name.
*
* @example
* faker.animal.petName() // 'Coco'
*
* @since 9.2.0
*/
petName(): string {
return this.faker.helpers.arrayElement(
this.faker.definitions.animal.pet_name
);
}
}

0 comments on commit 5644bca

Please sign in to comment.