npm-updates

KO | EN

gitlite — search

#react #ai #llm #go #machine-learning #rust #deep-learning #java #awesome #awesome-list #vue #pytorch #ios #openai

(★ 17)

Emits update events from the npm repository.

npm-updates Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# npm-updates

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

[![Dependency Status](https://david-dm.org/fent/npm-updates.svg)](https://david-dm.org/fent/npm-updates)
[![codecov](https://codecov.io/gh/fent/npm-updates/branch/master/graph/badge.svg)](https://codecov.io/gh/fent/npm-updates)

# Usage

```js
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.

```js
{ 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](https://mochajs.org)

```bash
npm test
```

npm-updates

npm-updates Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

npm-updates

npm-updates Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README