Skip to main content

YAML System

The YAML system provides functions for parsing YAML strings and files into Lua tables.

Overview​

YAML (YAML Ain't Markup Language) is a human-readable data serialization format. The YAML system allows you to parse YAML content and work with it as Lua tables.

Available Functions​

Common Use Cases​

Parsing YAML String​

local yamlContent = [[
name: John Doe
age: 30
email: john@example.com
]]
local data = parseYamlString(yamlContent)
Logger.info("Name: " .. data.name)

Reading YAML Configuration​

local config = parseYamlFile("config.yaml")
if config then
    Logger.info("Server: " .. config.server)
    Logger.info("Port: " .. config.port)
end

Working with Nested Data​

local yamlContent = [[
database:
  host: localhost
  port: 5432
  credentials:
    username: admin
    password: secret
]]
local data = parseYamlString(yamlContent)
Logger.info("DB Host: " .. data.database.host)

Error Handling​

local data, error = parseYamlString(invalidYaml)
if not data then
    Logger.error("YAML parse error: " .. error)
end

Return Values​

Both functions return:

  • On success: A Lua table representing the YAML data
  • On error: nil and an error message string