Template engine for nodejs
Clone or download
dbrain Merge pull request #15 from diversemix/patch-1
Add the require statement for sys.
Latest commit 73f21ae Apr 13, 2015
Type Name Latest commit message Commit time
Failed to load latest commit information.
LICENSE As of this commit, jazz is under the MIT license to better align with… Sep 11, 2010


Jazz is a simple template engine built specifically for nodejs.


var jazz = require("jazz");
var sys = require("sys");

var template = jazz.compile("my template source code {someVariable}");
template.eval({"someVariable": "lolmuffin"}, function(data) { sys.puts(data); });

This example would output the following:

my template source code lolmuffin


Printing variables


This works for any type of expression, so the following should also work:

{a eq b}

Filter functions

You can call filter functions like so:

{someFilter(arg1, arg2)}

Filter functions are statements, NOT expressions so they cannot be chained nor used in if/forelse/etc. tests. However, calls can be made on any type of expression -- e.g.


Implementing filter functions

Filter functions may block so rather than returning the value you want rendered as you might in other frameworks, jazz passes in a callback to your filter function that you then call to indicate that you have a result. e.g. here we simulate a blocking operation using setTimeout().

// sum.jazz

{sum(5, 10)}

// sum.js

var jazz = require("jazz");

var params = {
    sum: function(arg1, arg2, cb) {
        setTimeout(function() {
            cb((arg1 + arg2).toString());
        }, 2000);
jazz.compile("sum.jazz").eval(params, function(output) { console.log(output); });

Note that even though the execution of the callback is delayed, this example still works.

Conditional Statements

You can check if a variable evaluates to a true value like so:

{if name}
    Hello, {name}

Else clauses are also supported:

{if name}
    Hello, {name}
    Hello, Captain Anonymous

As are else..if clauses:

{if firstName}
    Hello, {firstName}
{elif lastName}
    Hello, Mr. {lastName}
    Hello, Captain Anonymous

Limited logical expressions are also possible:

{if user.lastName and user.isVip}
    Hello, Mr. {user.lastName}, my good man!

{if fred.tired or fred.bored}
    Fred: "Yawn!"

{if not awake}

eq & neq comparison operators are available for comparing two values:

{if config.feature eq "enabled"}
    Feature is enabled!

{if status neq "inactive"}

You can also group expressions using parentheses:

{if (a and b) or c}

Looping over an array

{foreach item in someArray}

The value being iterated over can be any expression supporting an Array-like interface.

Looping over an object

{foreach pair in someObject}
    <p>{pair.key} = {pair.value}</p>

Synchronous functions

{if @blah('a')}
    <p>There were so many blahs in a</p>

The function is provided to the template the same way asynchronous functions are, just with a return instead of a cb.

Loop counters / index

{foreach pair in someObject}
    <p>Loop number (1 based): {__count}</p>
    <p>Index (0 based): {__index}</p>
    <p>{pair.key} = {pair.value}</p>

Looking into arrays/objects