Novice, Practiced, Mastered

    assemble-streams

    1.0.1 • Public • Published

    assemble-streams NPM version NPM monthly downloads NPM total downloads Linux Build Status

    Assemble pipeline plugin for pushing views into a vinyl stream.

    Install

    Install with npm:

    $ npm install --save assemble-streams

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

    About

    Related projects

    Contributing

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

    Contributors

    Commits Contributor
    34 jonschlinkert
    21 doowb

    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

    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:

    $ npm install && npm test

    Author

    Jon Schlinkert

    License

    Copyright © 2017, Jon Schlinkert. MIT


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

    Install

    npm i assemble-streams

    DownloadsWeekly Downloads

    25,589

    Version

    1.0.1

    License

    MIT

    Last publish

    Collaborators

    • doowb
    • jonschlinkert