To help you get started, we've collected the most common ways that string-template is being used within popular public projects.

Raynos / http-framework / examples / mvc / features / user / index.js View on Github

// to enable using sub routes in our controller we create
    // a new router. This router is a ChildRouter and will delegate
    // all error and 404 handler to it's parent. i.e. the global
    // application
    var controller = Router({ prefix: prefix })

    // We instantiate our model here with the database configuration
    // the model is local to this user feature
    var model = UserModel(config.db)
    
    // we set up configuration to pass to our views.
    // we also set up an urlMap so that views are not hard coded
    // to specific paths
    var viewsConfig = { layout: config.layout, urlMap: {
        "user": format.bind(null, prefix + "/{userId}"),
        "userEdit": format.bind(null, prefix + "/{userId}/edit"),
        "userPet": format.bind(null, prefix + "/{userId}/pet"),
        "pet": format.bind(null, config.features.pet + "/{petId}")
    } }

    // optionally /. so its /user & /user/
    controller.addRoute("/?", function (req, res, opts, cb) {
        model.getAll(function (err, users) {
            if (err) {
                return cb(err)
            }

            sendHtml(req, res, usersPage(users, viewsConfig))
        })
    })

View more ways to use string-template

string-template

A simple string template function based on named or indexed arguments

Example

var format = require("string-template")
var greeting

// Format using an object hash with keys matching [0-9a-zA-Z]+

greeting = format("Hello {name}, you have {count} unread messages", {
    name: "Robert",
    count: 12
})
// greeting -> "Hello Robert, you have 12 unread messages"


// Format using a number indexed array

greeting = format("Hello {0}, you have {1} unread messages", ["Robert", 12])
// greeting -> "Hello Robert, you have 12 unread messages"


// Format using optional arguments

greeting = format("Hello {0}, you have {1} unread messages",
     "Robert",
     12)
// greeting -> "Hello Robert, you have 12 unread messages"


// Escape {} pairs by using double {{}}

var text = format("{{0}}")
// text -> "{0}"

Compiling templates

string-template exposes two template compiling options for when you need the additional performance. Arguments passed to the compiled template are of the same structure as the main string-template function, so either a single object/array or a list of arguments.

var compile = require("string-template/compile")

var greetingTemplate = compile("Hello {0}, you have {1} unread messages")

var greeting = greetingTemplate("Robert", 12)
// -> "Hello Robert, you have 12 unread messages"

Passing a truthy second argument to compile will opt into using new Function to generate a function. The function returned contains a literal string concatenation statement, interleaving the correct arguments you have passed in.

var compile = require("string-template/compile")

var greetingTemplate = compile("Hello {0}, you have {1} unread messages", true)
// -> greetingTemplate generated using new Function

var greeting = greetingTemplate(["Robert", 12])
// -> "Hello Robert, you have 12 unread messages"

Installation

npm install string-template

Contributors

• Matt-Esch

MIT Licenced