node package manager

bundle

bundle

bundle generates html files from views and gzips the result, creating a bundle.

Usage

var Bundle = require('bundle');

// define a bundle
var bundle = Bundle.createBundle({
  views: 'views/bundles/teacher/'
});

// add a file to our bundle
bundle.file('index', function (id, render) {
  UserModel.findById(id, function (err, user) {
    render('index.jade', { name: name });
  })
});

// other into custom folder
bundle.file('misc/students', function (id, render) {
  // will create a students.html file into a misc/ folder
});

// create one using a layout
bundle.file('main', { layout: 'layout.jade' }, function (id, render) {
});

// add file passing html as parameter
teacher.file('list', '<ul><li>apple</li><li>orange</li><li>banana</li></ul>');

// generate a bundle
app.get('/generate-bundle-example/:id', function (req, req, next) {
  teacher.generate(req.param('id'), function (zip) {
      knox.upload(zip, function (err, url) {
        res.send('Download your bundle here: ' + url);
      });
  });
});

API

createBundle

features

  • supports layout and partials

Options

  • views: directory where template files are located
  • gzip: gzip command (defaults to 'zip')
  • 'view engine': defaults to 'jade'
  • extension: defaults to 'html'

Authors

License

(The MIT License)

Copyright(c) 2011 LearnBoost damian@learnboost.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.