@cesium/engine 2.0.0 → 2.2.0

package/Source/Core/WallGeometry.js

@@ -29,12 +29,12 @@ const scratchNormal = new Cartesian3();
  * @alias WallGeometry
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall.
- * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
- * @param {Number[]} [options.maximumHeights] An array parallel to <code>positions</code> that give the maximum height of the
+ * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
+ * @param {number[]} [options.maximumHeights] An array parallel to <code>positions</code> that give the maximum height of the
  *        wall at <code>positions</code>. If undefined, the height of each position in used.
- * @param {Number[]} [options.minimumHeights] An array parallel to <code>positions</code> that give the minimum height of the
+ * @param {number[]} [options.minimumHeights] An array parallel to <code>positions</code> that give the minimum height of the
  *        wall at <code>positions</code>. If undefined, the height at each position is 0.0.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation
  * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.
@@ -115,7 +115,7 @@ function WallGeometry(options) {
 
   /**
    * The number of elements used to pack the object into an array.
-   * @type {Number}
+   * @type {number}
    */
   this.packedLength =
     numComponents + Ellipsoid.packedLength + VertexFormat.packedLength + 1;
@@ -125,10 +125,10 @@ function WallGeometry(options) {
  * Stores the provided instance into the provided array.
  *
  * @param {WallGeometry} value The value to pack.
- * @param {Number[]} array The array to pack into.
- * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
+ * @param {number[]} array The array to pack into.
+ * @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
  *
- * @returns {Number[]} The array that was packed into
+ * @returns {number[]} The array that was packed into
  */
 WallGeometry.pack = function (value, array, startingIndex) {
   //>>includeStart('debug', pragmas.debug);
@@ -197,8 +197,8 @@ const scratchOptions = {
 /**
  * Retrieves an instance from a packed array.
  *
- * @param {Number[]} array The packed array.
- * @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
+ * @param {number[]} array The packed array.
+ * @param {number} [startingIndex=0] The starting index of the element to be unpacked.
  * @param {WallGeometry} [result] The object into which to store the result.
  * @returns {WallGeometry} The modified result parameter or a new WallGeometry instance if one was not provided.
  */
@@ -274,11 +274,11 @@ WallGeometry.unpack = function (array, startingIndex, result) {
  * A description of a wall, which is similar to a KML line string. A wall is defined by a series of points,
  * which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall.
- * @param {Number} [options.maximumHeight] A constant that defines the maximum height of the
+ * @param {number} [options.maximumHeight] A constant that defines the maximum height of the
  *        wall at <code>positions</code>. If undefined, the height of each position in used.
- * @param {Number} [options.minimumHeight] A constant that defines the minimum height of the
+ * @param {number} [options.minimumHeight] A constant that defines the minimum height of the
  *        wall at <code>positions</code>. If undefined, the height at each position is 0.0.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation
  * @param {VertexFormat} [options.vertexFormat=VertexFormat.DEFAULT] The vertex attributes to be computed.

package/Source/Core/WallOutlineGeometry.js

@@ -23,12 +23,12 @@ const scratchCartesian3Position2 = new Cartesian3();
  * @alias WallOutlineGeometry
  * @constructor
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall.
- * @param {Number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
- * @param {Number[]} [options.maximumHeights] An array parallel to <code>positions</code> that give the maximum height of the
+ * @param {number} [options.granularity=CesiumMath.RADIANS_PER_DEGREE] The distance, in radians, between each latitude and longitude. Determines the number of positions in the buffer.
+ * @param {number[]} [options.maximumHeights] An array parallel to <code>positions</code> that give the maximum height of the
  *        wall at <code>positions</code>. If undefined, the height of each position in used.
- * @param {Number[]} [options.minimumHeights] An array parallel to <code>positions</code> that give the minimum height of the
+ * @param {number[]} [options.minimumHeights] An array parallel to <code>positions</code> that give the minimum height of the
  *        wall at <code>positions</code>. If undefined, the height at each position is 0.0.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation
  *
@@ -104,7 +104,7 @@ function WallOutlineGeometry(options) {
 
   /**
    * The number of elements used to pack the object into an array.
-   * @type {Number}
+   * @type {number}
    */
   this.packedLength = numComponents + Ellipsoid.packedLength + 1;
 }
@@ -113,10 +113,10 @@ function WallOutlineGeometry(options) {
  * Stores the provided instance into the provided array.
  *
  * @param {WallOutlineGeometry} value The value to pack.
- * @param {Number[]} array The array to pack into.
- * @param {Number} [startingIndex=0] The index into the array at which to start packing the elements.
+ * @param {number[]} array The array to pack into.
+ * @param {number} [startingIndex=0] The index into the array at which to start packing the elements.
  *
- * @returns {Number[]} The array that was packed into
+ * @returns {number[]} The array that was packed into
  */
 WallOutlineGeometry.pack = function (value, array, startingIndex) {
   //>>includeStart('debug', pragmas.debug);
@@ -180,8 +180,8 @@ const scratchOptions = {
 /**
  * Retrieves an instance from a packed array.
  *
- * @param {Number[]} array The packed array.
- * @param {Number} [startingIndex=0] The starting index of the element to be unpacked.
+ * @param {number[]} array The packed array.
+ * @param {number} [startingIndex=0] The starting index of the element to be unpacked.
  * @param {WallOutlineGeometry} [result] The object into which to store the result.
  * @returns {WallOutlineGeometry} The modified result parameter or a new WallOutlineGeometry instance if one was not provided.
  */
@@ -249,11 +249,11 @@ WallOutlineGeometry.unpack = function (array, startingIndex, result) {
  * A description of a walloutline. A wall is defined by a series of points,
  * which extrude down to the ground. Optionally, they can extrude downwards to a specified height.
  *
- * @param {Object} options Object with the following properties:
+ * @param {object} options Object with the following properties:
  * @param {Cartesian3[]} options.positions An array of Cartesian objects, which are the points of the wall.
- * @param {Number} [options.maximumHeight] A constant that defines the maximum height of the
+ * @param {number} [options.maximumHeight] A constant that defines the maximum height of the
  *        wall at <code>positions</code>. If undefined, the height of each position in used.
- * @param {Number} [options.minimumHeight] A constant that defines the minimum height of the
+ * @param {number} [options.minimumHeight] A constant that defines the minimum height of the
  *        wall at <code>positions</code>. If undefined, the height at each position is 0.0.
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid for coordinate manipulation
  * @returns {WallOutlineGeometry}

package/Source/Core/WebGLConstants.js

@@ -7,7 +7,7 @@
  * and [WebGL 2.0]{@link https://www.khronos.org/registry/webgl/specs/latest/2.0/}
  * specifications.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const WebGLConstants = {
   DEPTH_BUFFER_BIT: 0x00000100,

package/Source/Core/WebMercatorProjection.js

@@ -44,8 +44,8 @@ Object.defineProperties(WebMercatorProjection.prototype, {
  * Converts a Mercator angle, in the range -PI to PI, to a geodetic latitude
  * in the range -PI/2 to PI/2.
  *
- * @param {Number} mercatorAngle The angle to convert.
- * @returns {Number} The geodetic latitude in radians.
+ * @param {number} mercatorAngle The angle to convert.
+ * @returns {number} The geodetic latitude in radians.
  */
 WebMercatorProjection.mercatorAngleToGeodeticLatitude = function (
   mercatorAngle
@@ -57,8 +57,8 @@ WebMercatorProjection.mercatorAngleToGeodeticLatitude = function (
  * Converts a geodetic latitude in radians, in the range -PI/2 to PI/2, to a Mercator
  * angle in the range -PI to PI.
  *
- * @param {Number} latitude The geodetic latitude in radians.
- * @returns {Number} The Mercator angle.
+ * @param {number} latitude The geodetic latitude in radians.
+ * @returns {number} The Mercator angle.
  */
 WebMercatorProjection.geodeticLatitudeToMercatorAngle = function (latitude) {
   // Clamp the latitude coordinate to the valid Mercator bounds.
@@ -83,7 +83,7 @@ WebMercatorProjection.geodeticLatitudeToMercatorAngle = function (latitude) {
  * The constant value is computed by calling:
  *    WebMercatorProjection.mercatorAngleToGeodeticLatitude(Math.PI)
  *
- * @type {Number}
+ * @type {number}
  */
 WebMercatorProjection.MaximumLatitude = WebMercatorProjection.mercatorAngleToGeodeticLatitude(
   Math.PI

package/Source/Core/WebMercatorTilingScheme.js

@@ -12,12 +12,12 @@ import WebMercatorProjection from "./WebMercatorProjection.js";
  * @alias WebMercatorTilingScheme
  * @constructor
  *
- * @param {Object} [options] Object with the following properties:
+ * @param {object} [options] Object with the following properties:
  * @param {Ellipsoid} [options.ellipsoid=Ellipsoid.WGS84] The ellipsoid whose surface is being tiled. Defaults to
  * the WGS84 ellipsoid.
- * @param {Number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of
+ * @param {number} [options.numberOfLevelZeroTilesX=1] The number of tiles in the X direction at level zero of
  *        the tile tree.
- * @param {Number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of
+ * @param {number} [options.numberOfLevelZeroTilesY=1] The number of tiles in the Y direction at level zero of
  *        the tile tree.
  * @param {Cartesian2} [options.rectangleSouthwestInMeters] The southwest corner of the rectangle covered by the
  *        tiling scheme, in meters.  If this parameter or rectangleNortheastInMeters is not specified, the entire
@@ -113,8 +113,8 @@ Object.defineProperties(WebMercatorTilingScheme.prototype, {
 /**
  * Gets the total number of tiles in the X direction at a specified level-of-detail.
  *
- * @param {Number} level The level-of-detail.
- * @returns {Number} The number of tiles in the X direction at the given level.
+ * @param {number} level The level-of-detail.
+ * @returns {number} The number of tiles in the X direction at the given level.
  */
 WebMercatorTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) {
   return this._numberOfLevelZeroTilesX << level;
@@ -123,8 +123,8 @@ WebMercatorTilingScheme.prototype.getNumberOfXTilesAtLevel = function (level) {
 /**
  * Gets the total number of tiles in the Y direction at a specified level-of-detail.
  *
- * @param {Number} level The level-of-detail.
- * @returns {Number} The number of tiles in the Y direction at the given level.
+ * @param {number} level The level-of-detail.
+ * @returns {number} The number of tiles in the Y direction at the given level.
  */
 WebMercatorTilingScheme.prototype.getNumberOfYTilesAtLevel = function (level) {
   return this._numberOfLevelZeroTilesY << level;
@@ -163,10 +163,10 @@ WebMercatorTilingScheme.prototype.rectangleToNativeRectangle = function (
  * Converts tile x, y coordinates and level to a rectangle expressed in the native coordinates
  * of the tiling scheme.
  *
- * @param {Number} x The integer x coordinate of the tile.
- * @param {Number} y The integer y coordinate of the tile.
- * @param {Number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance
+ * @param {number} x The integer x coordinate of the tile.
+ * @param {number} y The integer y coordinate of the tile.
+ * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+ * @param {object} [result] The instance to which to copy the result, or undefined if a new instance
  *        should be created.
  * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
  *          if 'result' is undefined.
@@ -206,10 +206,10 @@ WebMercatorTilingScheme.prototype.tileXYToNativeRectangle = function (
 /**
  * Converts tile x, y coordinates and level to a cartographic rectangle in radians.
  *
- * @param {Number} x The integer x coordinate of the tile.
- * @param {Number} y The integer y coordinate of the tile.
- * @param {Number} level The tile level-of-detail.  Zero is the least detailed.
- * @param {Object} [result] The instance to which to copy the result, or undefined if a new instance
+ * @param {number} x The integer x coordinate of the tile.
+ * @param {number} y The integer y coordinate of the tile.
+ * @param {number} level The tile level-of-detail.  Zero is the least detailed.
+ * @param {object} [result] The instance to which to copy the result, or undefined if a new instance
  *        should be created.
  * @returns {Rectangle} The specified 'result', or a new object containing the rectangle
  *          if 'result' is undefined.
@@ -242,7 +242,7 @@ WebMercatorTilingScheme.prototype.tileXYToRectangle = function (
  * a given cartographic position.
  *
  * @param {Cartographic} position The position.
- * @param {Number} level The tile level-of-detail.  Zero is the least detailed.
+ * @param {number} level The tile level-of-detail.  Zero is the least detailed.
  * @param {Cartesian2} [result] The instance to which to copy the result, or undefined if a new instance
  *        should be created.
  * @returns {Cartesian2} The specified 'result', or a new object containing the tile x, y coordinates

package/Source/Core/WindingOrder.js

@@ -3,13 +3,13 @@ import WebGLConstants from "./WebGLConstants.js";
 /**
  * Winding order defines the order of vertices for a triangle to be considered front-facing.
  *
- * @enum {Number}
+ * @enum {number}
  */
 const WindingOrder = {
   /**
    * Vertices are in clockwise order.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   CLOCKWISE: WebGLConstants.CW,
@@ -17,7 +17,7 @@ const WindingOrder = {
   /**
    * Vertices are in counter-clockwise order.
    *
-   * @type {Number}
+   * @type {number}
    * @constant
    */
   COUNTER_CLOCKWISE: WebGLConstants.CCW,

package/Source/Core/WireframeIndexGenerator.js

@@ -164,7 +164,7 @@ function createWireframeFromTriangleFanIndices(vertexCount, originalIndices) {
  * or creating them from scratch if the model had none.
  *
  * @param {PrimitiveType} primitiveType The primitive type.
- * @param {Number} vertexCount The number of vertices in the primitive.
+ * @param {number} vertexCount The number of vertices in the primitive.
  * @param {Uint8Array|Uint16Array|Uint32Array} [originalIndices] A typed array containing the original indices of the primitive.
  *
  * @return {Uint16Array|Uint32Array} A typed array with the wireframe indices, or undefined if the primitive type does not use triangles.
@@ -202,8 +202,8 @@ WireframeIndexGenerator.createWireframeIndices = function (
  * Gets the number of indices in the wireframe index buffer of a primitive type.
  *
  * @param {PrimitiveType} primitiveType The primitive type.
- * @param {Number} originalCount The original number of vertices or indices in the primitive.
- * @return {Number} The number of indices in the primitive's wireframe.
+ * @param {number} originalCount The original number of vertices or indices in the primitive.
+ * @return {number} The number of indices in the primitive's wireframe.
  *
  * @private
  */

package/Source/Core/arrayRemoveDuplicates.js

@@ -8,11 +8,11 @@ const removeDuplicatesEpsilon = CesiumMath.EPSILON10;
 /**
  * Removes adjacent duplicate values in an array of values.
  *
- * @param {Array.<*>} [values] The array of values.
+ * @param {any[]} [values] The array of values.
  * @param {Function} equalsEpsilon Function to compare values with an epsilon. Boolean equalsEpsilon(left, right, epsilon).
- * @param {Boolean} [wrapAround=false] Compare the last value in the array against the first value. If they are equal, the last value is removed.
- * @param {Array.<Number>} [removedIndices=undefined] Store the indices that correspond to the duplicate items removed from the array, if there were any.
- * @returns {Array.<*>|undefined} A new array of values with no adjacent duplicate values or the input array if no duplicates were found.
+ * @param {boolean} [wrapAround=false] Compare the last value in the array against the first value. If they are equal, the last value is removed.
+ * @param {number[]} [removedIndices=undefined] Store the indices that correspond to the duplicate items removed from the array, if there were any.
+ * @returns {any[]|undefined} A new array of values with no adjacent duplicate values or the input array if no duplicates were found.
  *
  * @example
  * // Returns [(1.0, 1.0, 1.0), (2.0, 2.0, 2.0), (3.0, 3.0, 3.0), (1.0, 1.0, 1.0)]

package/Source/Core/binarySearch.js

@@ -8,7 +8,7 @@ import Check from "./Check.js";
  * @param {*} itemToFind The item to find in the array.
  * @param {binarySearchComparator} comparator The function to use to compare the item to
  *        elements in the array.
- * @returns {Number} The index of <code>itemToFind</code> in the array, if it exists.  If <code>itemToFind</code>
+ * @returns {number} The index of <code>itemToFind</code> in the array, if it exists.  If <code>itemToFind</code>
  *        does not exist, the return value is a negative number which is the bitwise complement (~)
  *        of the index before which the itemToFind should be inserted in order to maintain the
  *        sorted order of the array.
@@ -55,7 +55,7 @@ function binarySearch(array, itemToFind, comparator) {
  *
  * @param {*} a An item in the array.
  * @param {*} b The item being searched for.
- * @returns {Number} Returns a negative value if <code>a</code> is less than <code>b</code>,
+ * @returns {number} Returns a negative value if <code>a</code> is less than <code>b</code>,
  *          a positive value if <code>a</code> is greater than <code>b</code>, or
  *          0 if <code>a</code> is equal to <code>b</code>.
  *

package/Source/Core/buildModuleUrl.js

@@ -93,14 +93,15 @@ let implementation;
  * Given a relative URL under the Cesium base URL, returns an absolute URL.
  * @function
  *
- * @param {String} relativeUrl The relative path.
- * @returns {String} The absolutely URL representation of the provided path.
+ * @param {string} relativeUrl The relative path.
+ * @returns {string} The absolutely URL representation of the provided path.
  *
  * @example
  * const viewer = new Cesium.Viewer("cesiumContainer", {
- *   imageryProvider: new Cesium.TileMapServiceImageryProvider({
- *   url: Cesium.buildModuleUrl("Assets/Textures/NaturalEarthII"),
- *   }),
+ *   baseLayer: Cesium.ImageryLayer.fromProviderAsync(
+ *     Cesium.TileMapServiceImageryProvider.fromUrl(
+ *       Cesium.buildModuleUrl("Assets/Textures/NaturalEarthII"),
+ *     )),
  *   baseLayerPicker: false,
  * });
  */
@@ -132,7 +133,7 @@ buildModuleUrl._clearBaseResource = function () {
 
 /**
  * Sets the base URL for resolving modules.
- * @param {String} value The new base URL.
+ * @param {string} value The new base URL.
  */
 buildModuleUrl.setBaseUrl = function (value) {
   baseResource = Resource.DEFAULT.getDerivedResource({
@@ -144,7 +145,7 @@ buildModuleUrl.setBaseUrl = function (value) {
  * Gets the base URL for resolving modules.
  *
  * @function
- * @returns {String} The configured base URL
+ * @returns {string} The configured base URL
  */
 buildModuleUrl.getCesiumBaseUrl = getCesiumBaseUrl;
 

package/Source/Core/clone.js

@@ -5,9 +5,9 @@ import defaultValue from "./defaultValue.js";
  *
  * @function
  *
- * @param {Object} object The object to clone.
- * @param {Boolean} [deep=false] If true, all properties will be deep cloned recursively.
- * @returns {Object} The cloned object.
+ * @param {object} object The object to clone.
+ * @param {boolean} [deep=false] If true, all properties will be deep cloned recursively.
+ * @returns {object} The cloned object.
  */
 function clone(object, deep) {
   if (object === null || typeof object !== "object") {

package/Source/Core/combine.js

@@ -25,10 +25,10 @@ import defined from "./defined.js";
  * //     }
  * // }
  *
- * @param {Object} [object1] The first object to merge.
- * @param {Object} [object2] The second object to merge.
- * @param {Boolean} [deep=false] Perform a recursive merge.
- * @returns {Object} The combined object containing all properties from both objects.
+ * @param {object} [object1] The first object to merge.
+ * @param {object} [object2] The second object to merge.
+ * @param {boolean} [deep=false] Perform a recursive merge.
+ * @returns {object} The combined object containing all properties from both objects.
  *
  * @function
  */

package/Source/Core/createGuid.js

@@ -3,7 +3,7 @@
  *
  * @function
  *
- * @returns {String}
+ * @returns {string}
  *
  *
  * @example

package/Source/Core/createWorldTerrain.js

@@ -1,5 +1,6 @@
 import CesiumTerrainProvider from "./CesiumTerrainProvider.js";
 import defaultValue from "./defaultValue.js";
+import deprecationWarning from "./deprecationWarning.js";
 import IonResource from "./IonResource.js";
 
 /**
@@ -7,9 +8,9 @@ import IonResource from "./IonResource.js";
  *
  * @function
  *
- * @param {Object} [options] Object with the following properties:
- * @param {Boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
- * @param {Boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available.
+ * @param {object} [options] Object with the following properties:
+ * @param {boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
+ * @param {boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available.
  * @returns {CesiumTerrainProvider}
  *
  * @see Ion
@@ -31,12 +32,29 @@ import IonResource from "./IonResource.js";
  *
  */
 function createWorldTerrain(options) {
+  deprecationWarning(
+    "createWorldTerrain",
+    "createWorldTerrain was deprecated in CesiumJS 1.104.  It will be in CesiumJS 1.107.  Use createWorldTerrainAsync instead."
+  );
+
   options = defaultValue(options, defaultValue.EMPTY_OBJECT);
 
-  return new CesiumTerrainProvider({
-    url: IonResource.fromAssetId(1),
+  const provider = new CesiumTerrainProvider({
     requestVertexNormals: defaultValue(options.requestVertexNormals, false),
     requestWaterMask: defaultValue(options.requestWaterMask, false),
   });
+
+  // This is here in order to avoid throwing a second deprecation error
+  // by using the deprecated url parameter in the constructor above
+  provider._readyPromise = CesiumTerrainProvider._initializeReadyPromise(
+    {
+      url: IonResource.fromAssetId(1),
+      requestVertexNormals: defaultValue(options.requestVertexNormals, false),
+      requestWaterMask: defaultValue(options.requestWaterMask, false),
+    },
+    provider
+  );
+
+  return provider;
 }
 export default createWorldTerrain;

package/Source/Core/createWorldTerrainAsync.js

@@ -0,0 +1,48 @@
+import CesiumTerrainProvider from "./CesiumTerrainProvider.js";
+import defaultValue from "./defaultValue.js";
+
+/**
+ * Creates a {@link CesiumTerrainProvider} instance for the {@link https://cesium.com/content/#cesium-world-terrain|Cesium World Terrain}.
+ *
+ * @function
+ *
+ * @param {Object} [options] Object with the following properties:
+ * @param {Boolean} [options.requestVertexNormals=false] Flag that indicates if the client should request additional lighting information from the server if available.
+ * @param {Boolean} [options.requestWaterMask=false] Flag that indicates if the client should request per tile water masks from the server if available.
+ * @returns {Promise<CesiumTerrainProvider>} A promise that resolves to the created CesiumTerrainProvider
+ *
+ * @see Ion
+ *
+ * @example
+ * // Create Cesium World Terrain with default settings
+ * try {
+ *   const viewer = new Cesium.Viewer("cesiumContainer", {
+ *     terrainProvider: await Cesium.createWorldTerrainAsync();
+ *   });
+ * } catch (error) {
+ *   console.log(error);
+ * }
+ *
+ * @example
+ * // Create Cesium World Terrain with water and normals.
+ * try {
+ *   const viewer1 = new Cesium.Viewer("cesiumContainer", {
+ *     terrainProvider: await Cesium.createWorldTerrainAsync({
+ *       requestWaterMask: true,
+ *       requestVertexNormals: true
+ *     });
+ *   });
+ * } catch (error) {
+ *   console.log(error);
+ * }
+ *
+ */
+function createWorldTerrainAsync(options) {
+  options = defaultValue(options, defaultValue.EMPTY_OBJECT);
+
+  return CesiumTerrainProvider.fromIonAssetId(1, {
+    requestVertexNormals: defaultValue(options.requestVertexNormals, false),
+    requestWaterMask: defaultValue(options.requestWaterMask, false),
+  });
+}
+export default createWorldTerrainAsync;

package/Source/Core/defaultValue.js

@@ -21,7 +21,7 @@ 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}
+ * @type {object}
  * @memberof defaultValue
  */
 defaultValue.EMPTY_OBJECT = Object.freeze({});

package/Source/Core/defer.js

@@ -15,7 +15,7 @@
 /**
  * An object which contains a promise object, and functions to resolve or reject the promise.
  *
- * @typedef {Object} defer.deferred
+ * @typedef {object} defer.deferred
  * @property {defer.resolve} resolve Resolves the promise when called.
  * @property {defer.reject} reject Rejects the promise when called.
  * @property {Promise} promise Promise object.

package/Source/Core/defined.js

@@ -2,7 +2,7 @@
  * @function
  *
  * @param {*} value The object.
- * @returns {Boolean} Returns true if the object is defined, returns false otherwise.
+ * @returns {boolean} Returns true if the object is defined, returns false otherwise.
  *
  * @example
  * if (Cesium.defined(positions)) {

package/Source/Core/deprecationWarning.js

@@ -9,8 +9,8 @@ import oneTimeWarning from "./oneTimeWarning.js";
  *
  * @function deprecationWarning
  *
- * @param {String} identifier The unique identifier for this deprecated API.
- * @param {String} message The message to log to the console.
+ * @param {string} identifier The unique identifier for this deprecated API.
+ * @param {string} message The message to log to the console.
  *
  * @example
  * // Deprecated function or class

package/Source/Core/destroyObject.js

@@ -18,8 +18,8 @@ function returnTrue() {
  *
  * @function
  *
- * @param {Object} object The object to destroy.
- * @param {String} [message] The message to include in the exception that is thrown if
+ * @param {object} object The object to destroy.
+ * @param {string} [message] The message to include in the exception that is thrown if
  *                           a destroyed object's function is called.
  *
  *

package/Source/Core/formatError.js

@@ -7,7 +7,7 @@ import defined from "./defined.js";
  * @function
  *
  * @param {*} object The item to find in the array.
- * @returns {String} A string containing the formatted error.
+ * @returns {string} A string containing the formatted error.
  */
 function formatError(object) {
   let result;

package/Source/Core/getAbsoluteUri.js

@@ -7,9 +7,9 @@ import DeveloperError from "./DeveloperError.js";
  * Given a relative Uri and a base Uri, returns the absolute Uri of the relative Uri.
  * @function
  *
- * @param {String} relative The relative Uri.
- * @param {String} [base] The base Uri.
- * @returns {String} The absolute Uri of the given relative Uri.
+ * @param {string} relative The relative Uri.
+ * @param {string} [base] The base Uri.
+ * @returns {string} The absolute Uri of the given relative Uri.
  *
  * @example
  * //absolute Uri will be "https://test.com/awesome.png";

package/Source/Core/getBaseUri.js

@@ -6,9 +6,9 @@ import DeveloperError from "./DeveloperError.js";
  * Given a URI, returns the base path of the URI.
  * @function
  *
- * @param {String} uri The Uri.
- * @param {Boolean} [includeQuery = false] Whether or not to include the query string and fragment form the uri
- * @returns {String} The base path of the Uri.
+ * @param {string} uri The Uri.
+ * @param {boolean} [includeQuery = false] Whether or not to include the query string and fragment form the uri
+ * @returns {string} The base path of the Uri.
  *
  * @example
  * // basePath will be "/Gallery/";

package/Source/Core/getExtensionFromUri.js

@@ -6,8 +6,8 @@ import DeveloperError from "./DeveloperError.js";
  * Given a URI, returns the extension of the URI.
  * @function getExtensionFromUri
  *
- * @param {String} uri The Uri.
- * @returns {String} The extension of the Uri.
+ * @param {string} uri The Uri.
+ * @returns {string} The extension of the Uri.
  *
  * @example
  * //extension will be "czml";

package/Source/Core/getFilenameFromUri.js

@@ -6,8 +6,8 @@ import DeveloperError from "./DeveloperError.js";
  * Given a URI, returns the last segment of the URI, removing any path or query information.
  * @function getFilenameFromUri
  *
- * @param {String} uri The Uri.
- * @returns {String} The last segment of the Uri.
+ * @param {string} uri The Uri.
+ * @returns {string} The last segment of the Uri.
  *
  * @example
  * //fileName will be"simple.czml";

package/Source/Core/getImageFromTypedArray.js

@@ -2,8 +2,8 @@
  * Constructs an image from a TypedArray of pixel values
  *
  * @param {Uint8Array} typedArray The array of pixel values
- * @param {Number} width The width of the image to create
- * @param {Number} height The height of the image to create
+ * @param {number} width The width of the image to create
+ * @param {number} height The height of the image to create
  * @returns {HTMLCanvasElement} A new canvas containing the constructed image
  *
  * @private