{"route":"/en-US-v0.13.1/reference/data-loading/toml/","title":"TOML","description":"Documentation for the `toml` 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":"definitions","name":"Definitions","children":[{"id":"definitions-decode","name":"Decode TOML","children":[{"id":"definitions-decode-data","name":"data","children":[]}]},{"id":"definitions-encode","name":"Encode TOML","children":[{"id":"definitions-encode-value","name":"value","children":[]},{"id":"definitions-encode-pretty","name":"pretty","children":[]}]}]}],"body":{"kind":"func","content":{"path":[],"name":"toml","title":"TOML","keywords":[],"oneliner":"Reads structured data from a TOML file.","element":false,"contextual":false,"deprecation":null,"details":"

Reads structured data from a TOML file.

\n

The file must contain a valid TOML table. TOML tables will be converted into\nTypst dictionaries, and TOML arrays will be converted into Typst arrays.\nStrings, booleans and datetimes will be converted into the Typst equivalents\nand numbers will be converted to floats or integers depending on whether\nthey are whole numbers.

\n

The TOML file in the example consists of a table with the keys title,\nversion, and authors.

\n

Example

\n
#let details = toml("details.toml")\n\nTitle: #details.title \\\nVersion: #details.version \\\nAuthors: #(details.authors\n  .join(", ", last: " and "))\n
\"Preview\"
","example":null,"self":false,"params":[{"name":"source","details":"

A path to a TOML file or raw TOML bytes.

","example":null,"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[{"path":["toml"],"name":"decode","title":"Decode TOML","keywords":[],"oneliner":"Reads structured data from a TOML string/bytes.","element":false,"contextual":false,"deprecation":"`toml.decode` is deprecated, directly pass bytes to `toml` instead","details":"

Reads structured data from a TOML string/bytes.

","example":null,"self":false,"params":[{"name":"data","details":"

TOML data.

","example":null,"types":["str","bytes"],"strings":[],"default":null,"positional":true,"named":false,"required":true,"variadic":false,"settable":false}],"returns":["any"],"scope":[]},{"path":["toml"],"name":"encode","title":"Encode TOML","keywords":[],"oneliner":"Encodes structured data into a TOML string.","element":false,"contextual":false,"deprecation":null,"details":"

Encodes structured data into a TOML string.

","example":null,"self":false,"params":[{"name":"value","details":"

Value to be encoded.

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

Whether to pretty-print the resulting TOML.

","example":null,"types":["bool"],"strings":[],"default":"true","positional":false,"named":true,"required":false,"variadic":false,"settable":false}],"returns":["str"],"scope":[]}]}}}