express-compose

Version:

Engine agnostic helpers for express view rendering.

76 lines (68 loc) • 14.9 kB

HTML

<!DOCTYPE html> <html> <head> <title>compose.js</title> <meta http-equiv="content-type" content="text/html; charset=UTF-8"> <link rel="stylesheet" media="all" href="docco.css" /> </head> <body> <div id="container"> <div id="background"></div> <table cellpadding="0" cellspacing="0"> <thead> <tr> <th class="docs"> <h1> compose.js </h1> </th> <th class="code"> </th> </tr> </thead> <tbody> <tr id="section-1"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-1">¶</a> </div> </td> <td class="code"> <div class="highlight"><pre>if (typeof define !== 'function') { var define = require('amdefine')(module); } define(['underscore'], function(_) { var exports = {};</pre></div> </td> </tr> <tr id="section-2"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-2">¶</a> </div> Wraps a response in a object providing repeat and decorate methods. Wrapping allows to cleanly separate options of the module from the rendering options. </td> <td class="code"> <div class="highlight"><pre> var wrap = function(res, options) { return { repeat: function(template, opts, fn) { repeat(res, template, opts, fn); }, decorate: function(templates, opts, fn) { var defaults = _.extend({ compose: 'content', callback: false }, options); opts = _.extend({}, defaults, opts); decorate(res, templates, opts, fn); } }; };</pre></div> </td> </tr> <tr id="section-3"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-3">¶</a> </div> Renders a view multiple times, as long as options are available, and concatenates the results. </td> <td class="code"> <div class="highlight"><pre> function repeat(res, template, options, fn) { var next = _.bind(res.req.next, res.req), render = _.bind(res.render, res), buff = []; var nextCallback = function() { var opts = options.length ? options.shift() : false; return function(err, rendered) { if (err) return next(err); buff.push(rendered); if (opts) render(template, opts, nextCallback()); else { var content = buff.join(''); fn ? fn(null, content) : res.send(content); } }; }; _.isArray(options) || (options = [options]); var opts = options.shift(); var callback = nextCallback(); render(template, opts, callback); }</pre></div> </td> </tr> <tr id="section-4"> <td class="docs"> <div class="pilwrap"> <a class="pilcrow" href="#section-4">¶</a> </div> Decorate a view recursively. It passes the rendered stuff to the next template along with the original options until no templates are available. </td> <td class="code"> <div class="highlight"><pre> function decorate(res, templates, opts, fn) { var next = _.bind(res.req.next, res.req), render = _.bind(res.render, res), compose = opts.compose || 'content'; var nextCallback = function() { if (!templates.length) return fn; var template = templates.shift(); return function(err, rendered) { if (err) return next(err); var updatedOpts = _.clone(opts); updatedOpts[compose] = rendered; render(template, updatedOpts, nextCallback()); }; }; _.isArray(templates) || (templates = [templates]); var template = templates.shift(); var callback = nextCallback(); render(template, opts, callback); } return { repeat: repeat, decorate: decorate, wrap: wrap }; }); </pre></div> </td> </tr> </tbody> </table> </div> </body> </html>