@novigi/template-engine

Zero dependency stand-alone general purpose template engine for super fast templating 🛠

🐿 Features

• Supports nested obejects → '${deeply.nested.objects.are.supported}'
• Reusable templates → you can have the template in a varable!
• lightweight, error free and super fast templating
• Javascript template literals style

📦 Getting Started

1. Install the dependency

npm install @novigi/template-engine

2. Import the library

const lib = require('@novigi/template-engine');

📖 Documentation

template

Templates enable fast rendering of the server-side data that needs to be passed to the application.The template engine replaces the variables in a template file with actual values, and displays this value to the client. This makes it easier to quickly build our application. This is the guideline of compile-time text rendering capability.

const { template } = require('@novigi/template-engine')

template.render('We are from ${city}!', {city: 'Colombo'})  // We are from Colombo
// or simply
'We are from ${city}!'.render({city: 'Colombo'})            // We are from Colombo

• template
  • static
    • .render(templatedText, context) ⇒ string
  • inner
    • ~String
      • .render(context) ⇒ String

template.render(templatedText, context) ⇒ string

This function render a text, based on the templatedText and contextObject.

Kind: static method of template
Returns: string - rendered text

| Param | Type | Description | | --- | --- | --- | | templatedText | string | templated text that needs to be replaced with context objects values | | context | object | object that contains values for template |

Example

template.render('${city} is a coastal city', {city: 'Sydney'})  // Sydney is a coastal city

let ctx = {
 location: {
    city: {
      state: 'NSW'
    }
  }
}
template.render('${location.city.state} is the state!', ctx)   // NSW is the state!

template~String

Extension methods to built in String object.

Kind: inner external of template

string.render(context) ⇒ String

Extension method to the String object to call render() method with context object.

Kind: instance method of String
Returns: String - rendered text

| Param | Type | Description | | --- | --- | --- | | context | object | object that contains values for template |

Example

'We are from ${city}!'.render({city: 'Colombo'})   // We are from Colombo

This is an auto generated file. Please don't make changes manually