feat: faker.helpers.maybe

[Shinigami92]

closes #870

GitHub Copilot generated some JSDocs and provided the naming maybe instead of optional, and I like that more, so I took that as name

[codecov]

Codecov Report

Merging #874 (cdb08e0) into main (b41c662) will increase coverage by 0.00%.
The diff coverage is 100.00%.

❗ Current head cdb08e0 differs from pull request most recent head b850236. Consider uploading reports for the commit b850236 to get more accurate results

@@           Coverage Diff           @@
##             main     #874   +/-   ##
=======================================
  Coverage   99.42%   99.42%           
=======================================
  Files        1958     1958           
  Lines      210862   210886   +24     
  Branches      919      922    +3     
=======================================
+ Hits       209649   209673   +24     
  Misses       1156     1156           
  Partials       57       57           

Impacted Files	Coverage Δ
src/helpers.ts	99.30% <100.00%> (+0.02%)	⬆️

[xDivisionByZerox]

@ST-DDT proposed here to place this method in the helpers module. I think that would be better than exposing it in the random module.

[Shinigami92]

@ST-DDT proposed here to place this method in the helpers module. I think that would be better than exposing it in the random module.

Oh, I oversaw this. But my current understatement is that random should handle values that are based on deterministic and helpers contains only stuff that are like utilities 🤔
Like slugify or repeatString
I also wrote that down here: #805 (reply in thread)

But I can be wrong and if you are voting for handling it differently, let's define that now and write that down somewhere.

[ST-DDT]

But my current understatement is that random should handle values that are based on deterministic

For the return value that is. Here the value/source is passed by the user.

and helpers contains only stuff that are like utilities 🤔 Like slugify or repeatString

IMO this maybe is exactly a helper, as it simplifies certain tasks for the user, but the output is heavily dependent on the users input and not some locale.

I also wrote that down here: #805 (reply in thread)

I couldn't find the exact part that you were referring to, probably not:

Random

• It could be fully removed? ...

---

• For Helpers vote this post with the rocket 🚀 .
• For Random vote this post with the party 🎉 .

[Shinigami92]

I was talking about

• Helpers
  • Should only contain stuff that is not based on locale definitions!

For deterministic, I talked about

faker/src/random.ts

Line 629 in f3dab67

if (this.faker.datatype.float({ min: 0, max: 1 }) < probability) {

IMO it is like arrayElement, we should really come up with some well defined structure of modules so that questions like this cannot raise anymore in future...

[ST-DDT]

IMO:

• Helpers is for everything that transforms the input
• Random generates new stuff

[Shinigami92]

IMO:

• Helpers is for everything that transforms the input
• Random generates new stuff

I accept this, let's write it down. For now please update our internal Google Docs with that

[ST-DDT]