1.0.1 • Published 4 years ago
simplater v1.0.1
Simplater
Fast, minimalistic, logic-less string templating libray inspired by mustache.
Features: 1. Pure string substitution only. Avoids this. 2. Pure JS & Zero dependencies
Template
Anything surrounded by double braces will be treated as a variable and substituted.
eg. {{ param }}
Example
const simplater = require('simplater')
const myTemplate = 'The quick {{colour}} fox jumps over the lazy dog'
console.log(simplater.render(myTemplate, { colour: 'brown' }))
// Output
// The quick brown fox jumps over the lazy dog
API
render function can take three params
render (template, params, defaultValue)
where,
template
= template string (if passed value is not a string, null will be returned)
params
= object containing different params & its corresponding values
defaultValue
(optional) = the value to substitute if a particular param in template string is not found in params object passed. If not specified, it defaults to a blank string ''
Notes
- Spaces inside double curly braces are ignored while substituting. eg.
{{colour}}
,{{ colour}}
,{{ colour }}
will be treated same - Nesting is not supported. If by mistake nested values are passed, only innermost value shall be substituted.
{{ {{ colour }}}}
will be rendered to{{ brown}}
(a quick hack to support this case is to call render again).