# check-update

> Check if there are a update

Latest version **0.0.8** (published 2015-04-08) · 0 weekly downloads

## Install

```sh
npm install check-update
pnpm add check-update
yarn add check-update
bun add check-update
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2015-04-08 |
| First published | 2014-12-30 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Cédric |
| Maintainers | cedced19 |
| Keywords | check, update, cli, npm, updater, checker, version, beta, alpha, omega, patch, fx, zero, final, release |

## Links

- npm: https://www.npmjs.com/package/check-update
- Repository: https://github.com/cedced19/check-update
- Issues: https://github.com/cedced19/check-update/issues
- npm.io page: https://npm.io/package/check-update

## Dependencies (3)

- [rc](https://npm.io/package/rc.md) ^0.5.4
- [got](https://npm.io/package/got.md) ^2.2.0
- [colors](https://npm.io/package/colors.md) ^1.0.3

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.0.8 (latest) — 2015-04-08
- 0.0.7 — 2015-02-21
- 0.0.6 — 2015-01-25
- 0.0.5 — 2015-01-02
- 0.0.3 — 2015-01-01
- 0.0.2 — 2014-12-31
- 0.0.1 — 2014-12-30

## README

# check-update 

[![Build Status](https://travis-ci.org/cedced19/check-update.svg?branch=master)](https://travis-ci.org/cedced19/check-update)
[![NPM version](https://badge.fury.io/js/check-update.svg)](http://badge.fury.io/js/check-update)


Check if there is an update.

![](https://raw.githubusercontent.com/cedced19/check-update/master/demo.png)

```bash
npm install --save check-update
```

## Example

```js
var checkUpdate = require('check-update');
var pkg = require('./package.json');

checkUpdate({packageName: pkg.name, packageVersion: pkg.version, isCLI: true}, function(err, latestVersion, defaultMessage){
    if(!err){
        console.log(defaultMessage);
    }
});
```

### Options

#### packageName

*Required*  
Type: `string`

Define the package name for search in NPM.

#### packageVersion

*Required if you want a default message*   
Type: `string`

Define the version currently installed.

#### isCLI
 
Type: `boolean`  
Default: `false`

Define if your package is a cli.

---
_Source: https://npm.io/package/check-update · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._