TOML

Reads structured data from a TOML file.

The file must contain a valid TOML table. The TOML values will be converted into corresponding Typst values as listed in the table below.

The function returns a dictionary representing the TOML table.

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

Example

Loading compiler...

First of all, TOML documents are tables. Other values must be put in a table to be encoded or decoded.

Typst value	Converted into TOML
types that can be converted from TOML	corresponding TOML value
`none`	ignored
`bytes`	string via `repr`
`symbol`	string
`content`	a table describing the content
other types (`length`, etc.)	string via `repr`

Be aware that TOML integers larger than 263-1 or smaller than -263 cannot be represented losslessly in Typst, and an error will be thrown according to the specification.
Bytes are not encoded as TOML arrays for performance and readability reasons. Consider using cbor.encode for binary data.
The repr function is for debugging purposes only, and its output is not guaranteed to be stable across Typst versions.

#toml(
  source
) -> dictionary

Prop

Type

Reads structured data from a TOML string/bytes.

#toml.decode(
  data
) -> dictionary

Prop

Type

Encodes structured data into a TOML string.

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

Prop

Type