magus v0.3.0 is out. See what's new
¶ View markdown source · ✎ Suggest an edit

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 in camelCase: 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

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

auto-generatedyamlmodulestdlibmagusfile
Last updated (e0463131)
Earlier changes on this page (1)

Full history ↗ · Blame source ↗

Glossary

Magusfile

The magusfile.buzz that declares a project's targets (as export funs) and binds its spells. See targets.

Module

A magus stdlib namespace a magusfile imports for host capabilities: filesystem, exec, vcs, and more. See the module reference.

Conventions

This page uses none of the site's convention markers. The full set is on the conventions page.