feat: datatype.hexadecimal signature change

[import-brain]

closes #954

[codecov]

Codecov Report

Merging #1238 (3ad814f) into main (d4cfe97) will decrease coverage by 0.01%.
The diff coverage is 76.08%.

@@            Coverage Diff             @@
##             main    #1238      +/-   ##
==========================================
- Coverage   99.63%   99.62%   -0.02%     
==========================================
  Files        2156     2156              
  Lines      236988   237025      +37     
  Branches     1007     1007              
==========================================
+ Hits       236124   236133       +9     
- Misses        843      871      +28     
  Partials       21       21              

Impacted Files	Coverage Δ
src/modules/datatype/index.ts	96.03% <71.79%> (-3.03%)	⬇️
src/modules/color/index.ts	99.71% <100.00%> (ø)
src/modules/database/index.ts	100.00% <100.00%> (ø)
src/modules/finance/index.ts	100.00% <100.00%> (ø)
src/modules/internet/user-agent.ts	83.59% <0.00%> (-4.50%)	⬇️

[ST-DDT]

This is a breaking change without our usual deprecation mechanics.

[ST-DDT]

One minor change then it looks good to go.

[ST-DDT]

Docs Preview (Click to expand)

[xDivisionByZerox]

This is a breaking change without our usual deprecation mechanics.

Why did this got merged then?
@import-brain you removed the BREAKING CHANGE label. Why that?

This PR has an incorrect type as well.

[Shinigami92]

This is a breaking change without our usual deprecation mechanics.

Why did this got merged then? @import-brain you removed the BREAKING CHANGE label. Why that?

This PR has an incorrect type as well.

I assume it was just one or few days before we finally defined how we want changelogs to be formatted
so this was one of the last that slept into the changelogs

[xDivisionByZerox]

This explains the PR type (which is my minor concern).

Currently, this BREAKING CHANGE is in the main branch but we plan to release a new minor version on Monday. That's what I'm more concerned about.

[import-brain]

This is a breaking change without our usual deprecation mechanics.

Why did this got merged then? @import-brain you removed the BREAKING CHANGE label. Why that?

This PR has an incorrect type as well.

I changed the code such that it wasn't a breaking change anymore.

https://github.com/faker-js/faker/pull/1238/files#diff-7024ee9abbac290279ea20612a309bc1fa8ba9d0db8f31f6ba87482e9f930761L196-R222

The function signature used to take just one param, length (a number), and I changed it so that it takes a param called options that could be an options object OR a number and called the deprecation function when options was a number.

[xDivisionByZerox]

Yeah but you changed the default return value to not include the prefix.
Currently, I can do this:

const hex = faker.datatype.hexadecimal(1);
console.log(parseInt(hex)); // 14

This will break now:

const hex = faker.datatype.hexadecimal(1);
console.log(parseInt(hex)); // NaN

[import-brain]

Yeah but you changed the default return value to not include the prefix. Currently, I can do this:

const hex = faker.datatype.hexadecimal(1);
console.log(parseInt(hex)); // 14

This will break now:

const hex = faker.datatype.hexadecimal(1);
console.log(parseInt(hex)); // NaN

Oh crap. Should I manually revert this and reimplement the change before we release v8?

[ST-DDT]

I wouldnt revert it entirely, just restore the old defaults.

@xDivisionByZerox Nicely spotted.