diff options
| author | ST-DDT <[email protected]> | 2023-04-17 10:13:48 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-04-17 08:13:48 +0000 |
| commit | 62b1aed46b108b08b25fcedf8d2606870cffb233 (patch) | |
| tree | 8626a5101dfb7a63752397f8e02d914ed1c5c225 /src/modules/finance | |
| parent | 153e0ca29742c42814a97117f7d976f23e93c0d4 (diff) | |
| download | faker-62b1aed46b108b08b25fcedf8d2606870cffb233.tar.xz faker-62b1aed46b108b08b25fcedf8d2606870cffb233.zip | |
chore: consistent jsdocs tag formatting (#2056)
Diffstat (limited to 'src/modules/finance')
| -rw-r--r-- | src/modules/finance/index.ts | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts index 579bd89b..cca634c0 100644 --- a/src/modules/finance/index.ts +++ b/src/modules/finance/index.ts @@ -839,6 +839,7 @@ export class FinanceModule { * 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 @@ -853,6 +854,7 @@ export class FinanceModule { * * @param options An options object. Defaults to `{}`. * @param options.length The length of the PIN to generate. Defaults to `4`. + * * @throws Will throw an error if length is less than 1. * * @example @@ -874,6 +876,7 @@ export class FinanceModule { * * @param options An options object or the length of the PIN. Defaults to `{}`. * @param options.length The length of the PIN to generate. Defaults to `4`. + * * @throws Will throw an error if length is less than 1. * * @example @@ -900,6 +903,7 @@ export class FinanceModule { * * @param options An options object or the length of the PIN. Defaults to `{}`. * @param options.length The length of the PIN to generate. Defaults to `4`. + * * @throws Will throw an error if length is less than 1. * * @example @@ -957,6 +961,7 @@ export class FinanceModule { * * @param formatted Return a formatted version of the generated IBAN. Defaults to `false`. * @param countryCode The country code from which you want to generate an IBAN, if none is provided a random country will be used. + * * @throws Will throw an error if the passed country code is not supported. * * @example @@ -973,6 +978,7 @@ export class FinanceModule { * @param options An options object. Defaults to `{}`. * @param options.formatted Return a formatted version of the generated IBAN. Defaults to `false`. * @param options.countryCode The country code from which you want to generate an IBAN, if none is provided a random country will be used. + * * @throws Will throw an error if the passed country code is not supported. * * @example |