Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/doowb/vinyl-changes-stream
Create a changes stream from couchdb and turn docs into Vinyl objects.
https://github.com/doowb/vinyl-changes-stream
changes-stream couchdb gulp gulp-plugin vinyl
Last synced: 25 days ago
JSON representation
Create a changes stream from couchdb and turn docs into Vinyl objects.
- Host: GitHub
- URL: https://github.com/doowb/vinyl-changes-stream
- Owner: doowb
- License: mit
- Created: 2017-03-03T00:38:05.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-03-03T01:00:00.000Z (almost 8 years ago)
- Last Synced: 2024-12-16T22:58:09.821Z (about 2 months ago)
- Topics: changes-stream, couchdb, gulp, gulp-plugin, vinyl
- Language: JavaScript
- Homepage: https://github.com/doowb/vinyl-changes-stream
- Size: 14.6 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# vinyl-changes-stream [](https://www.npmjs.com/package/vinyl-changes-stream) [](https://npmjs.org/package/vinyl-changes-stream) [](https://npmjs.org/package/vinyl-changes-stream) [](https://travis-ci.org/doowb/vinyl-changes-stream)
> Create a changes stream from couchdb and turn docs into Vinyl objects.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save vinyl-changes-stream
```
## Usage
```js
var changes = require('vinyl-changes-stream');
```
## API
### [changes](index.js#L37)
Create a stream of [vinyl](https://github.com/gulpjs/vinyl) files from a couchdb changes stream provided by [changes-stream](https://github.com/jcrugzz/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](https://github.com/jcrugzz/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**
```js
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](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
```sh
$ npm install && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](https://twitter.com/doowb)
### License
Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on March 02, 2017._