docs: iban might be invalid due to country specific rules (#3175)

faker-js · Oct 16, 2024 · 6a9ca8a · 6a9ca8a
1 parent df59724
commit 6a9ca8a
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts
@@ -816,7 +816,9 @@ export class FinanceModule extends ModuleBase {
   }
 
   /**
-   * Generates a random iban.
+   * Generates a random IBAN.
+   *
+   * Please note that the generated IBAN might be invalid due to randomly generated bank codes/other country specific validation rules.
    *
    * @param options An options object.
    * @param options.formatted Return a formatted version of the generated IBAN. Defaults to `false`.