/meteor-app-update

Primary LanguageJavaScriptMIT LicenseMIT

App Update for Meteor Build Status

Control Meteor Hotcode push and gracefully notify the user of an update.

Need Help? Gitter chat

Current Version

v1.0.6

Configuration

App Update uses the Meteor.settings.public.env variable to decide whether or not to intercept app updates.

The package uses the following env strings. production, test, or development

Exmaple settings.json file:

{
  "public": {
    "env": "production"
   }
}

Before initializing you can set any of the following settings (client only):

  • AppUpdate.reload.settings.enabled: true or false
  • AppUpdate.reload.settings.environments.development: true or false
  • AppUpdate.reload.settings.environments.test: true or false
  • AppUpdate.reload.settings.environments.production: true or false

Usage

To initialize the AppUpdate package in the Meteor app, call the preventReload() function. It is recommended to call this from the lib folder in the app.

AppUpdate.reload.preventReload().

To prevent refreshing in a development environment:

if(Meteor.isClient) {
  AppUpdate.reload.settings.environments.development = true;
  AppUpdate.reload.preventReload();
}

To notify the user when a new app update is available, simply add the template to your page:

{{> appUpdatePrompt}}

Attribution and Acknowledgements

This package was inspired by the Meteor Package (internal to the WebApp package):

https://github.com/meteor/mobile-packages/tree/master/packages/mdg:reload-on-resume

License

MIT - Copyright (c) 2015 Ars Nebula