HotupdaterHot Updater
React Native API

getChannel

The `HotUpdater.getChannel()` function returns the app's current effective channel.

By default, if no channel is specified, the app is assigned to the production channel.

For build-time setup, refer to Default Channel Setup. For runtime switching, see Runtime Channel Switch.

Usage

You can use HotUpdater.getChannel() to dynamically check which channel the app is currently using.

Example

import { HotUpdater } from "@hot-updater/react-native";
import { Text, View } from "react-native";

function App() {
  const channel = HotUpdater.getChannel();

  return (
    <View>
      <Text>Current Channel: {channel}</Text>
    </View>
  );
}

export default HotUpdater.wrap({
  baseURL: "<your-update-server-url>",
  updateStrategy: "appVersion", // or "fingerprint"
  updateMode: "auto",
  requestHeaders: {
    "Authorization": "Bearer <your-access-token>",
  },
})(App);

Behavior

  • If no runtime channel switch is active, HotUpdater.getChannel() returns the build-time channel.
  • If a bundle from another channel has been applied at runtime, HotUpdater.getChannel() returns that switched channel.
  • If no channel is configured, the default is production.
  • The build-time default channel is injected into the native app during the build process based on releaseChannel in hot-updater.config.ts.
  • Use HotUpdater.getDefaultChannel() when you need the embedded default channel regardless of runtime channel switch state.
  • You can restore the original channel with HotUpdater.resetChannel().

Configuration Example (hot-updater.config.ts)

import { defineConfig } from "hot-updater";
import { config } from "dotenv";

config({ path: ".env.hotupdater" });

export default defineConfig({
  releaseChannel: "dev", // Specifying the release channel
  build: ...,
  storage: ...,
  database: ...,
});

With this configuration, HotUpdater.getChannel() will initially return "dev".

Runtime Example

const updateInfo = await HotUpdater.checkForUpdate({
  updateStrategy: "appVersion",
  channel: "beta",
});

if (updateInfo) {
  await updateInfo.updateBundle();
  await HotUpdater.reload();
}

console.log(HotUpdater.getChannel()); // "beta"

setReloadBehavior

Control how HotUpdater.reload() is executed.

getDefaultChannel

The `HotUpdater.getDefaultChannel()` function returns the build-time default channel embedded in the app.

On this page

UsageExampleBehaviorConfiguration Example (hot-updater.config.ts)Runtime ExampleRelated APIs