Expo

Get Started
API Reference

Updates

The expo-updates library allows you to programmatically control and respond to new updates made available to your app.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-updates

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

Most of the methods and constants in this module can only be used or tested in release mode; they do not make sense in debug builds where you always load the latest JavaScript from your computer while in development.
To test manual updates in the Expo Go app, run expo publish and then open the published version of your app with Expo Go.
To test manual updates with managed workflow standalone apps, you can create a simulator build or APK, or make a release build locally with expo run:ios --configuration Release and expo run:android --variant release.
To test manual updates in bare workflow apps, make a release build with expo run:ios --configuration Release or expo run:android --variant release (you don't need to submit this build to the store to test).

import * as Updates from 'expo-updates';

Type: boolean

expo-updates does its very best to always launch monotonically newer versions of your app so you don't need to worry about backwards compatibility when you put out an update. In very rare cases, it's possible that expo-updates may need to fall back to the update that's embedded in the app binary, even after newer updates have been downloaded and run (an "emergency launch"). This boolean will be true if the app is launching under this fallback mechanism and false otherwise. If you are concerned about backwards compatibility of future updates to your app, you can use this constant to provide special behavior for this rare case.

Type: Partial<Manifest>

If expo-updates is enabled, this is the manifest object for the update that's currently running.

In development mode, or any other environment in which expo-updates is disabled, this object is empty.

Type: string

The name of the release channel currently configured in this standalone or bare app when using classic updates. When using Expo Updates, the value of this field is always "default".

Type: string | null

The UUID that uniquely identifies the currently running update if expo-updates is enabled. The UUID is represented in its canonical string form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx) and will always use lowercase letters. In development mode, or any other environment in which expo-updates is disabled, this value is null.

Checks the server to see if a newly deployed update to your project is available. Does not actually download the update. This method cannot be used in development mode, and the returned promise will be rejected if you try to do so.

  • Promise<UpdateCheckResult>

A promise that fulfills with an UpdateCheckResult object.

The promise rejects if the app is in development mode, or if there is an unexpected error or timeout communicating with the server.


Downloads the most recently deployed update to your project from server to the device's local storage. This method cannot be used in development mode, and the returned promise will be rejected if you try to do so.

A promise that fulfills with an UpdateFetchResult object.

The promise rejects if the app is in development mode, or if there is an unexpected error or timeout communicating with the server.


Instructs the app to reload using the most recently downloaded version. This is useful for triggering a newly downloaded update to launch without the user needing to manually restart the app.

It is not recommended to place any meaningful logic after a call to await Updates.reloadAsync(). This is because the promise is resolved after verifying that the app can be reloaded, and immediately before posting an asynchronous task to the main thread to actually reload the app. It is unsafe to make any assumptions about whether any more JS code will be executed after the Updates.reloadAsync method call resolves, since that depends on the OS and the state of the native module and main threads.

This method cannot be used in development mode, and the returned promise will be rejected if you try to do so.

A promise that fulfills right before the reload instruction is sent to the JS runtime, or rejects if it cannot find a reference to the JS runtime. If the promise is rejected in production mode, it most likely means you have installed the module incorrectly. Double check you've followed the installation instructions. In particular, on iOS ensure that you set the bridge property on EXUpdatesAppController with a pointer to the RCTBridge you want to reload, and on Android ensure you either call UpdatesController.initialize with the instance of ReactApplication you want to reload, or call UpdatesController.setReactNativeHost with the proper instance of ReactNativeHost.

  • listener ((event: UpdateEvent) => void) - A function that will be invoked with an UpdateEvent instance and should not return any value.

Adds a callback to be invoked when updates-related events occur (such as upon the initial app load) due to auto-update settings chosen at build-time.

  • EventSubscription

An EventSubscription object on which you can call remove() to unsubscribe the listener.

The result of checking for a new update.

NameTypeDescription
isAvailablebooleantrue if an update is available, false if the app is already running the latest available update.
manifest
(optional)
ManifestIf isAvailable is true, the manifest of the available update, and undefined otherwise.

An object that is passed into each event listener when an auto-update check occurs.

NameTypeDescription
manifest
(optional)
ManifestIf type is Updates.UpdateEventType.UPDATE_AVAILABLE, the manifest of the newly downloaded update, and undefined otherwise.
message
(optional)
stringIf type is Updates.UpdateEventType.ERROR, the error message, and undefined otherwise.
typeUpdateEventTypeType of the event.

The result of fetching a new update.

NameTypeDescription
isNewbooleantrue if the fetched bundle is new (that is, a different version than what's currently running), false otherwise.
manifest
(optional)
ManifestIf isNew is true, the manifest of the newly downloaded update, and undefined otherwise.

The types of update-related events.

  • UpdateEventType.ERROR : "error" - An error occurred trying to fetch the latest update.
  • UpdateEventType.NO_UPDATE_AVAILABLE : "noUpdateAvailable" - No updates are available, and the most up-to-date update is already running.
  • UpdateEventType.UPDATE_AVAILABLE : "updateAvailable" - A new update has finished downloading to local storage. If you would like to start using this update at any point before the user closes and restarts the app on their own, you can call Updates.reloadAsync() to launch this new update.

CodeDescription
ERR_UPDATES_DISABLEDA method call was attempted when the Updates module was disabled, or the application was running in development mode
ERR_UPDATES_RELOADAn error occurred when trying to reload the application and it could not be reloaded. For bare workflow apps, double check the setup steps for this module to ensure it has been installed correctly and the proper native initialization methods are called.
ERR_UPDATES_CHECKAn unexpected error occurred when trying to check for new updates. Check the error message for more information.
ERR_UPDATES_FETCHAn unexpected error occurred when trying to fetch a new update. Check the error message for more information.