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

package/rest/support/SuggestLocationsParameters.d.ts

@@ -2,31 +2,41 @@ import type Point from "../../geometry/Point.js";
 import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 import type { PointProperties } from "../../geometry/Point.js";
 
+/** @since 5.0 */
 export interface SuggestLocationsParametersProperties extends JSONSupportMixinProperties, Partial<Pick<SuggestLocationsParameters, "categories" | "text">> {
   /**
    * Defines a normalized location point that is used to sort geocoding candidates based upon their proximity
    *                                                     to the given location.
+   *
+   * @since 5.0
    */
   location?: PointProperties | null;
 }
 
+/** @since 5.0 */
 export default abstract class SuggestLocationsParameters extends JSONSupport {
   /**
    * A place or address type which can be used to filter suggest results.
    *                                     The parameter supports input of single category values or multiple comma-separated values. For example,
    * "Populated Place" or "Scandinavian Food". Only applies to the World Geocode Service.
    * See [Category filtering (World Geocoding Service)](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-category-filtering.htm#ESRI_SECTION1_502B3FE2028145D7B189C25B1A00E17B) for more information.
+   *
+   * @since 5.0
    */
   accessor categories: string[] | null;
   /**
    * Defines a normalized location point that is used to sort geocoding candidates based upon their proximity
    *                                                     to the given location.
+   *
+   * @since 5.0
    */
   get location(): Point | null;
   set location(value: PointProperties | null);
   /**
    * The input text entered by a user which is used by the suggest operation to generate a
    * list of possible matches.
+   *
+   * @since 5.0
    */
   accessor text: string | null;
 }

package/rest/support/SuggestionCandidate.d.ts

@@ -3,15 +3,27 @@ import type { JSONSupport } from "../../core/JSONSupport.js";
 /**
  * Describes the object representing the result of the
  * [suggestLocations()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html#suggestLocations) method.
+ *
+ * @since 5.0
  */
 export default abstract class SuggestionCandidate extends JSONSupport {
-  /** Indicates if the result is a Collection. */
+  /**
+   * Indicates if the result is a Collection.
+   *
+   * @since 5.0
+   */
   accessor isCollection: boolean | null;
   /**
    * ID used in combination with the `text` property
    *                    to uniquely identify a suggestion.
+   *
+   * @since 5.0
    */
   accessor magicKey: string | null;
-  /** The string name of the suggested location to geocode. */
+  /**
+   * The string name of the suggested location to geocode.
+   *
+   * @since 5.0
+   */
   accessor text: string | null;
 }

package/rest/support/types.d.ts

@@ -13,86 +13,136 @@ import type { TimeUnit, LengthUnit as CoreLengthUnit } from "../../core/units.js
 
 /**
  * An object describing the parameter values for the
- * {@link rest/support/interfaces#attributeParameterValues} property of
+ * [RouteParameters#attributeParameterValues](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html#attributeParameterValues) property, which is used by
  * [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html), [ClosestFacilityParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ClosestFacilityParameters.html) and [ServiceAreaParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html).
+ *
+ * @since 5.0
  */
 export interface AttributeParameterValue {
-  /** The name of the attribute. */
+  /**
+   * The name of the attribute.
+   *
+   * @since 5.0
+   */
   attributeName: string;
-  /** The name of the parameter associated with the restriction. A restriction can have one or more `parameterName` properties. */
+  /**
+   * The name of the parameter associated with the restriction. A restriction can have one or more `parameterName` properties.
+   *
+   * @since 5.0
+   */
   parameterName: string;
-  /** The value for `parameterName`. */
+  /**
+   * The value for `parameterName`.
+   *
+   * @since 5.0
+   */
   value: string | number | null;
 }
 
+/** @since 5.0 */
 export type MessageType = "informative" | "process-definition" | "process-start" | "process-stop" | "warning" | "error" | "empty" | "abort";
 
