https://github.com/harshjv/check-for-update
🔄 Check for update manually or at configured interval with minimum configuration.
https://github.com/harshjv/check-for-update
check-for-update checker github semver update
Last synced: about 1 month ago
JSON representation
🔄 Check for update manually or at configured interval with minimum configuration.
- Host: GitHub
- URL: https://github.com/harshjv/check-for-update
- Owner: harshjv
- License: mit
- Created: 2017-02-06T05:29:56.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-12T14:46:44.000Z (over 9 years ago)
- Last Synced: 2025-09-05T15:41:28.704Z (10 months ago)
- Topics: check-for-update, checker, github, semver, update
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/check-for-update
- Size: 6.84 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔄 Check For Update
> **Heads up!** This works ***only*** with **Github** repositories that follows **[semver](http://semver.org)**.
Check for update manually or at configured interval with minimum configuration.
## Installation
```
npm install check-for-update
```
## API
### cfu = new CheckForUpdate(config)
Create `CheckForUpdate` instance with provided configuration.
```js
{
packageJSON: Object, // package.json object (optional when repositoryURL and currentVersion is given)
repositoryURL: String, // Github repository URL (optional when packageJSON is given)
currentVersion: String, // Current version of software (optional when packageJSON is given)
checkOnLaunch: Boolean, // Check for update when object is initiated
intervalHrs: Number // Interval to check for update in hours
}
```
### cfu.now()
Manually check for update.
### cfu.start()
Start checking for update manually (or when `checkOnLaunch` is `false`).
### cfu.stop()
Stop update checker.
### cfu.on('update_available', ({ currentVersion, newVersion, repoURL, updateURL }) => {})
Emitted when a new version/update is available.
### cfu.on('error', (error) => {})
Emitted when client encounters an error.
## Usage
```js
const CheckForUpdate = require('check-for-update')
const cfu = new CheckForUpdate({
packageJSON: require('./package.json'),
checkOnLaunch: true,
intervalHrs: 12
})
// or
const cfu = new CheckForUpdate({
repositoryURL: 'harshjv/donut',
currentVersion: '1.2.3',
checkOnLaunch: true,
intervalHrs: 12
})
cfu.on('error', (data) => console.error(data))
cfu.on('update_available', (data) => {
const { currentVersion, newVersion, repoURL, updateURL } = data
// ...
})
```
## License
MIT