diff options
| author | ST-DDT <[email protected]> | 2025-01-11 21:57:52 +0100 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-01-11 20:57:52 +0000 |
| commit | 5d4754c51e2499df9e4a8e4684ad04d461066de7 (patch) | |
| tree | 11937b036cede30d7db0983fcb5383084dbae69f /src | |
| parent | 42dade59d3f6ac756965ca3fd951618e9ac24327 (diff) | |
| download | faker-5d4754c51e2499df9e4a8e4684ad04d461066de7.tar.xz faker-5d4754c51e2499df9e4a8e4684ad04d461066de7.zip | |
docs(finance): add seeAlsos (#3344)
* docs(finance): add seeAlsos
* chore: rephrase
Diffstat (limited to 'src')
| -rw-r--r-- | src/modules/finance/index.ts | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts index ad28747b..dd8ded53 100644 --- a/src/modules/finance/index.ts +++ b/src/modules/finance/index.ts @@ -64,6 +64,8 @@ export class FinanceModule extends ModuleBase { * * @param length The length of the account number. Defaults to `8`. * + * @see faker.string.numeric(): For generating the number with greater control. + * * @example * faker.finance.accountNumber() // '92842238' * faker.finance.accountNumber(5) // '32564' @@ -77,6 +79,8 @@ export class FinanceModule extends ModuleBase { * @param options An options object. * @param options.length The length of the account number. Defaults to `8`. * + * @see faker.string.numeric(): For generating the number with greater control. + * * @example * faker.finance.accountNumber() // '92842238' * faker.finance.accountNumber({ length: 5 }) // '32564' @@ -97,6 +101,8 @@ export class FinanceModule extends ModuleBase { * @param optionsOrLength An options object or the length of the account number. * @param optionsOrLength.length The length of the account number. Defaults to `8`. * + * @see faker.string.numeric(): For generating the number with greater control. + * * @example * faker.finance.accountNumber() // '92842238' * faker.finance.accountNumber(5) // '28736' @@ -122,6 +128,8 @@ export class FinanceModule extends ModuleBase { * @param options An options object or the length of the account number. * @param options.length The length of the account number. Defaults to `8`. * + * @see faker.string.numeric(): For generating the number with greater control. + * * @example * faker.finance.accountNumber() // '92842238' * faker.finance.accountNumber(5) // '28736' @@ -368,6 +376,8 @@ export class FinanceModule extends ModuleBase { * @param options.symbol The symbol used to prefix the amount. Defaults to `''`. * @param options.autoFormat If true this method will use `Number.toLocaleString()`. Otherwise it will use `Number.toFixed()`. * + * @see faker.number.float(): For generating the amount with greater control. + * * @example * faker.finance.amount() // '617.87' * faker.finance.amount({ min: 5, max: 10 }) // '5.53' @@ -718,6 +728,8 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * + * @see faker.string.numeric(): For generating the pin with greater control. + * * @example * faker.finance.pin() // '5067' * faker.finance.pin(6) // '213789' @@ -733,6 +745,8 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * + * @see faker.string.numeric(): For generating the pin with greater control. + * * @example * faker.finance.pin() // '5067' * faker.finance.pin({ length: 6 }) // '213789' @@ -755,6 +769,8 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * + * @see faker.string.numeric(): For generating the pin with greater control. + * * @example * faker.finance.pin() // '5067' * faker.finance.pin({ length: 6 }) // '213789' @@ -782,6 +798,8 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * + * @see faker.string.numeric(): For generating the pin with greater control. + * * @example * faker.finance.pin() // '5067' * faker.finance.pin({ length: 6 }) // '213789' |