+/** @since 5.0 */
 export type OutputLine = "none" | "straight" | "true-shape" | "true-shape-with-measure";
 
+/** @since 5.0 */
 export type OutputPolygon = "none" | "simplified" | "detailed";
 
+/** @since 5.0 */
 export type LengthUnit = CoreLengthUnit | "decimal-degrees" | "points" | "unknown";
 
+/** @since 5.0 */
 export type GPLinearUnit = LengthUnit | "international-feet" | "international-inches" | "international-miles" | "international-nautical-miles" | "international-yards";
 
+/** @since 5.0 */
 export type AreaUnit = "ares" | "hectares" | "international-acres" | "square-centimeters" | "square-decimeters" | "square-international-feet" | "square-international-inches" | "square-international-miles" | "square-international-yards" | "square-kilometers" | "square-meters" | "square-millimeters" | "square-us-feet" | "square-us-inches" | "square-us-miles" | "square-us-yards" | "unknown" | "us-acres";
 
+/** @since 5.0 */
 export type GeometryOperationLengthUnit = "feet" | "kilometers" | "meters" | "miles" | "nautical-miles" | "yards";
 
+/** @since 5.0 */
 export type DirectionsDetail = "complete" | "complete-no-events" | "featuresets" | "instructions-only" | "standard" | "summary-only";
 
+/** @since 5.0 */
 export type UTurnRestriction = "allow-backtrack" | "at-dead-ends-only" | "no-backtrack" | "at-dead-ends-and-intersections";
 
+/** @since 5.0 */
 export type TimeOfDay = "not-used" | "start" | "end";
 
+/** @since 5.0 */
 export type TravelDirection = "from-facility" | "to-facility";
 
+/** @since 5.0 */
 export type TraveModeType = "automobile" | "truck" | "walk" | "other";
 
+/** @since 5.0 */
 export type NetworkInput = DataLayer | FeatureSet | NetworkFeatureSet | NetworkUrl;
 
+/** @since 5.0 */
 export type CurbApproach = "either-side-of-vehicle" | "right-side-of-vehicle" | "left-side-of-vehicle" | "no-u-turn";
 
+/** @since 5.0 */
 export type LocationType = "stop" | "waypoint" | "break";
 
+/** @since 5.0 */
 export type Status = "ok" | "not-located" | "network-element-not-located" | "element-not-traversable" | "invalid-field-values" | "not-reached" | "time-window-violation" | "not-located-on-closest";
 
+/** @since 5.0 */
 export type BarrierType = "restriction" | "scaled-cost" | "added-cost";
 
+/** @since 5.0 */
 export type FullEdge = "permit" | "restrict";
 
+/** @since 5.0 */
 export type DirectionPointType = "arrive" | "bear-left" | "bear-right" | "boundary-crossing" | "central-fork" | "clockwise-roundabout" | "counter-clockwise-roundabout" | "depart" | "door" | "down-elevator" | "down-escalator" | "down-stairs" | "elevator" | "escalator" | "general-event" | "header" | "landmark" | "lane" | "left-fork" | "left-handed-u-turn" | "left-ramp" | "left-turn" | "left-turn-and-immediate-left-turn" | "left-turn-and-immediate-right-turn" | "off-ferry" | "on-ferry" | "pedestrian-ramp" | "restriction-violation" | "right-fork" | "right-handed-u-turn" | "right-ramp" | "right-turn" | "right-turn-and-immediate-left-turn" | "right-turn-and-immediate-right-turn" | "roundabout" | "scaled-cost-barrier-event" | "sharp-left" | "sharp-right" | "stairs" | "straight" | "time-zone-change" | "traffic-event" | "u-turn" | "up-elevator" | "up-escalator" | "up-stairs";
 
+/** @since 5.0 */
 export type DirectionLineType = "unknown" | "segment" | "maneuver-segment" | "restriction-violation" | "scaled-cost-barrier" | "heavy-traffic" | "slow-traffic" | "moderate-traffic";
 
