1 | latest
|
2 | ======
|
3 |
|
4 | Quickly determine the latest available version of a package in [npm](http://npmjs.org)
|
5 |
|
6 | Useful for command line tools that want to check for available upgrades
|
7 |
|
8 | Example
|
9 | -------
|
10 |
|
11 | Get the latest version number of `autocast`
|
12 |
|
13 | ``` js
|
14 | var latest = require('latest');
|
15 |
|
16 | latest('autocast', function(err, v) {
|
17 | console.log(v);
|
18 | });
|
19 | ```
|
20 | yields
|
21 | ```
|
22 | 0.0.3
|
23 | ```
|
24 |
|
25 | Errors passed directly from npm
|
26 |
|
27 | ``` js
|
28 | var latest = require('latest');
|
29 |
|
30 | latest('i-hope-this-package-never-exists', function(err, v) {
|
31 | if (err) console.error(err.message);
|
32 | });
|
33 | ```
|
34 | yields
|
35 | ```
|
36 | 404 Not Found: i-hope-this-package-never-exists
|
37 | ```
|
38 |
|
39 | ### Convenience Function
|
40 |
|
41 | Check for upgrades in an app
|
42 |
|
43 | ``` js
|
44 | var latest = require('latest');
|
45 | var p = require('./package.json');
|
46 |
|
47 | latest.checkupdate(p, function(ret, message) {
|
48 | console.log(message);
|
49 | process.exit(ret);
|
50 | });
|
51 | ```
|
52 |
|
53 | #### checkupdate(package-json-obj, cb(ret, message))
|
54 |
|
55 | A convenience method that will check for newer versions of a module in npm given a
|
56 | `package.json` object as the first argument.
|
57 |
|
58 | The callback fires with a return code suitable for exiting with, and a message to print
|
59 |
|
60 | Install
|
61 | ------
|
62 |
|
63 | npm install latest
|
64 |
|
65 | Tests
|
66 | -----
|
67 |
|
68 | npm test
|
69 |
|
70 | License
|
71 | -------
|
72 |
|
73 | MIT Licensed
|