Rename property

Author: dmichon-msft

common/changes/@rushstack/node-core-library/json-file-undefined_2021-05-13-21-25.json

@@ -2,7 +2,7 @@
   "changes": [
     {
       "packageName": "@rushstack/node-core-library",
-      "comment": "Add `dropUndefinedValues` option to JSONFile to discard keys with undefined values during serialization, i.e. the standard behavior of JSON.stringify() and other JSON serializers.",
+      "comment": "Add `ignoreUndefinedValues` option to JSONFile to discard keys with undefined values during serialization, i.e. the standard behavior of JSON.stringify() and other JSON serializers.",
       "type": "minor"
     }
   ],

libraries/node-core-library/src/JsonFile.ts

@@ -53,7 +53,7 @@ export interface IJsonFileStringifyOptions {
    * If true, conforms to the standard behavior of JSON.stringify() when a property has the value `undefined`.
    * Specifically, the key will be dropped from the emitted object.
    */
-  dropUndefinedValues?: boolean;
+  ignoreUndefinedValues?: boolean;
 
   /**
    * If true, then the "jju" library will be used to improve the text formatting.
@@ -236,7 +236,7 @@ export class JsonFile {
       options = {};
     }
 
-    if (!options.dropUndefinedValues) {
+    if (!options.ignoreUndefinedValues) {
       // Standard handling of `undefined` in JSON stringification is to discard the key.
       JsonFile.validateNoUndefinedMembers(newJsonObject);
     }

libraries/node-core-library/src/test/JsonFile.test.ts

@@ -32,7 +32,7 @@ describe('JsonFile tests', () => {
       JsonFile.stringify(
         { abc: undefined },
         {
-          dropUndefinedValues: true
+          ignoreUndefinedValues: true
         }
       )
     ).toMatchSnapshot();
@@ -41,7 +41,7 @@ describe('JsonFile tests', () => {
       JsonFile.stringify(
         { abc: undefined },
         {
-          dropUndefinedValues: true,
+          ignoreUndefinedValues: true,
           prettyFormatting: true
         }
       )