expo-ota-manager
v1.1.5
Published
A helper plugin to manage Over-The-Air updates when your app is running
Downloads
180
Readme
expo-ota-manager
A helper plugin to manage Over-The-Air updates when your app is running
This library is designed to help keep your Expo application up to date.
The default initialised value for fallbackToCacheTimeout is 0s, which means that your app will be on an old JS bundle version until the first full app restart.
When you instantiate this library it will check for new app updates every time your app opens from the background. If there are any new updates available, it will download them in the background and then prompt the user to restart their app to use the new version.
Attention!
Since version 1.1.4
expo-updates is now a peer dependency. This means you must install expo-updates with expo install expo-updates
before the package will work.
Usage
yarn add expo-ota-manager
import * as React from "react";
import { Text, View, StyleSheet } from "react-native";
import { initialiseOtaManager } from "expo-ota-manager";
export default function App() {
React.useEffect(
() =>
initialiseOtaManager({
/*options*/
}),
[]
);
return (
<View style={styles.container}>
<Text style={styles.paragraph}>
Publish a new OTA update and open app from background to get notified
</Text>
</View>
);
}
const styles = StyleSheet.create({
container: {
flex: 1,
justifyContent: "center",
backgroundColor: "#ecf0f1",
padding: 8,
},
paragraph: {
margin: 24,
fontSize: 18,
fontWeight: "bold",
textAlign: "center",
},
});
Available props
| Name | Type | Default | Description | | ------------------------- | -------- | ------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------- | | noButtonText | string | "Not now" | No button text | | yesButtonText | string | "Restart" | Yes button text | | titleText | string | "A new version is available" | Title text | | textLines | string[] | ["An update is ready", "Restart your app to start using it"] | The text that will appear in the alert | | repromptIntervalMs | number | hourInMS | How often to remind a user to restart for an update | | foregroundCheckIntervalMs | number | 0 (don't run) | Time interval for an additional check that runs constantly - if you are concerned about app not going into background |