aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2022-04-03 17:36:59 +0200
committerGitHub <[email protected]>2022-04-03 17:36:59 +0200
commit6096cb4d5645f4af803b6f550ecb0f64d8942778 (patch)
tree51030b6a4e1d9eb5dddf94403d9a8ce424072aba /src
parent214a77b437aaff1282248a6ee14fd227d5e42c42 (diff)
downloadfaker-6096cb4d5645f4af803b6f550ecb0f64d8942778.tar.xz
faker-6096cb4d5645f4af803b6f550ecb0f64d8942778.zip
chore: deprecate name.title() in favor of name.jobTitle() (#766)
Diffstat (limited to 'src')
-rw-r--r--src/name.ts31
1 files changed, 12 insertions, 19 deletions
diff --git a/src/name.ts b/src/name.ts
index a6dd4ea6..9ac270b3 100644
--- a/src/name.ts
+++ b/src/name.ts
@@ -284,23 +284,22 @@ export class Name {
}
/**
- * Generates a random title.
+ * Generates a random job title.
*
* @example
* faker.name.title() // 'International Integration Manager'
+ *
+ * @deprecated
*/
title(): string {
- const descriptor = this.faker.random.arrayElement(
- this.faker.definitions.name.title.descriptor
- );
- const level = this.faker.random.arrayElement(
- this.faker.definitions.name.title.level
- );
- const job = this.faker.random.arrayElement(
- this.faker.definitions.name.title.job
- );
-
- return descriptor + ' ' + level + ' ' + job;
+ deprecated({
+ deprecated: 'faker.name.title()',
+ proposed: 'faker.name.jobTitle()',
+ since: 'v6.1.2',
+ until: 'v7.0.0',
+ });
+
+ return this.jobTitle();
}
/**
@@ -310,13 +309,7 @@ export class Name {
* faker.name.jobTitle() // 'Global Accounts Engineer'
*/
jobTitle(): string {
- return (
- this.faker.name.jobDescriptor() +
- ' ' +
- this.faker.name.jobArea() +
- ' ' +
- this.faker.name.jobType()
- );
+ return this.jobDescriptor() + ' ' + this.jobArea() + ' ' + this.jobType();
}
/**