feat(helpers): add rangeToNumber method and add range parameters

[ST-DDT]

Fixes #617

• Adds helpers.rangeToNumber(numberOrRange: number | { min: number; max: number }): number
• And uses it where applicable

[codecov]

Codecov Report

Merging #1486 (2c871df) into next (7cbeda6) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff           @@
##             next    #1486   +/-   ##
=======================================
  Coverage   99.63%   99.63%           
=======================================
  Files        2216     2216           
  Lines      238845   238921   +76     
  Branches     1029     1039   +10     
=======================================
+ Hits       237983   238059   +76     
  Misses        841      841           
  Partials       21       21           

Impacted Files	Coverage Δ
src/modules/helpers/index.ts	98.55% <100.00%> (+0.04%)	⬆️
src/modules/lorem/index.ts	100.00% <100.00%> (ø)
src/modules/string/index.ts	100.00% <100.00%> (ø)
src/modules/system/index.ts	100.00% <100.00%> (ø)
src/modules/word/index.ts	98.50% <100.00%> (+0.03%)	⬆️

[Shinigami92]

I'm feeling a bit unconfy about this change.
Here are just my said out load thoughts but no blocker:

• toNumber could be made internal as I do not expect that it is in any kind helpful for an end user
• sometimes it's *count, sometimes it's length. Lets write a rule somewhere when to use which or lets unify them
• sometimes it's only length | { min, max }, sometimes it's length | { length | min, max }. I personally prefer the second one as then as a user you can use meth({ length: 42 }) and have readable code + it's a bit more future proof if another option param gets added (by us or by user)
• there are still parts in the code where an if-condition is needed to convert a length option into a number, I feel like this should also be handled by the helper method

[ST-DDT]

• toNumber could be made internal as I do not expect that it is in any kind helpful for an end user

Unless you want to write your own faker functions, which applies to most of our helper functions.

• sometimes it's *count, sometimes it's length. Lets write a rule somewhere when to use which or lets unify them

I didnt touch that part in this PR. This is a task for #1349.

• sometimes it's only length | { min, max }, sometimes it's length | { length | min, max }.

I can change that (use the range only in options).

• there are still parts in the code where an if-condition is needed to convert a length option into a number

Could you give me an example?

[Shinigami92]

• toNumber could be made internal as I do not expect that it is in any kind helpful for an end user

Unless you want to write your own faker functions, which applies to most of our helper functions.

Isn't this the same as you requested in image module? There I will also pass the faker instance just forward to the internal called function

• sometimes it's *count, sometimes it's length. Lets write a rule somewhere when to use which or lets unify them

I didnt touch that part in this PR. This is a task for #1349.

Ah okay, I already thought that this PR is at least a part of

• Standardize function parameters and defaults #1349

• there are still parts in the code where an if-condition is needed to convert a length option into a number

Could you give me an example?

I was referring to this part (I originally meant not from opt to num but from num to opt):

faker/src/modules/string/index.ts

Lines 125 to 131 in 6bb7368

	if (typeof options === 'number') {
	options = {
	length: options,
	};
	}
	const length = this.faker.helpers.toNumber(options.length ?? 1);

[ST-DDT]

I was referring to this part (I originally meant not from opt to num but from num to opt):

IMO that is a different feature. Maybe toOptions(...)? Not sure whether this should be done in this PR.

[ST-DDT]

Unless you want to write your own faker functions, which applies to most of our helper functions.

Isn't this the same as you requested in image module? There I will also pass the faker instance just forward to the internal called function

I don't think so or I don't know what you are referring to.

If someone external wants to write his own faker method, that happens to require a range of something e.g. a custom numericAlpha(length: number | { min: number, max: number}): string method, then the user can use the toNumber function in their implementation.
Similar on how a user would use helpers.arrayElement in their custom fooType(): FooType method.

[Shinigami92]

I was referring to this part (I originally meant not from opt to num but from num to opt):

IMO that is a different feature. Maybe toOptions(...)? Not sure whether this should be done in this PR.

I see, and I think this can then be solved on a more generic way, which indeed would then not fit anymore in this PR
Something like

options = toOptions(options);
const length = toNumber(options.length ?? 1);

But reading this toNumber feels now a bit like we should call it transformRangeToNumber, but thats ugly long 😕
I hope some other voices can help us with further ideas

[ST-DDT]

Team decision

• We will name the method rangeToNumber
• Create a separate PR adding these are helper methods that can be used to create your own faker methods to the helper module jsdocs

[ST-DDT]

Done. Ready for review.