yaml
YAML parse and stringify (YAML 1.2 via gopkg.in/yaml.v3).
Naming convention: import the module under its bare name (
import "yaml"), reach members with a backslash, and call methods incamelCase:yaml\someMethod.
Methods
parse
Decode a YAML string into a value (maps, lists, strings, numbers, bools, null); errors on invalid input.
Signature: yaml\parse(source) -> any - source
| Parameter | Type | Optional | Description |
|---|---|---|---|
source |
string |
Returns: any
positions
Report where each value of a YAML document starts, as {lines, columns}: 1-based, each keyed by the value's JSON pointer ("" for the root, /jobs/build/steps/0 for a list item, ~0 and ~1 escaping ~ and / in a key). A mapping entry is keyed at its value, so /jobs/build is where that job's body starts. An alias is keyed where it appears and not followed. What parse returns carries no positions; this is how a check over it points at a line. Errors on invalid input.
Signature: yaml\positions(source) -> YamlPositions - source
| Parameter | Type | Optional | Description |
|---|---|---|---|
source |
string |
Returns: map[string]any
stringify
Encode a value to a YAML string; errors on unencodable input.
Signature: yaml\stringify(value) -> string - source
| Parameter | Type | Optional | Description |
|---|---|---|---|
value |
any |
Returns: string