search

chbrown / rfc6902

Complete implementation of RFC6902 in TypeScript
https://chbrown.github.io/rfc6902/
322 stars 39 forks source link

Breaking changes in v3 #43

Closed diachedelic closed 5 years ago

diachedelic commented 5 years ago

I'm trying to figure out if it's safe for me to upgrade to v3 - were there any breaking changes other than dropping support for node v4?

chbrown commented 5 years ago

Mostly v2 -> v3 consists of several improvements to correctness; the bump in major version is because it's conceivable that a downstream user might be relying on improper behavior. I also moved around a couple interfaces/types which are intended to be used internally, but because they are exported, might conceivably be imported directly by a downstream user.

If you are not importing anything from rfc6902/* (i.e., anything other than the primary API of applyPatch, createPatch, & createTests from rfc6902), or you are but everything still typechecks, I'm highly confident that upgrading to v3 won't break anything.

If you do decide to upgrade, please report back here (especially if you have any issues). Thanks!

diachedelic commented 5 years ago

Seems to work fine, I'm only using applyPatch and createPatch with a diff argument.