+/** @since 5.0 */
 export type NetworkFeature = DirectionLine | DirectionPoint | PointBarrier | PolygonBarrier | PolylineBarrier | RouteInfo | Stop;
 
+/** @since 5.0 */
 export type DirectionsStyleName = "campus" | "desktop" | "navigation";
 
+/** @since 5.0 */
 export type SpatialRelationship = "intersects" | "contains" | "crosses" | "disjoint" | "envelope-intersects" | "index-intersects" | "overlaps" | "touches" | "within" | "relation";
 
+/** @since 5.0 */
 export type GeometryType = "point" | "polyline" | "polygon" | "envelope" | "multipoint";
 
+/** @since 5.0 */
 export type DirectionsStringType = "alt-name" | "arrive" | "branch" | "cross-street" | "cumulative-length" | "depart" | "estimated-arrival-time" | "exit" | "general" | "length" | "service-time" | "street-name" | "summary" | "time" | "time-window" | "toward" | "violation-time" | "wait-time";
 
+/** @since 5.0 */
 export type NetworkAttributeAccerationUnit = "kilometers-per-hour" | "miles-per-hour";
 
+/** @since 5.0 */
 export type NetworkAttributeUnknownUnit = "unknown";
 
+/** @since 5.0 */
 export type NetworkAttributeUnit = NetworkAttributeAccerationUnit | TimeUnit | LengthUnit | NetworkAttributeUnknownUnit;
 
+/** @since 5.0 */
 export type JobStatus = "job-cancelled" | "job-cancelling" | "job-deleted" | "job-deleting" | "job-timed-out" | "job-executing" | "job-failed" | "job-new" | "job-submitted" | "job-succeeded" | "job-waiting";
 
+/** @since 5.0 */
 export type NetworkDate = Date | "now";
 
+/** @since 5.0 */
 export type PrintReportTemplate = "attribute-list-letter-ansi-a-landscape" | "attribute-list-letter-ansi-a-portrait" | "attribute-list-with-group-letter-ansi-a-landscape" | "attribute-list-with-group-letter-ansi-a-portrait" | "page-per-feature-letter-ansi-a-landscape" | "page-per-feature-letter-ansi-a-portrait";
 
+/** @since 5.0 */
 export type PrintLayoutTemplate = "map-only" | "a3-landscape" | "a3-portrait" | "a4-landscape" | "a4-portrait" | "letter-ansi-a-landscape" | "letter-ansi-a-portrait" | "tabloid-ansi-b-landscape" | "tabloid-ansi-b-portrait";
 
+/** @since 5.0 */
 export type PrintFileFormat = "aix" | "eps" | "gif" | "jpg" | "pdf" | "png32" | "png8" | "svg" | "svgz" | "tiff";
 
+/** @since 5.0 */
 export type ColorRampAlgorithmType = "cie-lab" | "lab-lch" | "hsv";
 
+/** @since 5.0 */
 export type DateBinTimeUnit = "years" | "quarters" | "months" | "weeks" | "days" | "hours" | "minutes" | "seconds";
 
+/** @since 5.0 */
 export type DeviationUnit = Exclude<LengthUnit, "us-feet"> | "decimal-degrees";

package/rest/symbolService.d.ts

