-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Output any Aeson value as YAML (pure Haskell library)
--   
--   This library exposes functions for encoding any Aeson value as YAML.
--   There is also support for encoding multiple values into YAML
--   "documents".
--   
--   This library is pure Haskell, and does not depend on C FFI with
--   libyaml. It is also licensed under the BSD3 license.
@package aeson-yaml
@version 1.1.0.1


-- | This library exposes functions for encoding any Aeson value as YAML.
--   There is also support for encoding multiple values into YAML
--   "documents".
--   
--   This library is pure Haskell, and does not depend on C FFI with
--   libyaml. It is also licensed under the BSD3 license.
--   
--   This module is meant to be imported qualified.
module Data.Aeson.Yaml

-- | Encode a value as YAML (lazy bytestring).
encode :: ToJSON a => a -> ByteString

-- | Encode multiple values prefixed by <tt>---n</tt>. To encode values of
--   different types, <tt>import Data.Aeson(ToJSON(toJSON))</tt> and do
--   <tt>encodeDocuments [toJSON x, toJSON y, toJSON z]</tt>.
encodeDocuments :: ToJSON a => [a] -> ByteString

-- | Encode a value as YAML (lazy bytestring). Keys and strings are always
--   quoted.
encodeQuoted :: ToJSON a => a -> ByteString

-- | Encode multiple values separated by 'n---n'. Keys and strings are
--   always quoted.
encodeQuotedDocuments :: ToJSON a => [a] -> ByteString
