{"id":15043852,"url":"https://github.com/davidwinter/electron-auto-update","last_synced_at":"2025-04-15T00:44:53.541Z","repository":{"id":37498965,"uuid":"307144320","full_name":"davidwinter/electron-auto-update","owner":"davidwinter","description":"user friendly electron auto updates","archived":false,"fork":false,"pushed_at":"2023-04-05T16:58:49.000Z","size":78,"stargazers_count":4,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T00:44:35.631Z","etag":null,"topics":["electron","electronjs"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/davidwinter.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["davidwinter"]}},"created_at":"2020-10-25T16:42:46.000Z","updated_at":"2023-01-31T18:34:16.000Z","dependencies_parsed_at":"2024-09-25T02:02:06.259Z","dependency_job_id":null,"html_url":"https://github.com/davidwinter/electron-auto-update","commit_stats":{"total_commits":34,"total_committers":2,"mean_commits":17.0,"dds":0.05882352941176472,"last_synced_commit":"a7da4f61a2057bf0a65b25a1bcd3a6391dfe3c2b"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidwinter%2Felectron-auto-update","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidwinter%2Felectron-auto-update/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidwinter%2Felectron-auto-update/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/davidwinter%2Felectron-auto-update/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/davidwinter","download_url":"https://codeload.github.com/davidwinter/electron-auto-update/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248986274,"owners_count":21194024,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["electron","electronjs"],"created_at":"2024-09-24T20:49:42.596Z","updated_at":"2025-04-15T00:44:53.520Z","avatar_url":"https://github.com/davidwinter.png","language":"JavaScript","readme":"# electron-auto-update\n\n[![test](https://github.com/davidwinter/electron-auto-update/workflows/Node.js%20CI/badge.svg)](https://github.com/davidwinter/electron-auto-update/actions?query=workflow%3ANode.js%20CI) [![npm](https://img.shields.io/npm/v/electron-auto-update)](https://www.npmjs.com/package/electron-auto-update) [![npm](https://img.shields.io/npm/dw/electron-auto-update)](https://www.npmjs.com/package/electron-auto-update)\n\n\u003e A user friendly way of having your Electron apps auto-update\n\n![electron-auto-update screenshot](https://github.com/davidwinter/electron-auto-update/raw/main/screenshot.png)\n\nThis package builds upon the great work done by `electron-builder` and `electron-updater`, both of which make it really easy for you to package and publish your Electron apps. The latter package works wonders for handling the internals of auto-updating your application.\n\n`electron-auto-update` aims to make the process of auto-updating a little more user-friendly, by presenting a dialog box when an update has been downloaded and is ready to be installed, which happens upon relaunch of the application. It will also check for updates on a regular frequency.\n\n## Features\n\n- Checks for updates at a regular interval (defaults to each hour)\n- Automatically downloads updates as they become available\n- Displays a dialog window and prompts the user to relaunch to update\n- Reminds users that an update is ready to be installed\n\n## Coming soon\n\n- Works with applications installed via snapcraft\n\n## Usage\n\n**Your project should already be using `electron-builder` to package and publish your application. Ensure you have the `publish` [configuration setup](https://www.electron.build/configuration/publish) in your `package.json` file as `electron-auto-update` will use that configuration for detecting new versions available for update.**\n\n\n```js\nconst {autoUpdate} = require('electron-auto-update');\n\nautoUpdate();\n```\n\nIf you would like to manually trigger an update check, for example, via a menu bar in a scenario where the user has chosen not to receive future notifications, then you can use the `triggerUpdateCheck()` method like so:\n\n```js\nconst {autoUpdate} = require('electron-auto-update');\n\n// Assign the updater to a variable that you can call manually\nconst updater = autoUpdate();\n\n// Call at some point later:\nupdater.triggerUpdateCheck();\n```\n\n## API\n\n### autoUpdate(options?)\n\nWill setup a regular check for updates using any additonal options specified.\n\n#### options\n\nType: `object`\n\n##### checkFrequency\n\nType: `integer`\\\nDefault: `3600000`\n\nThe frequency in milliseconds to check for updates. Defaults to 1 hour.\n\n## Development\n\n```\nnpm install\nnpm test\nnp\n```\n","funding_links":["https://github.com/sponsors/davidwinter"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidwinter%2Felectron-auto-update","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavidwinter%2Felectron-auto-update","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavidwinter%2Felectron-auto-update/lists"}