@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

package/renderers/support/raster/types.d.ts

@@ -9,47 +9,67 @@ import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRam
 import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";
 import type { ClassificationMethod } from "../../types.js";
 
+/** @since 5.0 */
 export type HillshadeType = "traditional" | "multi-directional";
 
+/** @since 5.0 */
 export type RasterStretchType = "none" | "standard-deviation" | "histogram-equalization" | "min-max" | "percent-clip" | "sigmoid";
 
+/** @since 5.0 */
 export type RasterColormapName = "random" | "ndvi" | "ndvi2" | "ndvi3" | "elevation" | "gray" | "hillshade";
 
+/** @since 5.0 */
 export type RasterColorRampName = "aspect" | "black-to-white" | "blue-bright" | "blue-light-to-dark" | "blue-green-bright" | "blue-green-light-to-dark" | "brown-light-to-dark" | "brown-to-blue-green-diverging-right" | "brown-to-blue-green-diverging-dark" | "coefficient-bias" | "cold-to-hot-diverging" | "condition-number" | "cyan-to-purple" | "cyan-light-to-blue-dark" | "distance" | "elevation1" | "elevation2" | "errors" | "gray-light-to-dark" | "green-bright" | "green-light-to-dark" | "green-to-blue" | "orange-bright" | "orange-light-to-dark" | "partial-spectrum" | "partial-spectrum-1-diverging" | "partial-spectrum-2-diverging" | "pink-to-yellow-green-diverging-bright" | "pink-to-yellow-green-diverging-dark" | "precipitation" | "prediction" | "purple-bright" | "purple-to-green-diverging-bright" | "purple-to-green-diverging-dark" | "purple-blue-bright" | "purple-blue-light-to-dark" | "purple-red-bright" | "purple-red-light-to-dark" | "red-bright" | "red-light-to-dark" | "red-to-blue-diverging-bright" | "red-to-blue-diverging-dark" | "red-to-green" | "red-to-green-diverging-bright" | "red-to-green-diverging-dark" | "slope" | "spectrum-full-bright" | "spectrum-full-dark" | "spectrum-full-light" | "surface" | "temperature" | "white-to-black" | "yellow-to-dark-red" | "yellow-to-green-to-dark-blue" | "yellow-to-red" | "yellow-green-bright" | "yellow-green-light-to-dark";
 
+/** @since 5.0 */
 export interface ClassBreaksParameters {
   /**
    * The classification method used for generating breaks.
    *
    * @default natural-breaks
+   * @since 5.0
    */
   classificationMethod?: ClassificationMethod;
-  /** The color ramp to apply to the renderer. */
+  /**
+   * The color ramp to apply to the renderer.
+   *
+   * @since 5.0
+   */
   colorRamp?: AlgorithmicColorRamp | MultipartColorRamp;
   /**
    * The colors to apply to each class break. This must be a
    *   two-dimensional array where each item of the first dimension is an array of 3-4 numbers representing
    *   the RGB or RGBA values of each class break.  This overrides `colorRamp`.
+   *
+   * @since 5.0
    */
   colors?: number[][];
   /**
    * Only applicable when `classificationMethod` is `defined-interval`. Specifies the interval of each break.
    *   Note this may cause the last break to extend beyond the actual data max.
+   *
+   * @since 5.0
    */
   definedInterval?: number;
   /**
    * The field whose data will be used in the classification.
    *
    * @default value
+   * @since 5.0
    */
   field?: string;
   /**
    * The number of class breaks to generate for the classification. This is ignored if a `standard-deviation` classification method is specified.
    *
    * @default 5
+   * @since 5.0
    */
   numClasses?: number;
 }
 
-/** Union of all raster renderers. */
+/**
+ * Union of all raster renderers.
+ *
+ * @since 5.0
+ */
 export type RasterRendererUnion = ClassBreaksRenderer | FlowRenderer | RasterColormapRenderer | RasterShadedReliefRenderer | RasterStretchRenderer | UniqueValueRenderer | VectorFieldRenderer;

package/renderers/support/types.d.ts

@@ -1,44 +1,71 @@
 import type { LengthUnit } from "../../core/units.js";
 
