Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 4 commits into from
Oct 16, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/modules/finance/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down