vvo / package-stream

An endless stream of clean package data from the npm registry.

package-stream

An endless stream of clean package data from the npm registry.

See also all-the-packages, a similar package designed for offline use.

Installation

npm install package-stream --save

Usage

The stream is an event emitter that emits two events: pkg and up-to-date. The up-to-date event is emitted when the stream reaches the end of all existing packages, but unlike typical read streams, this stream has no end event. It remains open indefinitely, emitting package events as new package versions are published to the npm registry in real time.

var registry = require('package-stream')()

registry
  .on('package', function (pkg) {
    // nice clean package object
  })
  .on('up-to-date', function () {
    // consumed all changes (for now)
    // The stream will remain open and continue receiving package
    // updates from the registry as they occur in real time.
  })

Options

The changes-stream package is used under the hood, and all of its options are supported by package-stream. The default options used by package-stream are:

{
  db: 'https://skimdb.npmjs.com/registry',
  include_docs: true
}

The options you provide are merged with the defaults above.

Convenience Methods

Each package instance has convenience methods like pkg.dependsOn(pkgName) and pkg.mentions(query). To see the full list, check out the nice-package documentation.

Tests

npm install
npm test

Dependencies

• changes-stream: Simple module that handles getting changes from couchdb
• got: Simplified HTTP requests
• nice-package: Clean up messy package metadata from the npm registry

Dev Dependencies

• tap-spec: Formatted TAP output like Mocha's spec reporter
• tape: tap-producing test harness for node and browsers

License

MIT

Generated by package-json-to-readme