Giter VIP home page Giter VIP logo

assemble-streams's Introduction

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(streams());

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

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

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

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.

assemble-streams's People

Contributors

doowb avatar enavarrocu avatar jonschlinkert avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Forkers

enavarrocu

assemble-streams's Issues

matchers for second argument

Currently, .toStream takes a filter function as the second argument. We can easily turn this into a matcher using micromatch.isMatch, which takes a function, regex or glob.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.