es6-template

Easy and small template engine for the browser and nodejs.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
es6-template
1.0.48 years ago9 years agoMinified + gzip package size for es6-template in KB

Readme

Easy and small template engine for the browser and nodejs.

!code climatecodeclimate-imgcodeclimate-url !standard code stylestandard-imgstandard-url !travis build statustravis-imgtravis-url !coverage statuscoveralls-imgcoveralls-url !dependency statusdavid-imgdavid-url

Install

npm i es6-template --save

Usage

For more use-cases see the tests

var es6template = require('es6-template')

es6template

Acts like .render by default. Renders given str with locals.

  • str {String} template to populate with locals
  • locals {Object} locals object
  • return {String} rendered string

Example
es6template('foo ${bar} baz ${quux}', {bar: 'BAR'}, {quux: 'QUUX'})
//=> 'foo BAR baz QUUX'

.render

Renders given str with locals. You can give unlimited number of object
arguments after the first - they will be merged and passed as single locals object.
  • str {String} template to populate with locals
  • locals {Object} locals object
  • return {String} rendered string

Example
es6template.render('Hello ${place} and ${user.name}!', {
  place: 'world',
  user: {
    name: 'Charlike'
  }
})
//=> 'Hello world and Charlike!'

.compile

Compiles given string and returns function which accepts
unlimited number of locals object arguments.
  • str {String} template to populate
  • return {Function} which accepts locals objects

Example
var fn = es6template.compile('Hello ${place} and ${user.name}!')
fn({place: 'world', user: {name: 'Charlike'}})
//=> 'Hello world and Charlike!'

Related

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
But before doing anything, please read the CONTRIBUTING.md guidelines.

Charlike Make Reagent !new message to charlikenew-message-imgnew-message-url !freenode #charlikefreenode-imgfreenode-url

!tunnckocore.tkauthor-www-imgauthor-www-url !keybase tunnckocorekeybase-imgkeybase-url !tunnckoCore npmauthor-npm-imgauthor-npm-url !tunnckoCore twitterauthor-twitter-imgauthor-twitter-url !tunnckoCore githubauthor-github-imgauthor-github-url