+/** @since 5.0 */
 export interface AuthoringInfoStatistics {
-  /** The maximum data value of the attribute represented by the renderer. Legends displaying `above-and-below` themed data will not display values greater than this number. */
+  /**
+   * The maximum data value of the attribute represented by the renderer. Legends displaying `above-and-below` themed data will not display values greater than this number.
+   *
+   * @since 5.0
+   */
   max: number;
-  /** The minimum data value of the attribute represented by the renderer. Legends displaying `above-and-below` themed data will not display values smaller than this number. */
+  /**
+   * The minimum data value of the attribute represented by the renderer. Legends displaying `above-and-below` themed data will not display values smaller than this number.
+   *
+   * @since 5.0
+   */
   min: number;
 }
 
+/** @since 5.0 */
 export type AuthoringInfoTypes = "relationship" | "classed-size" | "classed-color" | "class-breaks-size" | "class-breaks-color" | "dot-density" | "predominance" | "univariate-color-size" | "flow";
 
+/** @since 5.0 */
 export type AuthoringInfoClassificationMethods = "equal-interval" | "defined-interval" | "manual" | "natural-breaks" | "quantile" | "standard-deviation";
 
+/** @since 5.0 */
 export type AuthoringInfoLengthUnits = Exclude<LengthUnit, "us-feet">;
 
+/** @since 5.0 */
 export type StandardDeviationInterval = 1 | 0.5 | 0.33 | 0.25;
 
+/** @since 5.0 */
 export type RelationshipFocus = "HH" | "LL" | "HL" | "LH";
 
+/** @since 5.0 */
 export type UnivariateTheme = "high-to-low" | "above-and-below" | "above" | "below";
 
+/** @since 5.0 */
 export type FlowTheme = "flow-line" | "wave-front";
 
+/** @since 5.0 */
 export type UnivariateSymbolStyle = "caret" | "circle-caret" | "arrow" | "circle-arrow" | "plus-minus" | "circle-plus-minus" | "square" | "circle" | "triangle" | "happy-sad" | "thumb" | "custom";
 
+/** @since 5.0 */
 export type AuthoringInfoVisualVariableTypes = "size" | "color" | "opacity";
 
+/** @since 5.0 */
 export type AuthoringInfoVisualVariableStyles = "percent" | "ratio" | "percent-of-total";
 
+/** @since 5.0 */
 export type AuthoringInfoColorVariableThemes = "high-to-low" | "above-and-below" | "centered-on" | "extremes" | "above" | "below";
 
+/** @since 5.0 */
 export type AuthoringInfoSizeVariableThemes = "high-to-low" | "above-and-below" | "above" | "below" | "reference-size" | "spike";
 
+/** @since 5.0 */
 export type AuthoringInfoVisualVariableThemes = AuthoringInfoColorVariableThemes | AuthoringInfoSizeVariableThemes;
 
+/** @since 5.0 */
 export type AuthoringInfoVisualVariableUnits = "seconds" | "minutes" | "hours" | "days" | "months" | "years";
 
+/** @since 5.0 */
 export type ReferenceSizeSymbolStyle = "circle" | "diamond" | "hexagon-flat" | "hexagon-pointy" | "square";
 
+/** @since 5.0 */
 export type SpikeSymbolStyle = "triangle-closed-outline" | "triangle-gradient-fill-closed" | "triangle-gradient-fill-closed-outline" | "triangle-gradient-fill-open" | "triangle-gradient-fill-open-outline" | "triangle-open-outline" | "triangle-solid-fill-closed" | "triangle-solid-fill-closed-outline" | "triangle-solid-fill-open" | "triangle-solid-fill-open-outline";
 
+/** @since 5.0 */
 export type RendererLegendOptionsOrder = "ascending-values" | "descending-values";
 
+/** @since 5.0 */
 export interface RendererLegendTitleOption {}

package/renderers/types.d.ts

@@ -13,80 +13,123 @@ import type SizeVariable from "./visualVariables/SizeVariable.js";
 import type { AbortOptions } from "../core/promiseUtils.js";
 import type { WebStyleAcceptedFormat } from "../symbols/support/types.js";
 
+/** @since 5.0 */
 export type RendererType = RendererUnion["type"];
 
+/** @since 5.0 */
 export type NormalizationType = "field" | "log" | "percent-of-total" | "natural-log" | "square-root";
 
+/** @since 5.0 */
 export type ClassificationMethod = "equal-interval" | "manual" | "natural-breaks" | "quantile" | "standard-deviation" | "defined-interval";
 
+/** @since 5.0 */
 export type SizeVariableAxis = "width" | "depth" | "height" | "width-and-depth" | "all";
 
+/** @since 5.0 */
 export type SizeVariableRepresentation = "radius" | "diameter" | "area" | "width" | "distance";
 
