js.eval: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Created page with "{{MacroFunction |name=js.eval |trusted=true |version=1.9.4 |description= Evaluates a string as a javascript expression. Supports ECMA 2021 standard. For security, access to...")
 
No edit summary
Line 13: Line 13:
'''Parameters'''
'''Parameters'''
* {{code|expression}} - A valid javascript fragment.  It is wrapped inside an anonymous function.
* {{code|expression}} - A valid javascript fragment.  It is wrapped inside an anonymous function.
* {{code|arg1, arg2...}} - Any.  Will be converted to the equivalent javascript type as needed.
* {{code|arg1, arg2...}} - Any.  Will be converted to the equivalent javascript type as needed.  Arguments are accessible via the {{code|args}} variable.
* {{code|return}} - Any primitive type;  Complex types are converted to (JSON) strings.
* {{code|return}} - Any primitive type;  Complex types are converted to (JSON) strings.


|example=
|example=

Revision as of 06:13, 4 August 2021

js.eval() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.9.4
Evaluates a string as a javascript expression. Supports ECMA 2021 standard. For security, access to native types and external resources are limited. Similarly, all arrays passed in to the javascript environment are shallow copied, so changes to the array do not directly change MapTool's state.

Usage

js.eval(expression, arg1, arg2...)

Parameters

  • expression - A valid javascript fragment. It is wrapped inside an anonymous function.
  • arg1, arg2... - Any. Will be converted to the equivalent javascript type as needed. Arguments are accessible via the args variable.
  • return - Any primitive type; Complex types are converted to (JSON) strings.

Example

Using js.eval on an expression.
[r: js.eval("let a = [1,2,3]; return a[1] + args[0]"), 5]

Output:

7

See Also