Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/aravind3566/react-native-in-app-updates/llms.txt

Use this file to discover all available pages before exploring further.

React Native In-App Updates lets you trigger Android in-app update flows directly from your React Native app with minimal code. Built on top of the Google Play In-App Update API, it supports both Flexible (background download) and Immediate (full-screen blocking) update flows, plus an offline mock mode for testing without a Play Store connection.

Installation

Add the package to your project with npm or Yarn and link the native module

Quickstart

Trigger your first in-app update flow in under five minutes

Flexible Update

Let users keep using your app while the update downloads in the background

Immediate Update

Force a full-screen update that users must complete before continuing

Mock Testing

Test update flows offline using the built-in FakeAppUpdateManager

API Reference

Full type signatures for checkForUpdate and the UpdateFlow enum

How It Works

1

Install the library

Add react-native-in-app-updates to your project and rebuild the Android app to link the native module.
2

Choose an update flow

Pick UpdateFlow.FLEXIBLE for a background download that doesn’t interrupt users, or UpdateFlow.IMMEDIATE for a mandatory full-screen update.
3

Call checkForUpdate

Call the single exported function. The library checks the Play Store, launches the appropriate update UI if an update is available, and resolves when the flow completes.
4

Handle the result

The returned Promise resolves with a status string or rejects with a typed error code — wrap it in a try/catch to handle cancellations and network failures gracefully.
This library is Android-only. Calling checkForUpdate on iOS will immediately reject the Promise with a clear error message, so it is safe to call on both platforms without platform guards.

Build docs developers (and LLMs) love