RefreshStatus Constants

Status enum that represents the overall status of the refresh process. When a refresh process completes, this status is emitted to a registered refresh container via a Promise result.

  • RefreshError
    • The refresh process couldn’t run on descendant refresh handler nodes.
  • RefreshComplete
    • Default. The refresh process has completed on all descendant refresh handler nodes.
  • RefreshCompleteWithErrors
    • The refresh process has completed on descendant refresh handler nodes, but some children have reported an error.
1@type {{RefreshCompleteWithErrors: number, RefreshError: number, RefreshComplete: number}}
2
3export const REFRESH_ERROR = 0;
4export const REFRESH_COMPLETE = 1;
5export const REFRESH_COMPLETE_WITH_ERRORS = 2;

See Also

Get Started
Create Lightning Web Components
Work with Lightning Base Components
Communicate with Events
Work with Salesforce Data
Develop Secure Code
Use Components in Salesforce Targets
Use Components Outside Salesforce with Lightning Out 2.0
Aura Coexistence
Migrate Aura Components
Debug Lightning Web Components
Test Lightning Web Components
Improve Performance
Use DX MCP Tools for LWC (Beta)
LWC API Modules
GraphQL API
experience/cms*Api Wire Adapters and Functions
experience/blockBuilderApi Module
lightning/industriesEducationPublicApi Module
lightning/serviceKnowledgeApi Module
lightning/stateManager* State Managers
lightning/ui*Api Wire Adapters and Functions
lightning/analyticsSmartDataDiscoveryApi Wire Adapters and Functions
lightning/analyticsWaveApi Wire Adapters and Functions
lightning/cmsDeliveryApi Wire Adapters and Functions (Beta)
lightning/fileDownload Module
lightning/mobileCapabilities Module
lightning/refresh Module
registerRefreshContainer()
registerRefreshHandler()
unregisterRefreshContainer()
unregisterRefreshHandler()
RefreshStatus Constants
RefreshEvent Properties
Reference