string-template

What is string-template?

The string-template npm package allows you to easily create and manipulate string templates. It provides a simple way to replace placeholders in a string with actual values, making it useful for generating dynamic content.

What are string-template's main functionalities?

Basic Template Replacement

This feature allows you to replace placeholders in a string with corresponding values from an object. In this example, the placeholder {name} is replaced with 'World'.

const template = require('string-template');
const result = template('Hello, {name}!', { name: 'World' });
console.log(result); // Output: Hello, World!

Multiple Placeholders

You can use multiple placeholders in a single string and replace them with values from an object. This example replaces {firstName} and {lastName} with 'John' and 'Doe' respectively.

const template = require('string-template');
const result = template('Hello, {firstName} {lastName}!', { firstName: 'John', lastName: 'Doe' });
console.log(result); // Output: Hello, John Doe!

Nested Object Replacement

The package supports nested object replacement, allowing you to access properties within nested objects. In this example, {user.name} is replaced with 'Alice'.

const template = require('string-template');
const result = template('Hello, {user.name}!', { user: { name: 'Alice' } });
console.log(result); // Output: Hello, Alice!

Other packages similar to string-template

mustache

Mustache is a logic-less template syntax. It is a popular templating engine that allows you to create templates with placeholders and replace them with actual values. Unlike string-template, Mustache supports more complex templating features such as loops and conditionals.

handlebars

Handlebars is an extension of Mustache and provides a more powerful templating engine. It supports advanced features like helpers and partials, making it more suitable for complex templating needs compared to string-template.

lodash.template

Lodash's template function is part of the Lodash utility library. It provides a way to create compiled template functions that can interpolate data properties in 'interpolate' delimiters. It offers more flexibility and power compared to string-template, especially when used within the broader context of Lodash's utility functions.

README

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