+/** @since 5.0 */
 export type SizeVariableUnit = "unknown" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers";
 
+/** @since 5.0 */
 export type VisualVariable = ColorVariable | SizeVariable | OpacityVariable | RotationVariable;
 
+/** @since 5.0 */
 export type VisualVariableType = VisualVariable["type"];
 
+/** @since 5.0 */
 export interface VisualVariableLegendOptions {
   /**
    * Indicates if the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/) should display content
    *   describing the generated renderer.
+   *
+   * @since 5.0
    */
   showLegend?: boolean;
   /**
    * The title used to represent the age size ramp in the
    *   [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/).
+   *
+   * @since 5.0
    */
   title?: string | null;
 }
 
+/** @since 5.0 */
 export interface GetSymbolOptions extends AbortOptions {
-  /** The [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which the graphic is displayed. */
+  /**
+   * The [view scale](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#scale) at which the graphic is displayed.
+   *
+   * @since 5.0
+   */
   scale?: number | null;
   /**
    * The spatial reference of the view in which the graphic
    *   is displayed.
+   *
+   * @since 5.0
    */
   spatialReference?: SpatialReference | null;
   /**
    * The [SceneView#viewingMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#viewingMode) of the view, if the graphic
    *   is displayed in a SceneView.
+   *
+   * @since 5.0
    */
   viewingMode?: string | null;
 }
 
+/** @since 5.0 */
 export interface GetVisualVariableValuesOptions extends GetSymbolOptions {
   /**
    * The [MapView#resolution](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#resolution) of the view at which
    *   the graphic is displayed.
+   *
+   * @since 5.0
    */
   resolution?: number;
 }
 
+/** @since 5.0 */
 export interface GetDisplaySymbolOptions extends GetVisualVariableValuesOptions {
-  /** The renderer of the layer associated with the `graphic`. */
+  /**
+   * The renderer of the layer associated with the `graphic`.
+   *
+   * @since 5.0
+   */
   renderer?: RendererUnion;
   /**
    * A list of accepted formats when
    *   resolving web style symbols. The symbol will resolve to the first accepted format in the list.
    *
    * @default ["web", "cim"]
+   * @since 5.0
    */
   webStyleAcceptedFormats?: WebStyleAcceptedFormat[];
 }
 
+/** @since 5.0 */
 export type VectorFieldStyles = "beaufort-ft" | "beaufort-km" | "beaufort-kn" | "beaufort-m" | "beaufort-mi" | "classified-arrow" | "ocean-current-kn" | "ocean-current-m" | "simple-scalar" | "single-arrow" | "wind-barb";
 
+/** @since 5.0 */
 export type RelationshipNumClasses = 2 | 3 | 4;
 
+/** @since 5.0 */
 export type DictionaryUserConfig = Object;
 
+/** @since 5.0 */
 export type DictionaryFieldMap = Record<string, string>;
 
-/** Union of all renderers with visual variables. */
+/**
+ * Union of all renderers with visual variables.
+ *
+ * @since 5.0
+ */
 export type RendererWithVisualVariablesUnion = SimpleRenderer | ClassBreaksRenderer | UniqueValueRenderer | DotDensityRenderer | DictionaryRenderer | PieChartRenderer;
 
-/** Union of renderers. */
+/**
+ * Union of renderers.
+ *
+ * @since 5.0
+ */
 export type RendererUnion = RendererWithVisualVariablesUnion | HeatmapRenderer;

package/renderers/visualVariables/support/SizeVariableLegendOptions.d.ts

@@ -1,12 +1,16 @@
 import type VisualVariableLegendOptions from "./VisualVariableLegendOptions.js";
 import type { VisualVariableLegendOptionsProperties } from "./VisualVariableLegendOptions.js";
 
+/** @since 5.0 */
 export interface SizeVariableLegendOptionsProperties extends VisualVariableLegendOptionsProperties, Partial<Pick<SizeVariableLegendOptions, "customValues">> {}
 
+/** @since 5.0 */
 export default abstract class SizeVariableLegendOptions extends VisualVariableLegendOptions {
   /**
    * Overrides the legend values with values specified here. This is typically used
    *   to round values interpolated from the SizeVariable to rounded numbers.
+   *
+   * @since 5.0
    */
   accessor customValues: number[] | null | undefined;
 }

package/renderers/visualVariables/support/VisualVariableLegendOptions.d.ts

