2019-09-04 14:27:42 +00:00
|
|
|
# @pushrocks/smartupdate
|
2017-08-15 17:29:18 +00:00
|
|
|
update your tools in a smart way
|
|
|
|
|
|
2019-09-04 14:27:42 +00:00
|
|
|
## Availabililty and Links
|
|
|
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartupdate)
|
|
|
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartupdate)
|
|
|
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartupdate)
|
|
|
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartupdate/)
|
2017-08-15 17:29:18 +00:00
|
|
|
|
|
|
|
|
## Status for master
|
2019-09-04 14:27:42 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartupdate/commits/master)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartupdate/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/@pushrocks/smartupdate)
|
|
|
|
|
[](https://snyk.io/test/npm/@pushrocks/smartupdate)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://prettier.io/)
|
2017-08-15 17:29:18 +00:00
|
|
|
|
|
|
|
|
## Usage
|
2018-05-22 13:49:26 +00:00
|
|
|
|
2017-08-15 17:29:18 +00:00
|
|
|
Use TypeScript for best in class instellisense.
|
|
|
|
|
|
2018-02-14 22:19:36 +00:00
|
|
|
smartupdate makes it really easy to notify your tool users about new versions:
|
|
|
|
|
|
|
|
|
|
```typescript
|
|
|
|
|
import * as smartupdate from 'smartupdate';
|
|
|
|
|
|
|
|
|
|
// the following command will check npm for a version newer than the specified one.
|
|
|
|
|
// It will open the specified URL if a newer version is actually found.
|
2018-05-22 13:49:26 +00:00
|
|
|
await smartupdate.standardHandler.check(
|
|
|
|
|
'lodash',
|
|
|
|
|
'1.0.5',
|
|
|
|
|
'http://gitzone.gitlab.io/npmts/changelog.html'
|
|
|
|
|
);
|
2018-02-14 22:19:36 +00:00
|
|
|
```
|
|
|
|
|
|
2017-08-15 17:29:18 +00:00
|
|
|
For further information read the linked docs at the top of this README.
|
|
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
2018-05-22 13:49:26 +00:00
|
|
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
2017-08-15 17:29:18 +00:00
|
|
|
|
|
|
|
|
[](https://push.rocks)
|
2019-09-04 14:27:42 +00:00
|
|
|
|
|
|
|
|
For further information read the linked docs at the top of this readme.
|
|
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
|
|
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
|
|
|
|
|
|
|
|
|
[](https://maintainedby.lossless.com)
|
