feat: faker.finance.pin() (#695)

1 files changed, 17 insertions, 0 deletions

diff --git a/src/finance.ts b/src/finance.ts
index 5581ad4e..32f8454e 100644
--- a/src/finance.ts
+++ b/src/finance.ts
@@ -292,6 +292,23 @@ export class Finance {
   }
 
   /**
+   * Generates a random PIN number.
+   *
+   * @param length The length of the PIN to generate. Defaults to `4`.
+   * @throws Will throw an error if length is less than 1.
+   *
+   * @example
+   * faker.finance.pin() // '5067'
+   * faker.finance.pin(6) // '213789'
+   */
+  pin(length: number = 4): string {
+    if (length < 1) {
+      throw new FakerError('minimum length is 1');
+    }
+    return Array.from({ length }, () => this.faker.datatype.number(9)).join('');
+  }
+
+  /**
    * Generates a random ethereum Address.
    *
    * @example