@@ -17,8 +17,8 @@ import type { GenerateSymbolParameters, GenerateSymbolResponse } from "./types.j
  * If using a SVG string value in the [GenerateSymbolParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-types.html#GenerateSymbolParameters), the XML namespace (`xmlns`) must be defined.
  * For SVGs defined in `FormData` or an `HTMLFormElement`, the `name` of the element in the form must be `"svgImage"`, as shown in the examples below.
  *
- * The returned CIMSymbol will always be a {@link symbols/cim/CIMTypes!CIMPointSymbol}
- * with a {@link symbols/cim/CIMTypes!CIMVectorMarker} symbol layer where `size = 10`. To update the size of the symbol, use [scaleCIMSymbolTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#scaleCIMSymbolTo).
+ * The returned CIMSymbol will always be a [CIMPointSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-cim-types.html#CIMPointSymbol)
+ * with a [CIMVectorMarker](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-cim-types.html#CIMVectorMarker) symbol layer where `size = 10`. To update the size of the symbol, use [scaleCIMSymbolTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html#scaleCIMSymbolTo).
  *
  * @param url - URL to the ArcGIS Server REST resource that represents a symbol service.
  * @param params - Input parameters for converting an SVG to CIM Symbol.

package/rest/types.d.ts

@@ -8,78 +8,123 @@ import type RasterData from "./support/RasterData.js";
 import type CIMSymbol from "../symbols/CIMSymbol.js";
 import type { AbortOptions } from "../core/promiseUtils.js";
 
+/** @since 5.0 */
 export type ParameterTypes = ArealUnit | DataFile | Date | FeatureSet | Field | LinearUnit | RasterData | boolean | number | string;
 
+/** @since 5.0 */
 export type SingleDataType = "areal-unit" | "boolean" | "composite" | "data-file" | "date" | "double" | "feature-record-set-layer" | "field" | "linear-unit" | "long" | "raster-data" | "raster-data-layer" | "record-set" | "string" | "value-table";
 
+/** @since 5.0 */
 export interface SingleParameterValue<T extends SingleDataType, U extends ParameterTypes> {
+  /** @since 5.0 */
   dataType: T;
+  /** @since 5.0 */
   value: U;
 }
 
+/** @since 5.0 */
 export interface MultipleParameterValue<T extends SingleDataType, U extends ParameterTypes> {
+  /** @since 5.0 */
   dataType: `multi-value-${T}`;
+  /** @since 5.0 */
   value: U[];
 }
 
+/** @since 5.0 */
 export type ParameterValueTemplate<T extends SingleDataType, U extends ParameterTypes> = SingleParameterValue<T, U> | MultipleParameterValue<T, U>;
 
+/** @since 5.0 */
 export type ParameterValue = ParameterValueTemplate<"areal-unit", ArealUnit> | ParameterValueTemplate<"boolean", boolean> | ParameterValueTemplate<"data-file", DataFile> | ParameterValueTemplate<"date", Date> | ParameterValueTemplate<"double", number> | ParameterValueTemplate<"feature-record-set-layer", FeatureSet> | ParameterValueTemplate<"field", Field> | ParameterValueTemplate<"linear-unit", LinearUnit> | ParameterValueTemplate<"long", number> | ParameterValueTemplate<"raster-data", RasterData> | ParameterValueTemplate<"raster-data-layer", RasterData> | ParameterValueTemplate<"record-set", FeatureSet> | ParameterValueTemplate<"string", string>;
 
-/** Represents the response of the [execute()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#execute) method. */
+/**
+ * Represents the response of the [execute()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html#execute) method.
+ *
+ * @since 5.0
+ */
 export type PrintResponse = DataFile;
 
+/** @since 5.0 */
 export type LocationType = "rooftop" | "street";
 
+/** @since 5.0 */
 export interface Transformation {
   /**
    * The well-known ID of the datum transformation to apply to the projection.
    * [List of valid IDs for Datum transformations](https://developers.arcgis.com/rest/services-reference/enterprise/using-spatial-references.htm).
+   *
+   * @since 5.0
    */
   wkid?: number;
   /**
    * The well-known text that defines a spatial reference. Many browsers have a limit to the length of a GET request
    * of approximately 2048 characters. When using well-known text to specify the spatial reference you can easily exceed
    * this limit. In these cases, you will need to [setup and use a proxy page](https://developers.arcgis.com/javascript/latest/proxies/).
+   *
+   * @since 5.0
    */
   wkt?: string;
 }
 
-/** The response of the [generateSymbol()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method. */
+/**
+ * The response of the [generateSymbol()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method.
+ *
+ * @since 5.0
+ */
 export interface GenerateSymbolResponse {
-  /** The CIMSymbol created from the [generateSymbol()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method. */
+  /**
+   * The CIMSymbol created from the [generateSymbol()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method.
+   *
+   * @since 5.0
+   */
   symbol: CIMSymbol;
 }
 
-/** Input parameters for the [generateSymbol()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method. */
+/**
+ * Input parameters for the [generateSymbol()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-symbolService.html#generateSymbol) method.
+ *
+ * @since 5.0
+ */
 export interface GenerateSymbolParameters {
   /**
    * The SVG image to convert. Can be an SVG string value, form data, or form element.
    *   When providing the SVG from `FormData` or `HTMLFormElement`, the `name` of the element in the form must be `"svgImage"`. When providing the SVG from a string, the XML namespace (`xmlns`) must be defined.
+   *
+   * @since 5.0
    */
   svgImage?: string | FormData | HTMLFormElement;
 }
 
+/** @since 5.0 */
 export interface WaitForJobOptions extends AbortOptions {
-  /** An authorization string used to access a resource or service. */
+  /**
+   * An authorization string used to access a resource or service.
+   *
+   * @since 5.0
+   */
   apiKey?: string | null;
   /**
    * The time in millisecond between remote job status requests.
    *
    * @default 1000
+   * @since 5.0
    */
   interval?: number;
   /**
    * Callback function that is called at the specified interval.
    *                                            Use this method to monitor job status and messages.
+   *
+   * @since 5.0
    */
   statusCallback?: (jobInfo: JobInfo) => void;
 }
 
+/** @since 5.0 */
 export interface LayerMetadata {
   /**
    * The [FeatureLayer#uniqueIdFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#uniqueIdFields) of the FeatureLayer.
    * Specify this parameter, if the [FeatureLayer#uniqueIdFields](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#uniqueIdFields) uses non-numeric unique IDs.
+   *
+   * @since 5.0
    */
   uniqueIdFields?: string[] | null;
 }

package/rest/versionManagement/gdbVersion/support/AlterVersionParameters.d.ts

@@ -1,15 +1,33 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../../core/JSONSupport.js";
 import type { AccessType } from "../../../../versionManagement/support/type.js";
 
+/** @since 5.0 */
 export interface AlterVersionParametersProperties extends JSONSupportMixinProperties, Partial<Pick<AlterVersionParameters, "access" | "description" | "ownerName" | "versionName">> {}
 
+/** @since 5.0 */
 export default abstract class AlterVersionParameters extends JSONSupport {
-  /** The new access permissions of the version. */
+  /**
+   * The new access permissions of the version.
+   *
+   * @since 5.0
+   */
   accessor access: AccessType | null | undefined;
-  /** The new description for the version. */
+  /**
+   * The new description for the version.
+   *
+   * @since 5.0
+   */
   accessor description: string | undefined;
-  /** The new owner name of the version. */
+  /**
+   * The new owner name of the version.
+   *
+   * @since 5.0
+   */
   accessor ownerName: string | undefined;
-  /** The new name for the version. */
+  /**
+   * The new name for the version.
+   *
+   * @since 5.0
+   */
   accessor versionName: string | undefined;
 }

package/rest/versionManagement/gdbVersion/support/PostResult.d.ts

@@ -6,13 +6,18 @@ import type { JSONSupport } from "../../../../core/JSONSupport.js";
  * @since 4.28
  */
 export default abstract class PostResult extends JSONSupport {
-  /** Returns data moments of the post. */
+  /**
+   * Returns data moments of the post.
+   *
+   * @since 5.0
+   */
   get moment(): Date | null | undefined;
   set moment(value: (Date | number | string) | null | undefined);
   /**
    * Specifies if the post rest call was successful.
    *
    * @default false
+   * @since 5.0
    */
   accessor success: boolean;
 }

package/rest/versionManagement/gdbVersion/support/ReconcileParameters.d.ts

@@ -1,22 +1,31 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface ReconcileParametersProperties extends JSONSupportMixinProperties, Partial<Pick<ReconcileParameters, "abortIfConflicts" | "conflictDetection" | "withPost">> {}
 
+/** @since 5.0 */
 export type DetectionType = "by-object" | "by-attribute";
 
+/** @since 5.0 */
 export default abstract class ReconcileParameters extends JSONSupport {
   /**
    * Specifies whether the reconcile should be aborted if conflicts are found. The default is false
    *
    * @default false
+   * @since 5.0
    */
   accessor abortIfConflicts: boolean;
-  /** Specifies the conditions required for conflicts to occur are defined by object (row) or attribute (column). */
+  /**
+   * Specifies the conditions required for conflicts to occur are defined by object (row) or attribute (column).
+   *
+   * @since 5.0
+   */
   accessor conflictDetection: DetectionType | null;
   /**
    * Specifies if post will occur after calling reconcile. Causes post to occur immediately after reconcile, false by default.
    *
    * @default false
+   * @since 5.0
    */
   accessor withPost: boolean;
 }

package/rest/versionManagement/gdbVersion/support/ReconcileResult.d.ts

@@ -10,21 +10,28 @@ export default abstract class ReconcileResult extends JSONSupport {
    * Specifies if the updates from the version were posted.
    *
    * @default false
+   * @since 5.0
    */
   accessor didPost: boolean;
   /**
    * Specifies if the reconcile returned with conflicts.
    *
    * @default false
+   * @since 5.0
    */
   accessor hasConflicts: boolean;
-  /** Returns data moment of the reconcile. */
+  /**
+   * Returns data moment of the reconcile.
+   *
+   * @since 5.0
+   */
   get moment(): Date | null | undefined;
   set moment(value: (Date | number | string) | null | undefined);
   /**
    * Specifies if the reconcile rest call was successful.
    *
    * @default false
+   * @since 5.0
    */
   accessor success: boolean;
 }

package/rest/versionManagement/support/CreateVersionParameters.d.ts

@@ -1,17 +1,28 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../core/JSONSupport.js";
 import type { AccessType } from "../../../versionManagement/support/type.js";
 
+/** @since 5.0 */
 export interface CreateVersionParametersProperties extends JSONSupportMixinProperties, Partial<Pick<CreateVersionParameters, "access" | "description" | "versionName">> {}
 
+/** @since 5.0 */
 export default abstract class CreateVersionParameters extends JSONSupport {
   /**
    * The access type of the new version.
    *
    * @default "private"
+   * @since 5.0
    */
   accessor access: AccessType;
-  /** The description of the new version. */
+  /**
+   * The description of the new version.
+   *
+   * @since 5.0
+   */
   accessor description: string | null;
-  /** The name of the new version. */
+  /**
+   * The name of the new version.
+   *
+   * @since 5.0
+   */
   accessor versionName: string | undefined;
 }

package/rest/versionManagement/support/GetVersionInfosParameters.d.ts

@@ -1,14 +1,21 @@
 import type { JSONSupport, JSONSupportMixinProperties } from "../../../core/JSONSupport.js";
 
+/** @since 5.0 */
 export interface GetVersionInfosParametersProperties extends JSONSupportMixinProperties, Partial<Pick<GetVersionInfosParameters, "includeHidden" | "ownerFilter">> {}
 
+/** @since 5.0 */
 export default abstract class GetVersionInfosParameters extends JSONSupport {
   /**
    * Specifies whether to include hidden versions. This is `false` by default.
    *
    * @default false
+   * @since 5.0
    */
   accessor includeHidden: boolean;
-  /** Filter to query versions by owner name. */
+  /**
+   * Filter to query versions by owner name.
+   *
+   * @since 5.0
+   */
   accessor ownerFilter: string | null;
 }