Merge pull request #11626 from CesiumGS/optional-options

Update JSDoc for optional options
CesiumGS · Nov 13, 2023 · 2db7028 · 2db7028
2 parents 003922b + 69c68c2
commit 2db7028
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,13 @@
 # Change Log
 
+### 1.112 - 2023-12-01
+
+#### @cesium/engine
+
+##### Fixes :wrench:
+
+- Corrected JSDoc and Typescript definitions that marked optional arguments as required in `Cesium3dTileset.fromIonAssetId` [#11623](https://github.com/CesiumGS/cesium/issues/11623), and `IonImageryProvider.fromAssetId` [#11624](https://github.com/CesiumGS/cesium/issues/11624)
+
 ### 1.111 - 2023-11-01
 
 #### @cesium/engine

diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -160,6 +160,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to Cesiu
   - [Daniel Krupka](https://github.com/krupkad)
   - [Jeshurun Hembd](https://github.com/jjhembd)
   - [Mia Tang](https://github.com/miatang13)
+  - [Mark Dane](https://github.com/angrycat9000)
 - [Northrop Grumman](http://www.northropgrumman.com)
   - [Joseph Stein](https://github.com/nahgrin)
 - [EOX IT Services GmbH](https://eox.at)

diff --git a/packages/engine/Source/Scene/Cesium3DTileset.js b/packages/engine/Source/Scene/Cesium3DTileset.js
@@ -1902,7 +1902,7 @@ Object.defineProperties(Cesium3DTileset.prototype, {
  * used for streaming massive heterogeneous 3D geospatial datasets, from a Cesium ion asset ID.
  *
  * @param {number} assetId The Cesium ion asset id.
- * @param {Cesium3DTileset.ConstructorOptions} options An object describing initialization options
+ * @param {Cesium3DTileset.ConstructorOptions} [options] An object describing initialization options
  * @returns {Promise<Cesium3DTileset>}
  *
  * @exception {DeveloperError} The tileset must be 3D Tiles version 0.0 or 1.0.

diff --git a/packages/engine/Source/Scene/IonImageryProvider.js b/packages/engine/Source/Scene/IonImageryProvider.js
@@ -251,7 +251,7 @@ Object.defineProperties(IonImageryProvider.prototype, {
  * Creates a provider for tiled imagery using the Cesium ion REST API.
  *
  * @param {Number} assetId  An ion imagery asset ID.
- * @param {IonImageryProvider.ConstructorOptions} options Object describing initialization options.
+ * @param {IonImageryProvider.ConstructorOptions} [options] Object describing initialization options.
  * @returns {Promise<IonImageryProvider>} A promise which resolves to the created IonImageryProvider.
  *
  * @example