nu

npm-updates

Emits update events from the npm repository.

Showing:

Popularity

Downloads/wk

1

GitHub Stars

16

Maintenance

Last Commit

1yr ago

Contributors

6

Package

Dependencies

2

Size (min+gzip)

194.1KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

npm-updates

Emits update events from the npm repository, or any node modules repository.

Dependency Status codecov

Usage

const NPM = require('npm-updates');
const npm = new NPM();

npm.on('update', (info) => {
  console.log('package', info.name, 'was updated to v' + info.version);
});

npm.on('new', (info) => {
  console.log('new module!', info.name);
});

API

new NPM([options])

Creates a new instance. options can have

  • autoStart - Defaults to true. Will auto start requesting the registry for updates. If disabled, you can use start().
  • uri - You can set the couchdb registry uri that it checks with this.

NPM#start()

Starts receiving updates.

NPM#stop()

Stops requesting updates and emitting events.

Event: 'change'

  • Object

Change events from the couchdb _changes feed.

{ seq: 99230,
  id: 'newsemitter',
  changes: [ { rev: '5-aca7782ab6beeaef30c36b888f817d2e' } ] }

Event: 'new'

  • Object - Info.

First version of module published. info is equivalent to its package.json contents.

Event: 'update'

  • Object - Info.

    Module is updated to a newer version. info is equivalent to its package.json contents.

Event: 'publish'

  • Object - Info.

Emitted for both new and update events. info is equivalent to its package.json contents.

Event: 'delete'

  • string - Name.

Module was deleted from the registry.

Install

npm install npm-updates

Tests

Tests are written with mocha

npm test

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial