feat(helpers): fake from array

[ST-DDT]

Fixes #1446

Example Usage:

faker.helpers.fake(['A: {{name.firstName}}', 'B: {{name.lastName}}']) // 'A: Barry'

Docs Preview

[codecov]

Codecov Report

Merging #1453 (d496483) into next (4ce8e98) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Additional details and impacted files

@@           Coverage Diff            @@
##             next    #1453    +/-   ##
========================================
  Coverage   99.64%   99.65%            
========================================
  Files        2244     2244            
  Lines      240413   240509    +96     
  Branches     1071     1076     +5     
========================================
+ Hits       239562   239674   +112     
+ Misses        830      814    -16     
  Partials       21       21            

Impacted Files	Coverage Δ
src/modules/company/index.ts	100.00% <100.00%> (ø)
src/modules/helpers/index.ts	99.15% <100.00%> (+0.12%)	⬆️
src/modules/location/index.ts	99.77% <100.00%> (-0.01%)	⬇️
src/modules/internet/user-agent.ts	91.08% <0.00%> (+4.32%)	⬆️

[xDivisionByZerox]

TBH, I don't like this change, as it adds a lot of "unnecessary" complexity on top of an already complex function.
But I don't see anything wrong with the implementation itself.

[ST-DDT]

@xDivisionByZerox Would you prefer a separate method? Any suggestions for a name? fakeOneOf?

[xDivisionByZerox]

@xDivisionByZerox Would you prefer a separate method? Any suggestions for a name? fakeOneOf?

A separate method would definitely satisfy the single responsibility principle. But I guess that would negate the overall code improvement you had in mind with this changes? As now every function is required to first check the type and then call the according function:

function foo(options: string | string[]) {
  return Array.isArray(options) 
    ? this.faker.helpers.fakeOneOf(options) 
    : this faker.helpers.fake(options);
}