Menu

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Open source

yaml_decode

The yaml_decode function decodes a string representing YAML into an Alloy value. yaml_decode fails if the string argument provided cannot be parsed as YAML.

A common use case of yaml_decode is to decode the output of a local.file component to an Alloy value.

Note

Remember to escape double quotes when passing YAML string literals to yaml_decode.

For example, the YAML value key: "value" is properly represented by the string "key: \"value\"".

Examples

> yaml_decode("15")
15
> yaml_decode("[1, 2, 3]")
[1, 2, 3]
> yaml_decode("null")
null
> yaml_decode("key: value")
{
  key = "value",
}
> yaml_decode(local.file.some_file.content)
"Hello, world!"