feat: precise number calculation

[Shinigami92]

closes #331

supersedes #555

[codecov]

Codecov Report

Merging #779 (b209d33) into main (1885dd0) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #779   +/-   ##
=======================================
  Coverage   99.34%   99.34%           
=======================================
  Files        1922     1922           
  Lines      183057   183064    +7     
  Branches      903      904    +1     
=======================================
+ Hits       181860   181867    +7     
  Misses       1141     1141           
  Partials       56       56           

Impacted Files	Coverage Δ
src/datatype.ts	100.00% <100.00%> (ø)

[Shinigami92]

It looks like that this is not healthy and when using somehow e.g. rollup to bundle your app it fails

So instead of using a peerDependency with optional, I'm thinking of providing an option to pass a precision calculation function to faker or number module 🤔

We could e.g. do this:

import { faker } from '@faker-js/faker'
import Decimal from 'decimal.js'

faker.Decimal = Decimal

Or maybe even make it more general like

import { faker } from '@faker-js/faker'
import Decimal from 'decimal.js'

faker.datatype.number({
  min,
  max,
  precision: 0.00001,
  precisionAlgo: (precision) => new Decimal(1)
        .dividedBy(precision)
        .toNumber()
})

But this has the problem that it could drastically compromise the value by just using a wrong implementation.
But beside that, I personally prefer the first solution due to you only need to set it once and for all application wide.

[ST-DDT]

We could e.g. do this:

import { faker } from '@faker-js/faker'
import Decimal from 'decimal.js'

faker.Decimal = Decimal

We should not pollute our public API like this.

  precisionAlgo: (precision) => new Decimal(1)
        .dividedBy(precision)
        .toNumber()

Hard no.

[ST-DDT]

IMO this should be a function (value, precision) => number or just a divide/multiply function.

[Shinigami92]

So yeah, like a combination of both my suggestions, but at module-scope instead of faker-scope

[ST-DDT]

@internal or private

[Shinigami92]

@internal or private

No, non of these, the user needs to be able optionally provide they own algorithm. That's the point of this PR.
Please have a look into my newest commit.

[Shinigami92]

Does someone have a better name?

I also need to declare and use it like this way, because if I eagerly provide a default function, it counts as datatype module function and will be bound by the constructor and the all_functional test fails badly.

[Shinigami92]

Currently looks like there is no much interest in this PR, will close it for now
If someone else would like to tackle the original issue, feel free