`toml`

Reads structured data from a TOML file.

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

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

Example

#let details = toml("details.toml")

Title: #details.title \
Version: #details.version \
Authors: #(details.authors
  .join(", ", last: " and "))

Parameter
Parameter
Parameters are input values for functions. Specify them in parentheses after the function name.

toml(strbytes)->any

`source`
str bytes
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

A path to a TOML file or raw TOML bytes.

Definitions
Definitions
These functions and types can have related definitions. To access a definition, specify the name of the function or type, followed by the definition name separated by a period.

`decode`

`toml.decode` is deprecated, directly pass bytes to `toml` instead

Reads structured data from a TOML string/bytes.

toml.decode(strbytes)->any

`data`
str bytes
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

TOML data.

`encode`

Encodes structured data into a TOML string.

toml.encode(any
,pretty:
bool)->str

`value`
any
Required
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.

Value to be encoded.

`pretty`
bool

Whether to pretty-print the resulting TOML.

Default value:

true

toml

Example

ParameterParameterParameters are input values for functions. Specify them in parentheses after the function name.

sourcestrbytesRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.

DefinitionsDefinitionsThese functions and types can have related definitions. To access a definition, specify the name of the function or type, followed by the definition name separated by a period.

decode

datastrbytesRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.

encode

valueanyRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.

prettybool

Search