3.9 KiB
assemble-streams 
Assemble pipeline plugin for pushing a view collection into a vinyl stream.
Install
Install with npm:
$ npm install assemble-streams --save
Usage
This plugin can be used with assemble, verb or any other application based on templates.
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
app.toStream
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
app.toStream('posts', function(file) {
return file.path !== 'index.hbs';
})
collection.toStream
Push a view collection into a vinyl stream.
Params
- {Function}: Optionally pass a filter function to use for filtering views.
returns{Stream}
Example
app.posts.toStream(function(file) {
return file.path !== 'index.hbs';
})
view.toStream
Push the current view into a vinyl stream.
returns{Stream}
Example
app.pages.getView('a.html').toStream()
.on('data', function(file) {
console.log(file);
//=> <Page "a.html" <Buffer 2e 2e 2e>>
});
Related projects
You might also be interested in these projects:
- assemble-loader: Assemble plugin (^0.6.0) for loading globs of views onto custom view collections. Also works with… more | homepage
- assemble-render-file: Assemble plugin for rendering views in a vinyl pipeline. | homepage
- assemble: Assemble is a powerful, extendable and easy to use static site generator for node.js. Used… more | homepage
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Building docs
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Running tests
Install dev dependencies:
$ npm install -d && npm test
Author
Jon Schlinkert
License
Copyright © 2016, Jon Schlinkert. Released under the MIT license.
This file was generated by verb, v0.9.0, on May 24, 2016.