benjamine / jsondiffpatch

Diff & patch JavaScript objects
MIT License
4.86k stars 473 forks source link

Add typings for Pipe API #240

Closed ian-craig closed 4 years ago

ian-craig commented 6 years ago

Fixes #239

I've also included some minor bug fixes to other parts of the typings such as objectHash and the constructor options.

I'm not including all functions/props on the classes in your JS files, because I'm not sure which should be exposed publicly and which are intended to be internal helpers. So, I've included everything which I can find referenced in docs, and tried to pull the doc strings from those same docs.

ian-craig commented 5 years ago

@benjamine is there a version bump planned soon which you might be able to include this fix in? It would be great to remove some hacky workarounds for this and #236.

Thanks!

benjamine commented 4 years ago

@ian-craig thanks, sorry for the delays, I'm catching up with open issues (new year resolution? :) ), these look good, the only comment maybe is that these seem to change indentation from 2 to 4 spaces? but ack we have no eslint on .ts so, my bad. other than that, will merge.