@@ -1,15 +1,23 @@
 import type { ClonableMixin, ClonableMixinProperties } from "../../../core/Clonable.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface VisualVariableLegendOptionsProperties extends JSONSupportMixinProperties, ClonableMixinProperties, Partial<Pick<VisualVariableLegendOptions, "showLegend" | "title">> {}
 
+/** @since 5.0 */
 export default abstract class VisualVariableLegendOptions extends VisualVariableLegendOptionsSuperclass {
-  /** Indicates whether to show the visual variable in the legend. */
+  /**
+   * Indicates whether to show the visual variable in the legend.
+   *
+   * @since 5.0
+   */
   accessor showLegend: boolean | null | undefined;
   /**
    * The title describing the visualization of
    *   the visual variable in the [Legend](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-legend/). This takes precedence over
    *   a field alias or [VisualVariable#valueExpressionTitle](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-VisualVariable.html#valueExpressionTitle).
+   *
+   * @since 5.0
    */
   accessor title: string | null | undefined;
 }

package/request/types.d.ts

@@ -1,7 +1,11 @@
 import type Error from "../core/Error.js";
 import type { AbortOptions } from "../core/promiseUtils.js";
 
-/** An object with the following properties that describe the request. */
+/**
+ * An object with the following properties that describe the request.
+ *
+ * @since 5.0
+ */
 export interface RequestOptions extends AbortOptions {
   /**
    * Indicates if and how requests to ArcGIS Services are authenticated.
@@ -18,12 +22,15 @@ export interface RequestOptions extends AbortOptions {
    * > **Note:** This is not supported when used in a custom worker that is not using the [workers](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-workers.html) framework.
    *
    * @default auto
+   * @since 5.0
    */
   authMode?: "anonymous" | "auto" | "immediate" | "no-prompt";
   /**
    * If uploading a file, specify the
    * form data or element used to submit the file here. If specified, the parameters of the
    * `query` will be added to the URL.
+   *
+   * @since 5.0
    */
   body?: FormData | HTMLFormElement | string | null;
   /**
@@ -31,11 +38,14 @@ export interface RequestOptions extends AbortOptions {
    *   browser's local cache. If `false`, the browser's default cache handling will be used.
    *
    * @default false
+   * @since 5.0
    */
   cacheBust?: boolean;
   /**
    * Headers to use for the request. This is an
    * object whose property names are header names.
+   *
+   * @since 5.0
    */
   headers?: Record<string, string>;
   /**
@@ -43,6 +53,7 @@ export interface RequestOptions extends AbortOptions {
    * See also [`keepalive`](https://developer.mozilla.org/en-US/docs/Web/API/Request/keepalive) for more details.
    *
    * @default false
+   * @since 5.0
    */
   keepAlive?: boolean;
   /**
@@ -50,6 +61,7 @@ export interface RequestOptions extends AbortOptions {
    * HTTP DELETE, HEAD, POST, or PUT method. By default, HTTP POST will be used for `auto` if the request size is longer than the `maxUrlLength` property set in [ConfigWithRequest](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#ConfigWithRequest).
    *
    * @default auto
+   * @since 5.0
    */
   method?: "auto" | "delete" | "head" | "post" | "put";
   /**
@@ -58,6 +70,8 @@ export interface RequestOptions extends AbortOptions {
    * The query parameters will be added to the URL if a GET request is used, or if the `body` property is set. If the
    * `body` property is not set, the query parameters will be added to the request body when a DELETE, POST, or PUT
    * request is used.
+   *
+   * @since 5.0
    */
   query?: Record<string, any> | URLSearchParams | null;
   /**
@@ -73,6 +87,7 @@ export interface RequestOptions extends AbortOptions {
    * [xml](https://developer.mozilla.org/en-US/docs/Web/API/XMLDocument)
    *
    * @default json
+   * @since 5.0
    */
   responseType?: ResponseType;
   /**
@@ -80,6 +95,7 @@ export interface RequestOptions extends AbortOptions {
    * to wait for a response from the server. Set to `0` to wait for the response indefinitely.
    *
    * @default 62000
+   * @since 5.0
    */
   timeout?: number;
   /**
@@ -87,16 +103,19 @@ export interface RequestOptions extends AbortOptions {
    * this is determined automatically based on the domain of the request URL.
    *
    * @default false
+   * @since 5.0
    */
   useProxy?: boolean;
   /**
    * Indicates if cross-site `Access-Control` requests should use credentials.  It is also possible to push the domain to the config [trustedServers](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#ConfigWithRequest) if an application requires credentials. For additional information on `withCredentials`, please refer to [this documentation](https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials).
    *
    * @default false
+   * @since 5.0
    */
   withCredentials?: boolean;
 }
 
