Skip to content

Search

Documentation

toml module

TOML text to and from script tables, the format of scene files, asset definitions and component properties.

Nesta página

TOML text to and from script tables, the format of scene files, asset definitions and component properties.

3 functions, 0 constants. Scripts reach it as toml::.

Functions

Argument kinds are the script values a call passes: node is a node handle, any a table or value of any kind, fn a callback.

function acts on what it does
encode(value: any) — A table written back out as TOML text; a node or callback in it is not data and is an error.
parse(text: string) — The table a TOML document describes; an error on text that does not parse.
patch(existing: string, table: any) — The document's text with this table's keys written into it, keeping every comment, the key order and any table the value does not name. What a tool saving a hand-written file uses instead of encode.