feat: datatype.number and number not parameter introduced

[amaster507]

Introduced not parameter for int and float number generators.

See: https://discord.com/channels/929487054990110771/929487054990110777/1058484035875258419

I had a recurring need to generate numbers with a provided parameter to signify what number I did not want generated.

To prevent endless loops in rare cases with limited runway between min and max parameters, I included a try count with a maximum of hardcoded 100 tries if the number generated is the number not wanted. If this were to occur, and error will be thrown as documented.

[Shinigami92]

Somehow it feels like we could try to archive the same in a different/better way
e.g. with a helpers function that could wrap such a call
This way we could have the same also for everything else, like a faker.person.firstName call, where the return value can be excluded and then a new try will be made

[amaster507]

Not against that idea either. This was my first attempt at this. But if there was a way to apply it more globally that would be helpful too.

[ST-DDT]

IMO banning a single value isnt that useful usually I omit certain values or values that match or dont match a certain criteria.

I think a dedicated method might be useful here.

E.g. faker.helpers.exclude(source: () => T, filter: T[] | Set<T> | (T) => boolean, options: {...})

Not sure about the exact signature yet.

[codecov]

Codecov Report

Merging #1702 (458e0dd) into next (e296ff2) will decrease coverage by 0.00%.
The diff coverage is 81.33%.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #1702      +/-   ##
==========================================
- Coverage   99.64%   99.63%   -0.01%     
==========================================
  Files        2240     2240              
  Lines      240101   240160      +59     
  Branches     1068     1075       +7     
==========================================
+ Hits       239242   239287      +45     
- Misses        838      852      +14     
  Partials       21       21              

Impacted Files	Coverage Δ
src/modules/number/index.ts	94.55% <77.04%> (-5.45%)	⬇️
src/modules/datatype/index.ts	100.00% <100.00%> (ø)

[Shinigami92]

IMO banning a single value isnt that useful usually I omit certain values or values that match or dont match a certain criteria.

I think a dedicated method might be useful here.

E.g. faker.helpers.exclude(source: () => T, filter: T[] | Set<T> | (T) => boolean, options: {...})

Not sure about the exact signature yet.

Yes, this is leading in the right direction as equally as I thought about it with my first comment
My only concern right now would be: is this based on mersenne/seed? Theoretically it looks like it's just a function that could be used from outside faker, could it?

Currently in my head it would look something like this (not tested at all):

function exclude(source, filter, options) {
  let success = false
  let value

  do {
    value = source(options)
    success = filter(value)
  } while (!success)

  return value
}

but as you can see, this is not bound to faker / merseene / seed at all and can be used for anything in JS world

[ST-DDT]

Team decision

We decided that we don't want functions that are not seed dependent in our library.
These function are very easy to implement yourself: #1702 (comment)