View Source ymlr - A YAML Encoder for Elixir
ymlr - A YAML encoder for Elixir.
installation
Installation
The package can be installed by adding ymlr
to your list of dependencies in mix.exs
:
def deps do
[
{:ymlr, "~> 2.0"}
]
end
versions-and-support
Versions and Support
Version 2.0 does not support Elixir 1.10 anymore. However, for now all functionality is backported to version 1.x.
Ymlr Version | Supported Elixir Version |
---|---|
~> 2.0 | ~> 1.11 |
~> 1.0 | ~> 1.10 |
examples
Examples
encode-a-single-document-optionally-with-comments
Encode a single document - optionally with comments:
iex> Ymlr.document!(%{a: 1})
"""
---
a: 1
"""
iex> Ymlr.document!({"comment", %{a: 1}})
"""
---
# comment
a: 1
"""
iex> Ymlr.document!({["comment 1", "comment 2"], %{"a" => "a", "b" => :b, "c" => "true", "d" => "100"}})
"""
---
# comment 1
# comment 2
a: a
b: b
c: 'true'
d: '100'
"""
encode-a-multiple-documents
Encode a multiple documents
iex> Ymlr.documents!([%{a: 1}, %{b: 2}])
"""
---
a: 1
---
b: 2
"""