notifyAppReady

Observe the launch outcome

Use onNotifyAppReady in your chosen configuration API to observe the native launch result. init waits until native launch verification has finished before invoking this callback.

For a custom update flow, configure init at module scope. Add this optional callback when you need to observe the launch result:

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

export const hotUpdater = HotUpdater.init({
  baseURL: "<your-update-server-url>",
  requestHeaders: {
    "x-api-key": "<client-api-key>",
  },
  onNotifyAppReady: (result) => { 
    switch (result.status) {
      case "UNCHANGED":
        console.log("No applied or recovered transition to report");
        break;
      case "UPDATE_APPLIED":
        console.log("Applied:", result.fromBundleId, result.toBundleId);
        break;
      case "RECOVERED":
        console.log("Recovered:", result.fromBundleId, result.toBundleId);
        break;
    }
  },
});

You do not need a separate notifyAppReady() call to enable lifecycle handling or the Insights plugin.

Return value

hotUpdater.notifyAppReady() is a synchronous read of the native launch report for the current process. It returns the same public result type used by onNotifyAppReady:

type NotifyAppReadyResult =
  | { status: "UNCHANGED" }
  | {
      status: "UPDATE_APPLIED";
      fromBundleId: string;
      toBundleId: string;
      fromReleaseId?: string;
      toReleaseId?: string;
    }
  | {
      status: "RECOVERED";
      fromBundleId: string;
      toBundleId: string;
      fromReleaseId?: string;
      toReleaseId?: string;
    };

notifyAppReady(): NotifyAppReadyResult

The package exports NotifyAppReadyResult for your own callback types.

The result describes the launch of the current process. A Bundle downloaded later in the session does not change it; the next launch applies that Bundle and reports it.

Bundle fields identify artifacts. Use the optional Release fields when correlating a transition with the public update ID in the Console. See getActiveUpdateState for the selection and artifact distinction.

Read directly for diagnostics

const result = hotUpdater.notifyAppReady();

if (result.status === "RECOVERED") {
  console.log("Failed artifact:", result.fromBundleId);
  console.log("Recovered to:", result.toBundleId);
}

A direct call reads local state. It does not complete launch verification, reload the app, or call plugin hooks. Before native verification finishes, a direct read can return UNCHANGED; use onNotifyAppReady for the completed launch result.

The callback reports native state with or without the Insights plugin. It is not an acknowledgment that the server received a report. See Insights verification to confirm server receipt, and automatic rollback for recovery behavior.