Function estTemplate

Alias

  • estTemplate(string, options?, guard?): ((data?: object) => string) & {
        source: string;
    }

  • Compiles a template string into a function that can interpolate data properties.

    This function allows you to create a template with custom delimiters for escaping, evaluating, and interpolating values. It can also handle custom variable names and imported functions.

    Parameters

    • string: string

      The template string.

    • Optionaloptions: TemplateOptions

      The options object.

    • Optionalguard: unknown

      The guard to detect if the function is called with options.

    Returns ((data?: object) => string) & {
        source: string;
    }

    Returns the compiled template function.

    Example

    // Use the "escape" delimiter to escape data properties.
    const compiled = template('<%- value %>');
    compiled({ value: '<div>' }); // returns '&lt;div&gt;'

    Example

    // Use the "interpolate" delimiter to interpolate data properties.
    const compiled = template('<%= value %>');
    compiled({ value: 'Hello, World!' }); // returns 'Hello, World!'

    Example

    // Use the "evaluate" delimiter to evaluate JavaScript code.
    const compiled = template('<% if (value) { %>Yes<% } else { %>No<% } %>');
    compiled({ value: true }); // returns 'Yes'

    Example

    // Use the "variable" option to specify the data object variable name.
    const compiled = template('<%= data.value %>', { variable: 'data' });
    compiled({ value: 'Hello, World!' }); // returns 'Hello, World!'

    Example

    // Use the "imports" option to import functions.
    const compiled = template('<%= _.toUpper(value) %>', { imports: { _: { toUpper } } });
    compiled({ value: 'hello, world!' }); // returns 'HELLO, WORLD!'

    Example

    // Use the custom "escape" delimiter.
    const compiled = template('<@ value @>', { escape: /<@([\s\S]+?)@>/g });
    compiled({ value: '<div>' }); // returns '&lt;div&gt;'

    Example

    // Use the custom "evaluate" delimiter.
    const compiled = template('<# if (value) { #>Yes<# } else { #>No<# } #>', { evaluate: /<#([\s\S]+?)#>/g });
    compiled({ value: true }); // returns 'Yes'

    Example

    // Use the custom "interpolate" delimiter.
    const compiled = template('<$ value $>', { interpolate: /<\$([\s\S]+?)\$>/g });
    compiled({ value: 'Hello, World!' }); // returns 'Hello, World!'

    Example

    // Use the "sourceURL" option to specify the source URL of the template.
    const compiled = template('hello <%= user %>!', { sourceURL: 'template.js' });

Settings

Member Visibility