+/** @since 5.0 */
 export type ResponseType = "array-buffer" | "blob" | "document" | "image" | "json" | "native" | "native-request-init" | "text" | "xml";
 
 /**
@@ -104,6 +123,7 @@ export type ResponseType = "array-buffer" | "blob" | "document" | "image" | "jso
  * If the request returns an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html), the error object will
  * include the details specified in [RequestErrorDetails](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestErrorDetails).
  *
+ * @since 5.0
  * @example
  * // request GeoJson data from USGS remote server
  * let url = "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_hour.geojson";
@@ -127,19 +147,46 @@ export interface RequestResponse<T> {
    * [native-request-init](https://developer.mozilla.org/en-US/docs/Web/API/RequestInit),
    * [document](https://developer.mozilla.org/en-US/docs/Web/API/HTMLDocument), and
    * [xml](https://developer.mozilla.org/en-US/docs/Web/API/XMLDocument).
+   *
+   * @since 5.0
    */
   data: T;
-  /** Method for getting all headers sent from the server. */
+  /**
+   * Method for getting all headers sent from the server.
+   *
+   * @since 5.0
+   */
   getAllHeaders?: GetAllHeaders;
-  /** Method for getting a header sent from the server. */
+  /**
+   * Method for getting a header sent from the server.
+   *
+   * @since 5.0
+   */
   getHeader?: GetHeader;
-  /** _Since 4.26_ The status code of the http response. */
+  /**
+   * The status code of the http response.
+   *
+   * @since 4.26
+   * @since 5.0
+   */
   httpStatus?: number;
-  /** The options specified by the user in the data request. See [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) for available properties. */
+  /**
+   * The options specified by the user in the data request. See [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) for available properties.
+   *
+   * @since 5.0
+   */
   requestOptions?: RequestOptions;
-  /** Indicates if the request required https. */
+  /**
+   * Indicates if the request required https.
+   *
+   * @since 5.0
+   */
   ssl?: boolean;
-  /** The URL used to request the data. */
+  /**
+   * The URL used to request the data.
+   *
+   * @since 5.0
+   */
   url?: string;
 }
 
