yamlalias

Documentation

Overview

Package yamlalias adds support for aliases when parsing YAML.

Aliases are specified as a comma-separated list specified via "yaml-aliases" struct tag.

Example:

type Config struct {
  UserName string `yaml:"username" yaml-aliases:"userName,user-name"`
}

This will parse the following YAML examples in the same way:

{"username": "John Doe"}
{"userName": "John Doe"}
{"user-name": "John Doe"}

Note: It only adds aliases for top-level fields in the struct.

Index

• func Unmarshal(in []byte, out interface{}) error
• func UnmarshalStrict(in []byte, out interface{}) error

Functions

func Unmarshal

func Unmarshal(in []byte, out interface{}) error

Unmarshal is a wrapper for yaml.Unmarshal but adds support for any yaml-aliases specified in out.

func UnmarshalStrict

func UnmarshalStrict(in []byte, out interface{}) error

UnmarshalStrict is a wrapper for yaml.UnmarshalStrict but adds support for any yaml-aliases specified in out.