search

flitbit / diff

Javascript utility for calculating deep difference, capturing changes, and applying changes across objects; for nodejs and the browser.
MIT License
2.99k stars 213 forks source link

Adding Typings for deep-diff to this project #86

Open jesperronn opened 7 years ago

jesperronn commented 7 years ago

Thanks for creating deep-diff, which I am currently working with for Typescript.

I found out some inconsistencies between the code and the typings in the project.

I would like to include typings reference directly into this project, so that code and type definitions are in sync.

Also this can open up for faster and more precise fixing of inconsistencies.

I am writing this because it took me a while to figure out why the library and the type definitions did not match.

Look at this: The typings (used with npm install @types/deep-diff --save-dev) https://github.com/DefinitelyTyped/DefinitelyTyped/blob/49b1ac6/deep-diff/index.d.ts

Turns out that @ZauberNerd committed typings over there in September 2014. This roughly matches commit 239fbbbe from August 2014, which is not included in v0.2.0 but is included in the v0.3.0 released a month later.

Current @maintainers, do you have an opinion about adding typings to this directory

flitbit commented 6 years ago

Can you provide a PR, for the interface exported by v1.0.0-pre.x? Some recent PRs modified the interface with some new methods. I don't have time to absorb ts right now... I followed the link - it seems pretty simple, which has me concerned; I don't know enough about it. I'd rather just sanity check a PR from a trusted participant and go with it until the community blows up. Thanks you!