{"route":"/en-US-v0.13.1/reference/foundations/eval/","title":"Evaluate","description":"Documentation for the `eval` function.","part":null,"outline":[{"id":"summary","name":"Summary","children":[]},{"id":"example","name":"Example","children":[]},{"id":"parameters","name":"Parameters","children":[{"id":"parameters-source","name":"source","children":[]},{"id":"parameters-mode","name":"mode","children":[]},{"id":"parameters-scope","name":"scope","children":[]}]}],"body":{"kind":"func","content":{"path":[],"name":"eval","title":"Evaluate","keywords":[],"oneliner":"Evaluates a string as Typst code.","element":false,"contextual":false,"deprecation":null,"details":"

Evaluates a string as Typst code.

\n

This function should only be used as a last resort.

\n

Example

\n
#eval("1 + 1") \\\n#eval("(1, 2, 3, 4)").len() \\\n#eval("*Markup!*", mode: "markup") \\\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"source","details":"

A string of Typst code to evaluate.

","example":null,"types":["str"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false},{"name":"mode","details":"

The syntactical mode in which the string is\nparsed.

","example":"
#eval("= Heading", mode: "markup")\n#eval("1_2^3", mode: "math")\n
\"Preview\"
","types":["str"],"strings":[{"string":"code","details":"

Evaluate as code, as after a hash.

"},{"string":"markup","details":"

Evaluate as markup, like in a Typst file.

"},{"string":"math","details":"

Evaluate as math, as in an equation.

"}],"default":""code"","positional":false,"named":true,"required":false,"variadic":false,"settable":false},{"name":"scope","details":"

A scope of definitions that are made available.

","example":"
#eval("x + 1", scope: (x: 2)) \\\n#eval(\n  "abc/xyz",\n  mode: "math",\n  scope: (\n    abc: $a + b + c$,\n    xyz: $x + y + z$,\n  ),\n)\n
\"Preview\"
","types":["dictionary"],"strings":[],"default":"(:)","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["any"],"scope":[]}}}