Merge branch 'main' into add-alternative-cdn-links

Author: Shinigami92

README.md

@@ -46,7 +46,7 @@ pnpm install @faker-js/faker -D
 <script>
   const randomName = faker.name.findName(); // Caitlyn Kerluke
   const randomEmail = faker.internet.email(); // [email protected]
-  const randomCard = faker.helpers.createCard(); // random contact card containing many properties
+  const randomPhoneNumber = faker.phone.phoneNumber(); // (746) 637-3344 x8083
 </script>
 ```
 
@@ -56,7 +56,7 @@ pnpm install @faker-js/faker -D
 const { faker } = require('@faker-js/faker');
 const randomName = faker.name.findName(); // Rowan Nikolaus
 const randomEmail = faker.internet.email(); // [email protected]
-const randomCard = faker.helpers.createCard(); // random contact card containing many properties
+const randomPhoneNumber = faker.phone.phoneNumber(); // (279) 329-8663 x30233
 ```
 
 ### CDN/Deno
@@ -66,7 +66,7 @@ import { faker } from 'https://cdn.skypack.dev/@faker-js/faker';
 
 const randomName = faker.name.findName(); // Willie Bahringer
 const randomEmail = faker.internet.email(); // [email protected]
-const randomCard = faker.helpers.createCard(); // random contact card containing many properties
+const randomPhoneNumber = faker.phone.phoneNumber(); // 938-672-1359 x418
 ```
 
 #### Alternative CDN links

src/datatype.ts

@@ -47,32 +47,31 @@ export class Datatype {
 
     options = options ?? {};
 
-    if (typeof options.min === 'undefined') {
-      options.min = 0;
+    let max = 99999;
+    let min = 0;
+    let precision = 1;
+    if (typeof options.min === 'number') {
+      min = options.min;
     }
 
-    if (typeof options.max === 'undefined') {
-      options.max = 99999;
+    if (typeof options.max === 'number') {
+      max = options.max;
     }
 
-    if (typeof options.precision === 'undefined') {
-      options.precision = 1;
+    if (typeof options.precision === 'number') {
+      precision = options.precision;
     }
 
     // Make the range inclusive of the max value
-    let max = options.max;
     if (max >= 0) {
-      max += options.precision;
+      max += precision;
     }
 
     let randomNumber = Math.floor(
-      this.faker.mersenne.rand(
-        max / options.precision,
-        options.min / options.precision
-      )
+      this.faker.mersenne.rand(max / precision, min / precision)
     );
     // Workaround problem in Float point arithmetics for e.g. 6681493 / 0.01
-    randomNumber = randomNumber / (1 / options.precision);
+    randomNumber = randomNumber / (1 / precision);
 
     return randomNumber;
   }

src/finance.ts

@@ -258,32 +258,17 @@ export class Finance {
    */
   creditCardNumber(provider = ''): string {
     let format: string;
-    let formats: string | string[];
     const localeFormat = this.faker.definitions.finance.credit_card;
     if (provider in localeFormat) {
-      formats = localeFormat[provider]; // there could be multiple formats
-      if (typeof formats === 'string') {
-        format = formats;
-      } else {
-        format = this.faker.random.arrayElement(formats);
-      }
+      format = this.faker.random.arrayElement(localeFormat[provider]);
     } else if (provider.match(/#/)) {
       // The user chose an optional scheme
       format = provider;
     } else {
       // Choose a random provider
-      // TODO ST-DDT 2022-01-30: #375 This is impossible to access
-      if (typeof localeFormat === 'string') {
-        format = localeFormat;
-      } else if (typeof localeFormat === 'object') {
-        // Credit cards are in a object structure
-        formats = this.faker.random.objectElement(localeFormat, 'value'); // There could be multiple formats
-        if (typeof formats === 'string') {
-          format = formats;
-        } else {
-          format = this.faker.random.arrayElement(formats);
-        }
-      }
+      // Credit cards are in an object structure
+      const formats = this.faker.random.objectElement(localeFormat, 'value'); // There could be multiple formats
+      format = this.faker.random.arrayElement(formats);
     }
     format = format.replace(/\//g, '');
     return this.Helpers.replaceCreditCardSymbols(format);

src/helpers.ts

@@ -137,11 +137,15 @@ export class Helpers {
    * @example
    * faker.helpers.randomize() // 'c'
    * faker.helpers.randomize([1, 2, 3]) // '2'
+   *
+   * @deprecated
    */
-  // TODO ST-DDT 2022-02-06: Mark as deprecated
   randomize<T = string>(
     array: ReadonlyArray<T> = ['a', 'b', 'c'] as unknown as ReadonlyArray<T>
   ): T {
+    console.warn(
+      'Deprecation Warning: faker.helpers.randomize is now located in faker.random.arrayElement'
+    );
     return this.faker.random.arrayElement(array);
   }
 
@@ -504,8 +508,12 @@ export class Helpers {
    * //   address: {
    * //     streetA: 'Drake Avenue',
    * // ...
+   * @deprecated If you need some specific object you should create your own method.
    */
   createCard(): Card {
+    console.warn(
+      'Deprecation Warning: If you need some specific object you should create your own method.'
+    );
     return {
       name: this.faker.name.findName(),
       username: this.faker.internet.userName(),
@@ -571,8 +579,12 @@ export class Helpers {
    * //   email: 'Eveline.Brekke56.Hoppe@yahoo.com',
    * //   dob: 1964-05-06T05:14:37.874Z,
    * // ...
+   * @deprecated If you need some specific object you should create your own method.
    */
   contextualCard(): ContextualCard {
+    console.warn(
+      'Deprecation Warning: If you need some specific object you should create your own method.'
+    );
     const name = this.faker.name.firstName();
     const userName = this.faker.internet.userName(name);
     return {
@@ -618,8 +630,12 @@ export class Helpers {
    * //   address: {
    * //     street: 'McKenzie Estates',
    * // ....
+   * @deprecated If you need some specific object you should create your own method.
    */
   userCard(): UserCard {
+    console.warn(
+      'Deprecation Warning: If you need some specific object you should create your own method.'
+    );
     return {
       name: this.faker.name.findName(),
       username: this.faker.internet.userName(),

src/iban.ts

@@ -1147,15 +1147,13 @@ export = {
     },
   ],
   iso3166: [
-    'AC',
     'AD',
     'AE',
     'AF',
     'AG',
     'AI',
     'AL',
     'AM',
-    'AN',
     'AO',
     'AQ',
     'AR',
@@ -1182,15 +1180,13 @@ export = {
     'BR',
     'BS',
     'BT',
-    'BU',
     'BV',
     'BW',
     'BY',
     'BZ',
     'CA',
     'CC',
     'CD',
-    'CE',
     'CF',
     'CG',
     'CH',
@@ -1200,40 +1196,32 @@ export = {
     'CM',
     'CN',
     'CO',
-    'CP',
     'CR',
-    'CS',
-    'CS',
     'CU',
     'CV',
     'CW',
     'CX',
     'CY',
     'CZ',
-    'DD',
     'DE',
-    'DG',
     'DJ',
     'DK',
     'DM',
     'DO',
     'DZ',
-    'EA',
     'EC',
     'EE',
     'EG',
     'EH',
     'ER',
     'ES',
     'ET',
-    'EU',
     'FI',
     'FJ',
     'FK',
     'FM',
     'FO',
     'FR',
-    'FX',
     'GA',
     'GB',
     'GD',
@@ -1259,7 +1247,6 @@ export = {
     'HR',
     'HT',
     'HU',
-    'IC',
     'ID',
     'IE',
     'IL',
@@ -1329,7 +1316,6 @@ export = {
     'NO',
     'NP',
     'NR',
-    'NT',
     'NU',
     'NZ',
     'OM',
@@ -1370,12 +1356,10 @@ export = {
     'SR',
     'SS',
     'ST',
-    'SU',
     'SV',
     'SX',
     'SY',
     'SZ',
-    'TA',
     'TC',
     'TD',
     'TF',
@@ -1407,12 +1391,11 @@ export = {
     'VU',
     'WF',
     'WS',
+    'XK',
     'YE',
     'YT',
-    'YU',
     'ZA',
     'ZM',
-    'ZR',
     'ZW',
   ],
 };