refactor(company): deprecate suffix methods (#1719)

faker-js · Jan 9, 2023 · 1e7534e · 1e7534e
1 parent 099e76c
commit 1e7534e
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/definitions/company.ts b/src/definitions/company.ts
@@ -41,6 +41,8 @@ export type CompanyDefinitions = LocaleEntry<{
 
   /**
    * Company/Business entity types.
+   *
+   * @deprecated Use `faker.company.name` instead.
    */
   suffix: string[];
 }>;
diff --git a/src/modules/company/index.ts b/src/modules/company/index.ts
@@ -1,4 +1,5 @@
 import type { Faker } from '../..';
+import { deprecated } from '../../internal/deprecated';
 
 /**
  * Module to generate company related entries.
@@ -18,12 +19,22 @@ export class CompanyModule {
   /**
    * Returns an array with possible company name suffixes.
    *
+   * @see faker.company.name()
+   *
    * @example
    * faker.company.suffixes() // [ 'Inc', 'and Sons', 'LLC', 'Group' ]
    *
    * @since 2.0.1
+   *
+   * @deprecated Use `faker.company.name` instead.
    */
   suffixes(): string[] {
+    deprecated({
+      deprecated: 'faker.company.suffixes',
+      proposed: 'faker.company.name',
+      since: '8.0',
+      until: '9.0',
+    });
     // Don't want the source array exposed to modification, so return a copy
     return this.faker.definitions.company.suffix.slice(0);
   }
@@ -45,12 +56,22 @@ export class CompanyModule {
   /**
    * Returns a random company suffix.
    *
+   * @see faker.company.name()
+   *
    * @example
    * faker.company.companySuffix() // 'and Sons'
    *
    * @since 2.0.1
+   *
+   * @deprecated Use `faker.company.name` instead.
    */
   companySuffix(): string {
+    deprecated({
+      deprecated: 'faker.company.companySuffix',
+      proposed: 'faker.company.name',
+      since: '8.0',
+      until: '9.0',
+    });
     return this.faker.helpers.arrayElement(this.suffixes());
   }