@loopx/template

Simple micro templating

Usage no npm install needed!

<script type="module">
  import loopxTemplate from 'https://cdn.skypack.dev/@loopx/template';
</script>

README

@loopx/template

Simple micro templating

Useful when all you need is to fill in some placeholders.

Install

$ npm install @loopx/template

Usage

const {t} = require('@loopx/template');

t('The mobile number of {name} is {phone.mobile}', {
  name: 'Sindre',
  phone: {
    mobile: '609 24 363',
  },
});
//=> 'The mobile number of Sindre is 609 24 363'

t('I like {0} and {1}', ['🦄', '🐮']);
//=> 'I like 🦄 and 🐮'

// Double braces encodes the HTML entities to avoid code injection
t('I like {{0}} and {{1}}', ['<br>🦄</br>', '<i>🐮</i>']);
//=> 'I like &lt;br&gt;🦄&lt;/br&gt; and &lt;i&gt;🐮&lt;/i&gt;'

API

t(template, data) or template(template, data)

template

Type: string

Text with placeholders for data properties.

data

Type: object | unknown[]

Data to interpolate into template.

FAQ

What about template literals?

Template literals expand on creation. This module expands the template on execution, which can be useful if either or both template and data are lazily created or user-supplied.

Related

  • pupa - Simple micro templating
  • pupa-cli - CLI for this module