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.

Sign up for GitHub

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(finance): add seeAlsos #3344

Merged
merged 2 commits into from
Jan 11, 2025
Merged

docs(finance): add seeAlsos #3344

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c38c45
docs(finance): add seeAlsos
ST-DDT Dec 28, 2024
dfb81dc
chore: rephrase
ST-DDT Dec 28, 2024
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
18 changes: 18 additions & 0 deletions src/modules/finance/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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'
Expand Down Expand Up @@ -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'
Expand All @@ -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'
Expand All @@ -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'
Expand Down Expand Up @@ -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'
Expand Down
Loading