Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bahamas10/node-latest

Quickly determine the latest available version of a package in npm
https://github.com/bahamas10/node-latest

Last synced: 2 months ago
JSON representation

Quickly determine the latest available version of a package in npm

Awesome Lists containing this project

README

        

latest
======

Quickly determine the latest available version of a package in [npm](http://npmjs.org)

Useful for command line tools that want to check for available upgrades

Example
-------

Get the latest version number of `autocast`

``` js
var latest = require('latest');

latest('autocast', function(err, v) {
console.log(v);
// => "0.0.3"
});
```

Errors passed directly from npm

``` js
var latest = require('latest');

latest('i-hope-this-package-never-exists', function(err, v) {
console.error(err.message);
// => "404 Not Found: i-hope-this-package-never-exists"
});
```

### Convenience Function

Check for upgrades in an app

``` js
var latest = require('latest');
var p = require('./package.json');

latest.checkupdate(p, function(ret, message) {
console.log(message);
// => "you are running the latest version 0.0.1"
process.exit(ret);
// => 0
});
```

#### checkupdate(package-json-obj, cb(ret, message))

A convenience method that will check for newer versions of a module in npm given a
`package.json` object as the first argument.

The callback fires with a return code suitable for exiting with, and a message to print

Command Line
------------

```
$ latest latest json npm notfound
latest: 0.1.2
json: 9.0.3
npm: 2.6.0
notfound: Error: 404 Not Found: notfound
```

Install
------

npm install [-g] latest

Tests
-----

npm test

License
-------

MIT Licensed