A string that names the data object inside compiled _.template() source. Set it to "data" and write data.user. When unset, Lodash uses a with statement so bare names work.
Set the property globally, or override it per call with options passed to _.template().
Use _.templateSettings.variable. Start with this line.
_.templateSettings.variable| Call | What it does |
|---|---|
_.templateSettings.variable | Primary setting. |
_.templateSettings.variable = /.../g | Assign a custom RegExp or value before compiling. |
Prefer the full Lodash build when using _.template() and _.templateSettings.
_.templateSettings.variable| Parameter | Description |
|---|---|
| _.templateSettings.variable | Optional. (String) Global data parameter name |
| options.variable | Optional. (String) Per-compile override |
| Render argument | Optional. (Object) Unchanged — still a plain data bag |
| Return Value | Description |
|---|---|
| * | String (identifier) |
withWith variable unset, properties are free names in the template.
var compiled = _.template('hello <%= user %>!');
compiled({ user: 'fred' });
// → 'hello fred!'with.user resolves from the data object.with is weaker for CSP / clarity.variable = 'data'Qualify every property with the chosen name.
_.templateSettings.variable = 'data';
var compiled = _.template('<%= data.user %>!');
compiled({ 'user': 'barney' });
// → 'barney!''data'.data.user in the interpolate tag.{ user: 'barney' } at render time (not { data: … }).with — clearer scope for CSP-friendly compiles.options.variableName the argument for one template without a global change.
var compiled = _.template(
'Hi <%= view.name %>',
{ variable: 'view' }
);
compiled({ name: 'Ada' });
// → 'Hi Ada'{ variable: 'view' } to _.template.view.name.With variable set, bare names are not in scope.
var ok = _.template(
'<%= data.user %>',
{ variable: 'data' }
);
ok({ user: 'sam' });
// → 'sam'
// Bare name fails when variable is set:
try {
_.template('<%= user %>', { variable: 'data' })({ user: 'sam' });
} catch (e) {
// ReferenceError: user is not defined
}data.user works.user is undefined in the compiled function.ReferenceError at call time.variable, always prefix properties.variable + Mustache InterpolateCombine a named data object with custom value delimiters.
var compiled = _.template(
'hello {{ data.user }}!',
{
variable: 'data',
interpolate: /{{([\s\S]+?)}}/g
}
);
compiled({ user: 'pebbles' });
// → 'hello pebbles!'data.{{ … }}.data.user inside the braces._.templateSettings.variable is a Lodash templateSettings property used by _.template. It runs anywhere Lodash 4.x runs — modern browsers (CDN or bundle) and Node.js / Bun / Deno with npm install lodash.
Available with [email protected] full builds that include _.template. Works in evergreen browsers and current Node LTS when Lodash is installed.
Bottom line: Prefer setting variable (or options.variable) to avoid with and clarify scope. Use trusted templates only. Note: _.template is planned for removal in Lodash v5.
Invoke a function safely and get a value or an Error.
11 people found this page helpful