A simple template engine function.
const resolve: (template: string, variables: Record<string, any>) => string
The first parameter is the template text.
You can use variables on the template by using syntax like: ${foo}.
The second parameter is the variables map, where the key will be looked for when resolving the template, and the variable will be replaced with the respective value.
The result from replacing all the annotated variables in the template text with their respective values from the map.
import { resolve } from ".";
const result = resolve(
"My name is ${name} and I'm ${age}.",
{ name: "Fernando", age: 38 }
);
console.log(result); // Outputs: My name is Fernando and I'm 38.
If a variable appears in the template text but is not defined in the variables map, it throws an error.
Variable syntax can be escaped by using a \ (backslash) before it.
Reminder: inserting a backslash in a Javascript string actually requires two backslashes. Example: "\\${escapedSyntax}"
Variable names must follow these rules:
- Variable names may contain letters, digits (0-9) or the underscore character _.
- Variable names must begin with a letter from A-Z or the underscore _ character. Either lowercase or uppercase letters are acceptable.