-
-
Notifications
You must be signed in to change notification settings - Fork 96
Typescript definitions #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
coveralls
commented
Jul 12, 2019
pzi
commented
Oct 24, 2019
Awesome @nikolayg, thanks for this :)
@mattphillips would be awesome to get this merged, please :)
jtabone16
commented
Jan 8, 2020
+1
diyorbek
commented
Aug 3, 2020
@nikolayg thanks for it).
It would be great to see the changes in the next release.
It is interesting why PR is still not merged.🤔
Bessonov
commented
Sep 25, 2020
I'm not sure that it works this way. The originalObj and updatedObj could be fully unrelated and therefore typing both to T
doesn't work. At least it's one possible scenario for diffing. I think a proper typings are possible, but 1. very hard to achieve 2. brings not much typesafety to the table.
naseemkullah
commented
Apr 12, 2021
friendly ping @mattphillips
I'm not sure that it works this way. The originalObj and updatedObj could be fully unrelated
@Bessonov I agree with you. This looks safe enough to me though, since each property of T
gets exposed as optional, meaning that consumers will have to check that those values exist before using them. I'm not sure how this works in the case of adding properties though.
I've not searched the space much, but I imagine it's fairly uncommon to compare objects of two different types. In my own code at least, if I'm expecting a field to have been added to an object, that field would at least be defined on the type of the original as optional (potentially undefined
). If the field exists on the new object, then great! I still need to check that it's undefined
though since the original object is of the same type, and defines that field as optional.
I don't think these type defs are actually accurate, they don't recurse on Arrays and they error on the example usage in the project readme as shown in screenshot.
Screenshot 2022年11月12日 at 12 47 45
I've taken a quick stab at writing some more advanced type definitions here: #88. If anyone wants to test drive them on a project and provide any issues/feedback on that PR that would be greatly appreciated.
Hey guys,
I've created some more accurate Typescript definitions for
deep-object-diff
. I would be happy if you merge them, so I can use them directly from the npm module :)