assemble-streams    

> Assemble pipeline plugin for pushing views into a vinyl stream.

Install

Install with npm:

``sh
$ npm install --save assemble-streams
`

Usage

This plugin can be used with assemble, verb or any other application based on templates.

`js
var assemble = require('assemble');
var streams = require('assemble-streams');

// create your application
var app = assemble();
// register the plugin
app.use(stream());

// use the plugin on app
app.toStream('pages')
.pipe(app.dest('site/'));

// use the plugin on a collection
app.pages.toStream()
.pipe(app.dest('site/'));

// use the plugin on a view
app.pages.getView('home').toStream()
.pipe(app.dest('site/'));
`

See the tests for more examples.

API

$3

Push a view collection into a vinyl stream.

Params

* collection {String}: Name of the collection to push into the stream.
* {Function}: Optionally pass a filter function to use for filtering views.
* returns {Stream}

Example

`js
app.toStream('posts', function(file) {
return file.path !== 'index.hbs';
})
`

$3

Push a view collection into a vinyl stream.

Params

* {Function}: Optionally pass a filter function to use for filtering views.
* returns {Stream}

Example

`js
app.posts.toStream(function(file) {
return file.path !== 'index.hbs';
})
`

$3

Push the current view into a vinyl stream.

* returns {Stream}

Example

`js
app.pages.getView('a.html').toStream()
.on('data', function(file) {
console.log(file);
//=> >
});
`

About

$3

* assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage for loading globs of views onto custom view collections. Also works with verb or other Templates.js based applications.")
* assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
* assemble: Get the rocks out of your socks! Assemble makes you fast at creating web projects… more | homepage

$3

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

$3

| Commits | Contributor |
| --- | --- |
| 34 | jonschlinkert |
| 21 | doowb |

$3

_(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:

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

$3

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

$3

Jon Schlinkert

* github/jonschlinkert
* twitter/jonschlinkert

$3

Copyright © 2017, Jon Schlinkert.
MIT

*

_This file was generated by verb-generate-readme, v0.4.2, on February 11, 2017._