2016-03-07 16:12:56 +01:00

1.7 KiB

layout
default

Function print #

Interpolate values into a string template.

Syntax #

math.print(template, values)
math.print(template, values, precision)
math.print(template, values, options)

Parameters #

Parameter Type Description
template string A string containing variable placeholders.
values Object An object containing variables which will be filled in in the template.
options number | Object Formatting options, or the number of digits to format numbers. See function math.format for a description of all options.

Returns #

Type Description
string Interpolated string

Examples #

// the following outputs: 'Lucy is 5 years old'
math.print('Lucy is $age years old', {age: 5});

// the following outputs: 'The value of pi is 3.141592654'
math.print('The value of pi is $pi', {pi: math.pi}, 10);

// the following outputs: 'hello Mary! The date is 2013-03-23'
math.print('Hello $user.name! The date is $date', {
  user: {
    name: 'Mary',
  },
  date: new Date(2013, 2, 23).toISOString().substring(0, 10)
});

See also #

format