@@ -148,6 +195,7 @@ export interface RequestResponse<T> {
  * CORS only allows a few response headers to be read by default, see: [Access-Control-Expose-Headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Expose-Headers).
  *
  * @returns An array of all headers returned from the server. Each header is an array containing the header name and its corresponding value.
+ * @since 5.0
  * @example
  * esriRequest(url, options)
  *   .then((response) => {
@@ -165,6 +213,7 @@ export type GetAllHeaders = () => [
  *
  * @param headerName - The name of the header.
  * @returns The header value.
+ * @since 5.0
  * @example
  * esriRequest(url, options)
  *   .then((response) => {
@@ -177,40 +226,92 @@ export type GetHeader = (headerName: string) => string | null | undefined;
 /**
  * The specification of the [details object](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html#details) returned in an
  * [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) object.
+ *
+ * @since 5.0
  */
 export interface RequestErrorDetails {
-  /** A function for retrieving all headers sent from the server. */
+  /**
+   * A function for retrieving all headers sent from the server.
+   *
+   * @since 5.0
+   */
   getAllHeaders: GetAllHeaders;
-  /** A function to retrieve headers sent from the server. */
+  /**
+   * A function to retrieve headers sent from the server.
+   *
+   * @since 5.0
+   */
   getHeader: GetHeader;
-  /** The status code of the http response. */
+  /**
+   * The status code of the http response.
+   *
+   * @since 5.0
+   */
   httpStatus: number;
-  /** The error message code. */
+  /**
+   * The error message code.
+   *
+   * @since 5.0
+   */
   messageCode: string;
-  /** Additional error message(s). */
+  /**
+   * Additional error message(s).
+   *
+   * @since 5.0
+   */
   messages: string[];
-  /** The raw error object if the server returned a JSON error, or the response text otherwise. */
+  /**
+   * The raw error object if the server returned a JSON error, or the response text otherwise.
+   *
+   * @since 5.0
+   */
   raw: string | Object;
-  /** The options used in the http request. */
+  /**
+   * The options used in the http request.
+   *
+   * @since 5.0
+   */
   requestOptions: RequestOptions;
-  /** Indicates if the request required https. */
+  /**
+   * Indicates if the request required https.
+   *
+   * @since 5.0
+   */
   ssl: boolean;
-  /** The error message subcode. */
+  /**
+   * The error message subcode.
+   *
+   * @since 5.0
+   */
   subCode: number;
-  /** The URL of the request that returned an error message. */
+  /**
+   * The URL of the request that returned an error message.
+   *
+   * @since 5.0
+   */
   url: string;
 }
 
+/** @since 5.0 */
 export interface RequestParameters {
-  /** The options specified by the user in the data request. See [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) for available properties. */
+  /**
+   * The options specified by the user in the data request. See [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions) for available properties.
+   *
+   * @since 5.0
+   */
   requestOptions: RequestOptions;
-  /** The request URL. */
+  /**
+   * The request URL.
+   *
+   * @since 5.0
+   */
   url: string;
 }
 
 /**
  * Specifies the object used for intercepting and modifying requests made via [esriRequest](https://developers.arcgis.com/javascript/latest/api-reference/esri-request.html).
  *
+ * @since 5.0
  * @example
  * const featureLayerUrl = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0";
  *
@@ -254,24 +355,48 @@ export interface RequestParameters {
  * });
  */
 export interface RequestInterceptor {
-  /** Makes changes to the response after the request is sent, but before it's returned to the caller. */
+  /**
+   * Makes changes to the response after the request is sent, but before it's returned to the caller.
+   *
+   * @since 5.0
+   */
   after?: AfterInterceptorCallback;
-  /** Make changes to the request URL or options before the request is sent. A returned value will be used as the response data, which would prevent the request from being sent. */
+  /**
+   * Make changes to the request URL or options before the request is sent. A returned value will be used as the response data, which would prevent the request from being sent.
+   *
+   * @since 5.0
+   */
   before?: BeforeInterceptorCallback;
   /**
    * When an error occurs during the request processing, this function is called with an [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) object giving the details about what happened.
    * For example, this could be used to log specific errors occurring with layers or services.
+   *
+   * @since 5.0
    */
   error?: ErrorInterceptorCallback;
-  /** Sets or adds headers into `requestOptions.headers`. See also: [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions). */
+  /**
+   * Sets or adds headers into `requestOptions.headers`. See also: [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions).
+   *
+   * @since 5.0
+   */
   headers?: Record<string, string>;
-  /** Sets or adds query parameters into `requestOptions.query`. See also: [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions). */
+  /**
+   * Sets or adds query parameters into `requestOptions.query`. See also: [RequestOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestOptions).
+   *
+   * @since 5.0
+   */
   query?: Object;
-  /** Hardcodes the [response](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestResponse). The request will not be sent. This is resolved as the response `data`. */
+  /**
+   * Hardcodes the [response](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestResponse). The request will not be sent. This is resolved as the response `data`.
+   *
+   * @since 5.0
+   */
   responseData?: any;
   /**
    * Specifies the URL(s) to apply to the interceptors. If the value is type `String`, then it matches if the request URL starts with that string. If null or undefined, the interceptor will apply to all relevant requests.
    * If using a [`RegExp`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp), the [`g`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/global) and [`y`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/sticky) flags should not be used.
+   *
+   * @since 5.0
    */
   urls?: RegExp | string | Array<RegExp | string>;
 }
@@ -280,6 +405,7 @@ export interface RequestInterceptor {
  * Makes changes to the response after the request is sent, but before it's returned to the caller.
  *
  * @param response - The response object.
+ * @since 5.0
  * @example
  * const featureLayerUrl = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0";
  *
@@ -310,6 +436,7 @@ export type AfterInterceptorCallback = (response: RequestResponse<any>) => void;
  * @param params - Parameters object that specifies the two properties that can be set.
  * @returns Returns: `null`, `undefined`, [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html), [response data](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestResponse), or a Promise
  * that resolves to any one of these object types.
+ * @since 5.0
  * @example
  * // modifying the query parameters
  * const featureLayerUrl = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/USA/MapServer/0";
@@ -359,5 +486,6 @@ export type BeforeInterceptorCallback = (params: RequestParameters) => any;
  * The error function detailing the reason why the [request](https://developers.arcgis.com/javascript/latest/api-reference/esri-request-types.html#RequestInterceptor) failed.
  *
  * @param error - The error object. See [Error](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Error.html) for more information.
+ * @since 5.0
  */
 export type ErrorInterceptorCallback = (error: Error<unknown>) => void;