feat(datatype): introduce probability option to boolean (#1476)

src/modules/datatype/index.ts

@@ -192,13 +192,37 @@ export class DatatypeModule {
   /**
    * Returns the boolean value true or false.
    *
+   * **Note:**
+   * A probability of `0.75` results in `true` being returned `75%` of the calls; likewise `0.3` => `30%`.
+   * If the probability is `<= 0.0`, it will always return `false`.
+   * If the probability is `>= 1.0`, it will always return `true`.
+   * The probability is limited to two decimal places.
+   *
+   * @param options The optional options object or the probability (`[0.00, 1.00]`) of returning `true`. Defaults to `0.5`.
+   * @param options.probability The probability (`[0.00, 1.00]`) of returning `true`. Defaults to `0.5`.
+   *
    * @example
    * faker.datatype.boolean() // false
+   * faker.datatype.boolean(0.9) // true
+   * faker.datatype.boolean({ probability: 0.1 }) // false
    *
    * @since 5.5.0
    */
-  boolean(): boolean {
-    return !!this.number(1);
+  boolean(options: number | { probability?: number } = {}): boolean {
+    if (typeof options === 'number') {
+      options = {
+        probability: options,
+      };
+    }
+    const { probability = 0.5 } = options;
+    if (probability <= 0) {
+      return false;
+    }
+    if (probability >= 1) {
+      // This check is required to avoid returning false when float() returns 1
+      return true;
+    }
+    return this.float({ min: 0, max: 1 }) < probability;
   }
 
   /**

src/modules/finance/index.ts

@@ -393,13 +393,13 @@ export class FinanceModule {
         if (bban.type === 'a') {
           s += this.faker.helpers.arrayElement(iban.alpha);
         } else if (bban.type === 'c') {
-          if (this.faker.datatype.number(100) < 80) {
+          if (this.faker.datatype.boolean(0.8)) {
             s += this.faker.datatype.number(9);
           } else {
             s += this.faker.helpers.arrayElement(iban.alpha);
           }
         } else {
-          if (c >= 3 && this.faker.datatype.number(100) < 30) {
+          if (c >= 3 && this.faker.datatype.boolean(0.3)) {
             if (this.faker.datatype.boolean()) {
               s += this.faker.helpers.arrayElement(iban.pattern100);
               c -= 2;

src/modules/helpers/index.ts

@@ -354,8 +354,7 @@ export class HelpersModule {
     callback: () => T,
     options: { probability?: number } = {}
   ): T | undefined {
-    const { probability = 0.5 } = options;
-    if (this.faker.datatype.float({ min: 0, max: 1 }) < probability) {
+    if (this.faker.datatype.boolean(options)) {
       return callback();
     }
     return undefined;

test/__snapshots__/datatype.spec.ts.snap

@@ -2,41 +2,45 @@
 
 exports[`datatype > 42 > array > noArgs 1`] = `
 [
-  79654,
-  "2eiXX/J/*&",
-  86617,
-  60111,
-  70807,
-  "\\"&{dnx4!1}",
-  61748,
-  61165,
-  "!I#<QYF-%<",
-  "C6K)jZ3DP|",
+  "ky2eiXX/J/",
+  "&Kq@X.b]\\"&",
+  72199,
+  93855,
+  "!1}2Z=YQ!I",
+  "<QYF-%<{C6",
+  ")jZ3DP|XL%",
+  60754,
+  17052,
+  "'\\"yxzUlD=\\"",
 ]
 `;
 
 exports[`datatype > 42 > array > with length 1`] = `
 [
-  79654,
-  "2eiXX/J/*&",
-  86617,
-  60111,
+  "ky2eiXX/J/",
+  "&Kq@X.b]\\"&",
+  72199,
+  93855,
 ]
 `;
 
 exports[`datatype > 42 > bigInt > noArgs 1`] = `379177551410048n`;
 
 exports[`datatype > 42 > bigInt > with value 1`] = `37n`;
 
-exports[`datatype > 42 > boolean 1`] = `false`;
+exports[`datatype > 42 > boolean > noArgs 1`] = `true`;
 
-exports[`datatype > 42 > boolean 2`] = `true`;
+exports[`datatype > 42 > boolean > noArgs 2`] = `false`;
 
-exports[`datatype > 42 > boolean 3`] = `true`;
+exports[`datatype > 42 > boolean > noArgs 3`] = `false`;
 
-exports[`datatype > 42 > boolean 4`] = `false`;
+exports[`datatype > 42 > boolean > noArgs 4`] = `true`;
 
-exports[`datatype > 42 > boolean 5`] = `true`;
+exports[`datatype > 42 > boolean > noArgs 5`] = `false`;
+
+exports[`datatype > 42 > boolean > with probability 1`] = `true`;
+
+exports[`datatype > 42 > boolean > with probability option 1`] = `false`;
 
 exports[`datatype > 42 > datetime > noArgs 1`] = `2031-03-14T21:33:22.114Z`;
 
@@ -80,7 +84,7 @@ exports[`datatype > 42 > hexadecimal > with length, prefix, and casing 1`] = `"0
 
 exports[`datatype > 42 > hexadecimal > with prefix 1`] = `"0x8"`;
 
-exports[`datatype > 42 > json 1`] = `"{\\"foo\\":79654,\\"bar\\":\\"2eiXX/J/*&\\",\\"bike\\":86617,\\"a\\":60111,\\"b\\":70807,\\"name\\":\\"\\\\\\"&{dnx4!1}\\",\\"prop\\":61748}"`;
+exports[`datatype > 42 > json 1`] = `"{\\"foo\\":\\"ky2eiXX/J/\\",\\"bar\\":\\"&Kq@X.b]\\\\\\"&\\",\\"bike\\":72199,\\"a\\":93855,\\"b\\":\\"!1}2Z=YQ!I\\",\\"name\\":\\"<QYF-%<{C6\\",\\"prop\\":\\")jZ3DP|XL%\\"}"`;
 
 exports[`datatype > 42 > number > noArgs 1`] = `37454`;
 
@@ -118,41 +122,45 @@ exports[`datatype > 42 > uuid 5`] = `"d95f4984-24c2-410f-ac63-400d3bbbcc91"`;
 
 exports[`datatype > 1211 > array > noArgs 1`] = `
 [
-  "Kti5-}$_/\`",
-  76408,
-  35403,
-  69406,
-  "l\\"h^]dnwI<",
-  "|p|5KWu3/C",
-  "|Jh!E=x\\"RH",
-  "/5V<1bEQuA",
-  "p=DW9F=V1(",
-  "7a6.$boN\\\\7",
+  45901,
+  77826,
+  "-}$_/\`4hHA",
+  "afl\\"h^]dnw",
+  "<q|p|5KWu3",
+  "CZ|Jh!E=x\\"",
+  42131,
+  15894,
+  "V<1bEQuA|p",
+  "DW9F=V1(U7",
 ]
 `;
 
 exports[`datatype > 1211 > array > with length 1`] = `
 [
-  "Kti5-}$_/\`",
-  76408,
-  35403,
-  69406,
+  45901,
+  77826,
+  "-}$_/\`4hHA",
+  "afl\\"h^]dnw",
 ]
 `;
 
 exports[`datatype > 1211 > bigInt > noArgs 1`] = `948721906162743n`;
 
 exports[`datatype > 1211 > bigInt > with value 1`] = `8n`;
 
-exports[`datatype > 1211 > boolean 1`] = `true`;
+exports[`datatype > 1211 > boolean > noArgs 1`] = `false`;
+
+exports[`datatype > 1211 > boolean > noArgs 2`] = `true`;
 
-exports[`datatype > 1211 > boolean 2`] = `false`;
+exports[`datatype > 1211 > boolean > noArgs 3`] = `false`;
 
-exports[`datatype > 1211 > boolean 3`] = `true`;
+exports[`datatype > 1211 > boolean > noArgs 4`] = `false`;
 
-exports[`datatype > 1211 > boolean 4`] = `true`;
+exports[`datatype > 1211 > boolean > noArgs 5`] = `true`;
 
-exports[`datatype > 1211 > boolean 5`] = `false`;
+exports[`datatype > 1211 > boolean > with probability 1`] = `false`;
+
+exports[`datatype > 1211 > boolean > with probability option 1`] = `false`;
 
 exports[`datatype > 1211 > datetime > noArgs 1`] = `2092-02-20T03:42:04.341Z`;
 
@@ -196,7 +204,7 @@ exports[`datatype > 1211 > hexadecimal > with length, prefix, and casing 1`] = `
 
 exports[`datatype > 1211 > hexadecimal > with prefix 1`] = `"0xE"`;
 
-exports[`datatype > 1211 > json 1`] = `"{\\"foo\\":\\"Kti5-}$_/\`\\",\\"bar\\":76408,\\"bike\\":35403,\\"a\\":69406,\\"b\\":\\"l\\\\\\"h^]dnwI<\\",\\"name\\":\\"|p|5KWu3/C\\",\\"prop\\":\\"|Jh!E=x\\\\\\"RH\\"}"`;
+exports[`datatype > 1211 > json 1`] = `"{\\"foo\\":45901,\\"bar\\":77826,\\"bike\\":\\"-}$_/\`4hHA\\",\\"a\\":\\"afl\\\\\\"h^]dnw\\",\\"b\\":\\"<q|p|5KWu3\\",\\"name\\":\\"CZ|Jh!E=x\\\\\\"\\",\\"prop\\":42131}"`;
 
 exports[`datatype > 1211 > number > noArgs 1`] = `92852`;
 
@@ -234,41 +242,45 @@ exports[`datatype > 1211 > uuid 5`] = `"7b91ce88-effb-4d1d-93bb-ad759e00b86c"`;
 
 exports[`datatype > 1337 > array > noArgs 1`] = `
 [
-  56052,
-  21258,
-  54308,
-  3397,
-  23538,
-  "X9@{:e=+kD",
-  62850,
-  12505,
-  "|/Jqjjj!BL",
-  38106,
+  "U/4:SK$>6Q",
+  26194,
+  "{:e=+kD)[B",
+  "e|/Jqjjj!B",
+  "GDWQgC2M;q",
+  40502,
+  44050,
+  ".Gm3tRwnZ2",
+  95735,
+  42541,
 ]
 `;
 
 exports[`datatype > 1337 > array > with length 1`] = `
 [
-  56052,
-  21258,
-  54308,
-  3397,
+  "U/4:SK$>6Q",
+  26194,
+  "{:e=+kD)[B",
+  "e|/Jqjjj!B",
 ]
 `;
 
 exports[`datatype > 1337 > bigInt > noArgs 1`] = `251225403255239n`;
 
 exports[`datatype > 1337 > bigInt > with value 1`] = `25n`;
 
-exports[`datatype > 1337 > boolean 1`] = `false`;
+exports[`datatype > 1337 > boolean > noArgs 1`] = `true`;
+
+exports[`datatype > 1337 > boolean > noArgs 2`] = `false`;
+
+exports[`datatype > 1337 > boolean > noArgs 3`] = `true`;
 
-exports[`datatype > 1337 > boolean 2`] = `true`;
+exports[`datatype > 1337 > boolean > noArgs 4`] = `true`;
 
-exports[`datatype > 1337 > boolean 3`] = `false`;
+exports[`datatype > 1337 > boolean > noArgs 5`] = `true`;
 
-exports[`datatype > 1337 > boolean 4`] = `false`;
+exports[`datatype > 1337 > boolean > with probability 1`] = `true`;
 
-exports[`datatype > 1337 > boolean 5`] = `false`;
+exports[`datatype > 1337 > boolean > with probability option 1`] = `false`;
 
 exports[`datatype > 1337 > datetime > noArgs 1`] = `2018-10-28T08:46:11.896Z`;
 
@@ -312,7 +324,7 @@ exports[`datatype > 1337 > hexadecimal > with length, prefix, and casing 1`] = `
 
 exports[`datatype > 1337 > hexadecimal > with prefix 1`] = `"0x5"`;
 
-exports[`datatype > 1337 > json 1`] = `"{\\"foo\\":56052,\\"bar\\":21258,\\"bike\\":54308,\\"a\\":3397,\\"b\\":23538,\\"name\\":\\"X9@{:e=+kD\\",\\"prop\\":62850}"`;
+exports[`datatype > 1337 > json 1`] = `"{\\"foo\\":\\"U/4:SK$>6Q\\",\\"bar\\":26194,\\"bike\\":\\"{:e=+kD)[B\\",\\"a\\":\\"e|/Jqjjj!B\\",\\"b\\":\\"GDWQgC2M;q\\",\\"name\\":40502,\\"prop\\":44050}"`;
 
 exports[`datatype > 1337 > number > noArgs 1`] = `26202`;
 

test/__snapshots__/finance.spec.ts.snap

@@ -16,9 +16,9 @@ exports[`finance > 42 > amount > with min 1`] = `"380.79"`;
 
 exports[`finance > 42 > amount > with min and max and dec and symbol 1`] = `"$24.98160"`;
 
-exports[`finance > 42 > bic > noArgs 1`] = `"UYETSCLL"`;
+exports[`finance > 42 > bic > noArgs 1`] = `"UYETSCLLG53"`;
 
-exports[`finance > 42 > bic > with branch code 1`] = `"JUYEPSSL5G5"`;
+exports[`finance > 42 > bic > with branch code 1`] = `"JUYEPSSLXXX"`;
 
 exports[`finance > 42 > bitcoinAddress 1`] = `"3XbJMAAara64sSkA9HD24YHQWd1bZbB"`;
 
@@ -42,7 +42,7 @@ exports[`finance > 42 > iban > noArgs 1`] = `"GT30Y75110867098F1E3542612J4"`;
 
 exports[`finance > 42 > iban > with formatted 1`] = `"GT30 Y751 1086 7098 F1E3 5426 12J4"`;
 
-exports[`finance > 42 > iban > with formatted and countryCode 1`] = `"DE05 7175 0200 8600 6098 92"`;
+exports[`finance > 42 > iban > with formatted and countryCode 1`] = `"DE47 7175 0020 0086 0600 97"`;
 
 exports[`finance > 42 > litecoinAddress 1`] = `"3XbJMAAara64sSkA9HD24YHQWd1b"`;
 
@@ -82,9 +82,9 @@ exports[`finance > 1211 > amount > with min 1`] = `"929.24"`;
 
 exports[`finance > 1211 > amount > with min and max and dec and symbol 1`] = `"$47.14081"`;
 
-exports[`finance > 1211 > bic > noArgs 1`] = `"LXUFBTZ15O7"`;
+exports[`finance > 1211 > bic > noArgs 1`] = `"LXUFBTZ1"`;
 
-exports[`finance > 1211 > bic > with branch code 1`] = `"YLXUDE4ZXXX"`;
+exports[`finance > 1211 > bic > with branch code 1`] = `"YLXUDE4ZO5O"`;
 
 exports[`finance > 1211 > bitcoinAddress 1`] = `"1TMe8Z3EaFdLqmaGKP1LEEJQVriSZRZdsAUc9nC"`;
 
@@ -104,11 +104,11 @@ exports[`finance > 1211 > currencySymbol 1`] = `"₭"`;
 
 exports[`finance > 1211 > ethereumAddress 1`] = `"0xeadb42f0e3f4a973fab0aeefce96dfcf49cd438d"`;
 
-exports[`finance > 1211 > iban > noArgs 1`] = `"TN0382001124170679299069"`;
+exports[`finance > 1211 > iban > noArgs 1`] = `"TN4282016024170679299006"`;
 
-exports[`finance > 1211 > iban > with formatted 1`] = `"TN03 8200 1124 1706 7929 9069"`;
+exports[`finance > 1211 > iban > with formatted 1`] = `"TN42 8201 6024 1706 7929 9006"`;
 
-exports[`finance > 1211 > iban > with formatted and countryCode 1`] = `"DE63 4709 0026 0041 7067 89"`;
+exports[`finance > 1211 > iban > with formatted and countryCode 1`] = `"DE41 4700 9026 0417 0679 42"`;
 
 exports[`finance > 1211 > litecoinAddress 1`] = `"MTMe8Z3EaFdLqmaGKP1LEEJQVriSZRZds"`;
 
@@ -148,9 +148,9 @@ exports[`finance > 1337 > amount > with min 1`] = `"269.40"`;
 
 exports[`finance > 1337 > amount > with min and max and dec and symbol 1`] = `"$20.48098"`;
 
-exports[`finance > 1337 > bic > noArgs 1`] = `"OEFHLYG1"`;
+exports[`finance > 1337 > bic > noArgs 1`] = `"OEFHLYG18IL"`;
 
-exports[`finance > 1337 > bic > with branch code 1`] = `"GOEFFIJGXXX"`;
+exports[`finance > 1337 > bic > with branch code 1`] = `"GOEFFIJGB8I"`;
 
 exports[`finance > 1337 > bitcoinAddress 1`] = `"3adhxs2jewAgkYgJi7No6Cn8JZarS"`;
 
@@ -170,11 +170,11 @@ exports[`finance > 1337 > currencySymbol 1`] = `"$"`;
 
 exports[`finance > 1337 > ethereumAddress 1`] = `"0x5c346ba075bd57f5a62b82d72af39cbbb07a98cb"`;
 
-exports[`finance > 1337 > iban > noArgs 1`] = `"FO7710540350900318"`;
+exports[`finance > 1337 > iban > noArgs 1`] = `"FO5610050250090318"`;
 
-exports[`finance > 1337 > iban > with formatted 1`] = `"FO77 1054 0350 9003 18"`;
+exports[`finance > 1337 > iban > with formatted 1`] = `"FO56 1005 0250 0903 18"`;
 
-exports[`finance > 1337 > iban > with formatted and countryCode 1`] = `"DE61 0020 5032 5090 0300 40"`;
+exports[`finance > 1337 > iban > with formatted and countryCode 1`] = `"DE04 0200 5032 5009 0304 06"`;
 
 exports[`finance > 1337 > litecoinAddress 1`] = `"Madhxs2jewAgkYgJi7No6Cn8JZar"`;
 

test/__snapshots__/helpers.spec.ts.snap

@@ -65,9 +65,9 @@ exports[`helpers > 42 > replaceSymbolWithNumber > some string 1`] = `"^123456789
 
 exports[`helpers > 42 > replaceSymbols > noArgs 1`] = `""`;
 
-exports[`helpers > 42 > replaceSymbols > only symbols 1`] = `"3UE7UP"`;
+exports[`helpers > 42 > replaceSymbols > only symbols 1`] = `"3U17U5"`;
 
-exports[`helpers > 42 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=J\`+7E,..-;:_"`;
+exports[`helpers > 42 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=J\`+71,..-;:_"`;
 
 exports[`helpers > 42 > shuffle > noArgs 1`] = `[]`;
 
@@ -181,9 +181,9 @@ exports[`helpers > 1211 > replaceSymbolWithNumber > some string 1`] = `"^1234567
 
 exports[`helpers > 1211 > replaceSymbols > noArgs 1`] = `""`;
 
-exports[`helpers > 1211 > replaceSymbols > only symbols 1`] = `"9LU2DA"`;
+exports[`helpers > 1211 > replaceSymbols > only symbols 1`] = `"9L72D0"`;
 
-exports[`helpers > 1211 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=Y\`+4U,..-;:_"`;
+exports[`helpers > 1211 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=Y\`+47,..-;:_"`;
 
 exports[`helpers > 1211 > shuffle > noArgs 1`] = `[]`;
 
@@ -287,9 +287,9 @@ exports[`helpers > 1337 > replaceSymbolWithNumber > some string 1`] = `"^1234567
 
 exports[`helpers > 1337 > replaceSymbols > noArgs 1`] = `""`;
 
-exports[`helpers > 1337 > replaceSymbols > only symbols 1`] = `"2O22O0"`;
+exports[`helpers > 1337 > replaceSymbols > only symbols 1`] = `"2OF2OA"`;
 
-exports[`helpers > 1337 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=G\`+52,..-;:_"`;
+exports[`helpers > 1337 > replaceSymbols > some string 1`] = `"^1234567890ß´°!\\"§$%&/()=G\`+5F,..-;:_"`;
 
 exports[`helpers > 1337 > shuffle > noArgs 1`] = `[]`;