Package Exports

assemble-streams

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (assemble-streams) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

assemble-streams

Assemble plugin that adds convenience methods for working with streams, like toStream, which pushes a view collection into a vinyl stream.

Install

Install with npm

$ npm i 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
app.toStream('pages')
  .pipe(app.dest('site/'))

See the tests for more examples.

API

.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';
})

assemble: Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… more | homepage
assemble-loader: Assemble plugin (0.6+) 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

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

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

Author

Jon Schlinkert

License

This file was generated by verb-cli on October 16, 2015.