Suggesting an inconsistency inside defaults function #178
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The comment in line 87 is inaccurate
```Replace values with defaults only if undefined (allow empty/zero values)
```
__ Problem:__
We try to pass in 2 objects inside defaults function and we get an unexpected result.
```
defaults({color: null}, {color:'grey', wheels:2})
// returns {color: "grey", wheels: 2}
```
This output shows that the null value is overwritten by the defs value. This is inaccurate and inconsistent with the comment.
__Solution:__
With this fix, the expected output is corrected to return
```
{color: null, wheels: 2},
```
elenaparaschiv
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is an inaccuracy regarding the comment in line 87, regarding allowing for empty/ zero values
Problem:
Calling the defaults function, if object has a value of null, its value will be overwritten by the defs value.
Below is an example:
This is inconsistent with the comment, which should allow for empty/ zero values.
To fix it, null can be swapped for undefined.
Solution:
With this fix, the expected output is returned.
If the authors consider to not replace this code due to reasons such that it might brake the code for existing users of accounting.js, I suggest to at least change the comment to be more accurate, for example:
Thanks to @gordonmzhu for the inspiration behind this pull request.