node package manager

vinyl-changes-stream

vinyl-changes-stream NPM version NPM monthly downloads NPM total downloads Linux Build Status

Create a changes stream from couchdb and turn docs into Vinyl objects.

Install

Install with npm:

$ npm install --save vinyl-changes-stream

Usage

var changes = require('vinyl-changes-stream');

API

changes

Create a stream of vinyl files from a couchdb changes stream provided by changes-stream. Files contain a stringified change object on file.contents and the raw JSON object on file.json. file.id and file.seq are also populated with the .id and .seq from the change object.

Params

  • options {Object|String}: Options object for passing additional options to changes-stream. If passed a string, that will be used for the db.
  • options.db {String}: The couchdb database to get changes from.
  • options.since {Number}: Optionally specify the seq id to start from. This seq id will not be included in the stream.
  • options.limit {Number}: Optionally specify a limit to how many changes are returned. Once the limit has been met, the stream will end.
  • returns {Stream}: Returns a stream to be used in a pipeline

Events

  • emits: current When the stream has caught up to the current seq, the seq will be emitted.

Example

changes('https://skimdb.npmjs.com/registry')
 .on('current', function(seq) {
   console.log('caught up to the current update', seq);
 })
 .pipe(through.obj(function(file, enc, next) {
   console.log(file.seq, file.id);
   //=> 123456 'some-package-name' 
   next(null, file);
 }));

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Install dev dependencies:

$ npm install && npm test

Author

Brian Woodward

License

Copyright © 2017, Brian Woodward. MIT


This file was generated by verb-generate-readme, v0.4.2, on March 02, 2017.