MikeMcl / bignumber.js

A JavaScript library for arbitrary-precision decimal and non-decimal arithmetic
http://mikemcl.github.io/bignumber.js
MIT License
6.69k stars 742 forks source link

v9 published but only v8.1 docs? #237

Closed bradennapier closed 5 years ago

bradennapier commented 5 years ago

just noticed that v9 is the latest npm but only the docs for v8.1 are published. is there no difference? what is in the major release that is considered breaking? is there migration steps?


edit - i see that it just seems to remove symbol for compatibility reasons?

MikeMcl commented 5 years ago

Yes, I received reports by email that the Symbol code was breaking the library in IE8, so I removed it. There is no difference in the docs. There are no migration steps. If you have a suggestion or criticism in that regard, please elaborate.

Github seems to be struggling to produce the diff, but basically I just took out the following:

  P[Symbol.toStringTag] = 'BigNumber';
  P[Symbol.for('nodejs.util.inspect.custom')] = P.valueOf;

Strictly-speaking this was a breaking change so annoyingly I had to increment the major version number.

bradennapier commented 5 years ago

Thanks, appreciate it!

mqklin commented 5 years ago

@MikeMcl it would be good if you put some info in the release notes: https://github.com/MikeMcl/bignumber.js/releases/tag/v9.0.0 I've just wanted to create the same issue to understand what are the changes in 9.0.0. Thanks!

MikeMcl commented 5 years ago

@mqklin

I have added a brief note.

Thanks for your input.

mqklin commented 5 years ago

Cool, thanks a lot!