Expo Updates

GitHub

npm

Updates.checkForUpdateAsync()

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.

Checking for an update uses a device's bandwidth and battery life like any network call. Additionally, updates served by Expo may be rate limited. A good rule of thumb to check for updates judiciously is to check when the user launches or foregrounds the app. Avoid polling for updates in a frequent loop.

Returns

• 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.

Updates.clearLogEntriesAsync()

Clears existing expo-updates log entries.

For now, this operation does nothing on the client. Once log persistence has been implemented, this operation will actually remove existing logs.

Returns

• Promise<void>

A promise that fulfills if the clear operation was successful.

The promise rejects if there is an unexpected error in clearing the logs.

Updates.fetchUpdateAsync()

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.

Returns

• Promise<UpdateFetchResult>

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.

Updates.readLogEntriesAsync(maxAge)

Retrieves the most recent expo-updates log entries.

Returns

• Promise<UpdatesLogEntry[]>

A promise that fulfills with an array of UpdatesLogEntry objects;

The promise rejects if there is an unexpected error in retrieving the logs.

Updates.reloadAsync()

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.

Returns

• Promise<void>

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.

Updates.addListener(listener)

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.

Returns

• EventSubscription

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