Safe Haskell	None
Language	Haskell98

JavaScript.JSON.Types

Synopsis

Documentation

type Value = SomeValue Immutable Source

type Object = SomeObject Immutable Source

data Options :: *

Options that specify how to encode/decode your datatype to/from JSON.

Constructors

Options

Fields

fieldLabelModifier :: String -> String: Function applied to field labels. Handy for removing common record prefixes for example.
constructorTagModifier :: String -> String: Function applied to constructor tags which could be handy for lower-casing them for example.
allNullaryToStringTag :: Bool: If True the constructors of a datatype, with all nullary constructors, will be encoded to just a string with the constructor tag. If False the encoding will always follow the sumEncoding.
omitNothingFields :: Bool: If True record fields with a Nothing value will be omitted from the resulting object. If False the resulting object will include those fields mapping to null.
sumEncoding :: SumEncoding: Specifies how to encode constructors of a sum datatype.
unwrapUnaryRecords :: Bool: Hide the field name when a record constructor has only one field, like a newtype.

Instances

Show Options

defaultOptions :: Options

Default encoding Options:

Options
{ fieldLabelModifier      = id
, constructorTagModifier  = id
, allNullaryToStringTag   = True
, omitNothingFields       = False
, sumEncoding             = defaultTaggedObject
, unwrapUnaryRecords      = False
}

data SumEncoding :: *

Specifies how to encode constructors of a sum datatype.

Constructors

TaggedObject	A constructor will be encoded to an object with a field `tagFieldName` which specifies the constructor tag (modified by the `constructorTagModifier`). If the constructor is a record the encoded record fields will be unpacked into this object. So make sure that your record doesn't have a field with the same label as the `tagFieldName`. Otherwise the tag gets overwritten by the encoded value of that field! If the constructor is not a record the encoded constructor contents will be stored under the `contentsFieldName` field.
Fields tagFieldName :: String contentsFieldName :: String
ObjectWithSingleField	A constructor will be encoded to an object with a single field named after the constructor tag (modified by the `constructorTagModifier`) which maps to the encoded contents of the constructor.
TwoElemArray	A constructor will be encoded to a 2-element array where the first element is the tag of the constructor (modified by the `constructorTagModifier`) and the second element the encoded contents of the constructor.

Instances

Eq SumEncoding
Show SumEncoding

defaultTaggedObject :: SumEncoding

Default TaggedObject SumEncoding options:

defaultTaggedObject = TaggedObject
                      { tagFieldName      = "tag"
                      , contentsFieldName = "contents"
                      }

camelTo :: Char -> String -> String

Converts from CamelCase to another lower case, interspersing the character between all capital letters and their previous entries, except those capital letters that appear together, like API.

For use by Aeson template haskell calls.

camelTo '_' 'CamelCaseAPI' == "camel_case_api"