Is there an official documentation of Reload._onMigrate()?

martijnwalraven · January 24, 2016, 2:30pm

Reload._onMigrate() is a private API that other packages use to register their interest in participating in a reload. That means they can pass on data to migrate to the new version, but they can also delay the reload until they are ready. It can also be used to disable automatic reloads, by simply returning [false] and never calling the retry callback.

For an example of delaying a reload and controlling when it happens, see the reload-on-resume package:

github.com

meteor/mobile-packages/blob/master/packages/mdg:reload-on-resume/reload-on-resume.js

var newVersionAvailable = new ReactiveVar(false);

var hasResumed = false;
document.addEventListener("resume", function () {
  hasResumed = true;
}, false);

Reload._onMigrate(function (retry) {
  newVersionAvailable.set(true);

  if (hasResumed) {
    return [true, {}];
  } else {
    document.addEventListener("resume", retry, false);
    return [false];
  }
});

/**
 * @summary Reactive function that returns true when there is a new version of

This file has been truncated. show original

Note that this only affects when a reload happens. For Cordova, it is only called after HCP has already downloaded the new version. So if the app gets killed an restarts, it will always use the new version immediately and there will be no opportunity to warn the user.