template

Creates a template function that replaces placeholders in a string with values from a data object, supporting custom patterns and escaping.

Syntax

template(str: string, options?: TemplateOptions): (data: Record<string, any>) => string

TemplateOptions

Property	Type	Description
pattern	RegExp (optional)	Custom pattern for placeholders (default: /\{\{(.*?)\}\}/g).
escape	(value: string, key: string) => string (optional)	Function to escape values before interpolation.

Parameters

Parameter	Type	Description
str	string	The string with placeholders in the format \{\{key\}\}.
options	TemplateOptions (optional)	Options for custom pattern and escaping.

Returns

Type	Description
(data: Record<string, any>) => string	A function that takes a data object and returns the interpolated string.

Example

const fn = template("Hello, \{\{name\}\}!", { escape: (v) => v.toUpperCase() });
fn({ name: "Maria" }); // "Hello, MARIA!"

Notes

• Throws TypeError if str is not a string, pattern is not a RegExp, or escape is not a function.
• Placeholders without a corresponding value remain unchanged.
• The backslashes () before the curly braces ( ) are escape characters used only to prevent conflicts with the documentation compiler. When using the function in practice, use simple braces without escaping.

References

• MDN: String.prototype.replace()