Nearly Perfect Mediocracy

    electron-update-notifier
    TypeScript icon, indicating that this package has built-in type declarations

    1.6.0 • Public • Published

    Electron App Update Notifier

    downloads npm-version github-tag license install size build ts

    Notify user about new app updates by fetching release from Github repository.

    screenshot

    Motivation

    update-electron-app is an auto updating solution for open source Electron apps. It is awesome but has some limitations:

    • It does not support Linux currently
    • Applications on macOS must be signed in order to work.

    This package comes to help in these cases. Instead of downloading installer automatically, it simply notifies user to go to GitHub release page when updates available.

    Installation

    yarn add electron-update-notifier
    # OR
    npm install electron-update-notifier

    Usage

    Auto check for updates on app start

    const {app} = require('electron');
    const {setUpdateNotification} = require('electron-update-notifier');
    
    app.whenReady().then(() => {
        setUpdateNotification({
            repository: 'user/repo', // Optional, use repository field from your package.json when not specified
            token: '', // Optional, GitHub api access token
            debug: false, // Optional, default `false`, allows to check for updates during development as well
            silent: true // Optional, notify when new version available, otherwise remain silent 
        })
    })

    Check for updates manually

    const {checkForUpdates} = require('electron-update-notifier');
    
    checkForUpdates({
        // options 
        silent: false, // Warn about network failures and notify when there is no updates
    })

    Use it with update-electron-app:

    switch (process.platform) {
        case 'darwin':
        case 'win32':
            require('update-electron-app')()
            break
        default:
            require('electron-update-notifier').setUpdateNotification({
                // options
            })
    }

    Acknowledgements

    @pd4d10 for original work

    License

    MIT License

    Install

    npm i electron-update-notifier

    DownloadsWeekly Downloads

    30

    Version

    1.6.0

    License

    MIT

    Unpacked Size

    11.9 kB

    Total Files

    6

    Last publish

    Collaborators

    • ankurk91