[node-core-library] Add ignoreUndefinedValues option to JsonFile serialization APIs
#2696
Conversation
This file contains hidden or 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
dmichon-msft
requested review from
apostolisms,
D4N14L,
halfnibble,
iclanton,
octogonz and
sachinjoseph
as code owners
D4N14L
approved these changes
May 13, 2021
iclanton
changed the title
dropUndefinedValues option to JsonFile serialization APIsdropUndefinedValues option to JsonFile serialization APIs
iclanton
reviewed
May 17, 2021
common/changes/@rushstack/node-core-library/json-file-undefined_2021-05-13-21-25.json
Outdated
Show resolved
Hide resolved
|
This looks good to me, but I like @D4N14L's suggested property name better. |
dmichon-msft
changed the title
dropUndefinedValues option to JsonFile serialization APIsignoreUndefinedValues option to JsonFile serialization APIs
iclanton
approved these changes
May 18, 2021
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.
Summary
Adds a configuration option
ignoreUndefinedValuesto the JsonFile serialization APIs to make their behavior consistent withJSON.stringify()for the common case of setting values to be discarded asundefined. This is generally preferred because thedeleteoperator is notoriously bad for performance.Details
The underlying APIs already drop keys with
undefinedvalues, the JsonFile class added an extra validation layer in front of serialization that turned this standard behavior into an error. PassingignoreUndefinedValues: truein the options simply turns off this extra validation and defers toJSON.stringify()orjju.stringify().How it was tested
Added unit test cases for keys with
undefinedas their value and theignoreUndefinedValues: trueoption.Edited:
dropUndefinedValues->ignoreUndefinedValues