import type { EsriPromiseMixin } from "@arcgis/core/core/Promise.js";- Subclasses
- Basemap, Basemap, Ground, Ground, WebDocument2D, WebScene, SharedTemplate, Mesh, Layer, Layer, BuildingComponentSublayer, BuildingSummaryStatistics, MediaElementBase, MediaElementBase, KMLSublayer, KMLSublayer, LocalMediaElementSource, Sublayer, Sublayer, SubtypeSublayer, SubtypeSublayer, Network, Network, Portal, Portal, PortalItem, PortalItem, FeatureService, FeatureService, VersionManagementService, VersionManagementService, VersioningState, VersioningState, View, View, VideoView, ViewAnimation, ViewAnimation, AnalysisView, LayerView, DrawAction, Widget, BasemapGalleryViewModel, BasemapGalleryViewModel, PortalBasemapsSource, UpdateFeaturesWorkflowData, UpdateFeaturesWorkflowData, FeatureFormViewModel, OrientedImageryViewerViewModel, OrientedImageryViewerViewModel, PrintViewModel
Promise mixin.
Methods
| Method | Signature | Class |
|---|---|---|
| isFulfilled(): boolean | | |
| isRejected(): boolean | | |
| isResolved(): boolean | | |
| when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> | |
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
- Since
- ArcGIS Maps SDK for JavaScript 4.6
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
- Example
- // Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){// This function will execute once the promise is resolved}, function(error){// This function will execute if the promise is rejected due to an error});