From 0c38c451cc47899f9ef3d23a8ddc45755fb6f6d0 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 28 Dec 2024 16:06:23 +0100 Subject: [PATCH 1/2] docs(finance): add seeAlsos --- src/modules/finance/index.ts | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts index cc4068089e1..8471ef1643c 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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @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 more control over the generated number. + * * @example * faker.finance.pin() // '5067' * faker.finance.pin({ length: 6 }) // '213789' From dfb81dc47471193a8cd79894a61bbb5d560f4868 Mon Sep 17 00:00:00 2001 From: ST-DDT Date: Sat, 28 Dec 2024 16:18:23 +0100 Subject: [PATCH 2/2] chore: rephrase --- src/modules/finance/index.ts | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts index 8471ef1643c..428735399bd 100644 --- a/src/modules/finance/index.ts +++ b/src/modules/finance/index.ts @@ -64,7 +64,7 @@ export class FinanceModule extends ModuleBase { * * @param length The length of the account number. Defaults to `8`. * - * @see faker.string.numeric(): For more control over the generated number. + * @see faker.string.numeric(): For generating the number with greater control. * * @example * faker.finance.accountNumber() // 92842238 @@ -79,7 +79,7 @@ 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 more control over the generated number. + * @see faker.string.numeric(): For generating the number with greater control. * * @example * faker.finance.accountNumber() // 92842238 @@ -101,7 +101,7 @@ 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 more control over the generated number. + * @see faker.string.numeric(): For generating the number with greater control. * * @example * faker.finance.accountNumber() // 92842238 @@ -128,7 +128,7 @@ 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 more control over the generated number. + * @see faker.string.numeric(): For generating the number with greater control. * * @example * faker.finance.accountNumber() // 92842238 @@ -376,7 +376,7 @@ 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 more control over the generated number. + * @see faker.number.float(): For generating the amount with greater control. * * @example * faker.finance.amount() // '617.87' @@ -728,7 +728,7 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * - * @see faker.string.numeric(): For more control over the generated number. + * @see faker.string.numeric(): For generating the pin with greater control. * * @example * faker.finance.pin() // '5067' @@ -745,7 +745,7 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * - * @see faker.string.numeric(): For more control over the generated number. + * @see faker.string.numeric(): For generating the pin with greater control. * * @example * faker.finance.pin() // '5067' @@ -769,7 +769,7 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * - * @see faker.string.numeric(): For more control over the generated number. + * @see faker.string.numeric(): For generating the pin with greater control. * * @example * faker.finance.pin() // '5067' @@ -798,7 +798,7 @@ export class FinanceModule extends ModuleBase { * * @throws Will throw an error if length is less than 1. * - * @see faker.string.numeric(): For more control over the generated number. + * @see faker.string.numeric(): For generating the pin with greater control. * * @example * faker.finance.pin() // '5067'