aboutsummaryrefslogtreecommitdiff
path: root/src/modules
diff options
context:
space:
mode:
authorST-DDT <[email protected]>2024-10-16 20:56:03 +0200
committerGitHub <[email protected]>2024-10-16 18:56:03 +0000
commit6a9ca8abec3d8956b45a8607a5371b61de85378a (patch)
tree0b6ad925442373df068057363134ae1142755d8c /src/modules
parentdf597241003824279268c1dc9eae6c772c54760b (diff)
downloadfaker-6a9ca8abec3d8956b45a8607a5371b61de85378a.tar.xz
faker-6a9ca8abec3d8956b45a8607a5371b61de85378a.zip
docs: iban might be invalid due to country specific rules (#3175)
Diffstat (limited to 'src/modules')
-rw-r--r--src/modules/finance/index.ts4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts
index 4c84fe4c..0e9a6883 100644
--- 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`.