diff options
Diffstat (limited to 'src/modules/finance')
| -rw-r--r-- | src/modules/finance/index.ts | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/src/modules/finance/index.ts b/src/modules/finance/index.ts index 4e0d80ed..c443b605 100644 --- a/src/modules/finance/index.ts +++ b/src/modules/finance/index.ts @@ -78,7 +78,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random account number. * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.length The length of the account number. Defaults to `8`. * * @example @@ -98,7 +98,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random account number. * - * @param optionsOrLength An options object or the length of the account number. Defaults to `{}`. + * @param optionsOrLength An options object or the length of the account number. * @param optionsOrLength.length The length of the account number. Defaults to `8`. * * @example @@ -123,7 +123,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random account number. * - * @param options An options object or the length of the account number. Defaults to `{}`. + * @param options An options object or the length of the account number. * @param options.length The length of the account number. Defaults to `8`. * * @example @@ -241,7 +241,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random masked number. * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.length The length of the unmasked number. Defaults to `4`. * @param options.parens Whether to use surrounding parenthesis. Defaults to `true`. * @param options.ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`. @@ -262,7 +262,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random masked number. * - * @param optionsOrLength An options object or the length of the unmask number. Defaults to `{}`. + * @param optionsOrLength An options object or the length of the unmask number. * @param optionsOrLength.length The length of the unmasked number. Defaults to `4`. * @param optionsOrLength.parens Whether to use surrounding parenthesis. Defaults to `true`. * @param optionsOrLength.ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`. @@ -303,7 +303,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random masked number. * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.length The length of the unmasked number. Defaults to `4`. * @param options.parens Whether to use surrounding parenthesis. Defaults to `true`. * @param options.ellipsis Whether to prefix the numbers with an ellipsis. Defaults to `true`. @@ -388,7 +388,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random amount between the given bounds (inclusive). * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.min The lower bound for the amount. Defaults to `0`. * @param options.max The upper bound for the amount. Defaults to `1000`. * @param options.dec The number of decimal places for the amount. Defaults to `2`. @@ -439,7 +439,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random amount between the given bounds (inclusive). * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.min The lower bound for the amount. Defaults to `0`. * @param options.max The upper bound for the amount. Defaults to `1000`. * @param options.dec The number of decimal places for the amount. Defaults to `2`. @@ -448,7 +448,7 @@ export class FinanceModule extends ModuleBase { * @param legacyMax The upper bound for the amount. Defaults to `1000`. * @param legacyDec The number of decimal places for the amount. Defaults to `2`. * @param legacySymbol The symbol used to prefix the amount. Defaults to `''`. - * @param legacyAutoFormat If true this method will use `Number.toLocaleString()`. Otherwise it will use `Number.toFixed()`. + * @param legacyAutoFormat If true this method will use `Number.toLocaleString()`. Otherwise it will use `Number.toFixed()`. Defaults to `false`. * * @example * faker.finance.amount() // '617.87' @@ -506,7 +506,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random amount between the given bounds (inclusive). * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.min The lower bound for the amount. Defaults to `0`. * @param options.max The upper bound for the amount. Defaults to `1000`. * @param options.dec The number of decimal places for the amount. Defaults to `2`. @@ -515,7 +515,7 @@ export class FinanceModule extends ModuleBase { * @param legacyMax The upper bound for the amount. Defaults to `1000`. * @param legacyDec The number of decimal places for the amount. Defaults to `2`. * @param legacySymbol The symbol used to prefix the amount. Defaults to `''`. - * @param legacyAutoFormat If true this method will use `Number.toLocaleString()`. Otherwise it will use `Number.toFixed()`. + * @param legacyAutoFormat If true this method will use `Number.toLocaleString()`. Otherwise it will use `Number.toFixed()`. Defaults to `false`. * * @example * faker.finance.amount() // '617.87' @@ -750,7 +750,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random credit card number. * - * @param options An options object, the issuer or a custom format. Defaults to `{}`. + * @param options An options object, the issuer or a custom format. * @param options.issuer The name of the issuer (case-insensitive) or the format used to generate one. * * @example @@ -776,7 +776,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random credit card number. * - * @param options An options object, the issuer or a custom format. Defaults to `{}`. + * @param options An options object, the issuer or a custom format. * @param options.issuer The name of the issuer (case-insensitive) or the format used to generate one. * * @example @@ -867,7 +867,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random PIN number. * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @param options.length The length of the PIN to generate. Defaults to `4`. * * @throws Will throw an error if length is less than 1. @@ -889,7 +889,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random PIN number. * - * @param options An options object or the length of the PIN. Defaults to `{}`. + * @param options An options object or the length of the PIN. * @param options.length The length of the PIN to generate. Defaults to `4`. * * @throws Will throw an error if length is less than 1. @@ -916,7 +916,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random PIN number. * - * @param options An options object or the length of the PIN. Defaults to `{}`. + * @param options An options object or the length of the PIN. * @param options.length The length of the PIN to generate. Defaults to `4`. * * @throws Will throw an error if length is less than 1. @@ -990,7 +990,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random iban. * - * @param options An options object. Defaults to `{}`. + * @param options An options object. * @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. * @@ -1019,7 +1019,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random iban. * - * @param options An options object or whether the return value should be formatted. Defaults to `{}`. + * @param options An options object or whether the return value should be formatted. * @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. * @param legacyCountryCode The country code from which you want to generate an IBAN, if none is provided a random country will be used. @@ -1056,7 +1056,7 @@ export class FinanceModule extends ModuleBase { /** * Generates a random iban. * - * @param options An options object or whether the return value should be formatted. Defaults to `{}`. + * @param options An options object or whether the return value should be formatted. * @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. * @param legacyCountryCode The country code from which you want to generate an IBAN, if none is provided a random country will be used. |
