Deprecated defaultValue.EMPTY_OBJECT and created EmptyObject standalone constant

CHANGES.md

@@ -1,5 +1,9 @@
 # Change Log
 
+##### Deprecated :hourglass_flowing_sand:
+
+- `defaultValue.EMPTY_OBJECT` has been deprecated and will be removed in 1.125. Use `EmptyObject` instead.
+
 ### 1.122 - 2024-10-01
 
 #### @cesium/engine

CONTRIBUTORS.md

@@ -207,6 +207,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
 
 ## [Individual CLA](Documentation/Contributors/CLAs/individual-contributor-license-agreement-v1.0.pdf)
 
+- [Paul An](https://github.com/anpaulan)
 - [Brandon Landry](https://github.com/hotpocket)
 - [Victor Berchet](https://github.com/vicb)
 - [Caleb Morse](https://github.com/cmorse)

packages/engine/Source/Core/EmptyObject.js

@@ -0,0 +1,8 @@
+/**
+ * A global immutable empty object for performance reasons
+ *
+ * @type {object}
+ */
+const EmptyObject = {};
+
+export default Object.freeze(EmptyObject);

packages/engine/Source/Core/defaultValue.js

@@ -1,7 +1,9 @@
+import EmptyObject from "./EmptyObject.js";
+import deprecationWarning from "./deprecationWarning.js";
+
 /**
  * Returns the first parameter if not undefined, otherwise the second parameter.
  * Useful for setting a default value for a parameter.
- *
  * @function
  *
  * @param {*} a
@@ -10,6 +12,9 @@
  *
  * @example
  * param = Cesium.defaultValue(param, 'default');
+ *
+ * @property {object} EMPTY_OBJECT - DEPRECATED (use EmptyObject). <br>
+ * A frozen empty object that can be used as the default value for options passed as an object literal.
  */
 function defaultValue(a, b) {
   if (a !== undefined && a !== null) {
@@ -19,11 +24,19 @@ function defaultValue(a, b) {
 }
 
 /**
- * A frozen empty object that can be used as the default value for options passed as
- * an object literal.
  * @type {object}
- * @memberof defaultValue
+ * @constant
+ * @deprecated This property is deprecated and will be removed in Cesium 1.125. See <a href="https://github.com/CesiumGS/cesium/issues/11326">Issue 113216</a>
  */
-defaultValue.EMPTY_OBJECT = Object.freeze({});
+Object.defineProperty(defaultValue, "EMPTY_OBJECT", {
+  get: function () {
+    deprecationWarning(
+      "defaultValue.EMPTY_OBJECT",
+      "defaultValue.EMPTY_OBJECT is deprecated and will be removed in Cesium 1.125. See https://github.com/CesiumGS/cesium/issues/11326",
+    );
+    return EmptyObject;
+  },
+  configurable: false,
+});
 
 export default defaultValue;