Copyright | (c) Scrive 2011 |
---|---|
License | BSD-style (see the LICENSE file in the distribution) |
Maintainer | andrzej@scrive.com |
Stability | development |
Portability | portable |
Safe Haskell | None |
Language | Haskell98 |
Abusing monadic 'do' notation library for generating JSON object.
Hard-bound to JSValue
from json package from hackage.
Main ideas
- Overloaded function
value
to set values in underlying JSON -Bool
,Int
,String
, lists, etc. - JSON generation may not be pure with
valueM
. You can perform some IO while generating JSON. This is usefull skip useless inner binding. - Compositionality - use
object
to easy create JSON objects. Theobjects
function is there to support arrays of objects. - Monadic notation - it really looks nicer then composition with
.
or some magic combinator
runJSONGen $ do value "a" "a" value "b" [1,2,3] object "c" $ do value "x" True value "y" False
Will generate json object:
{a : "a", b: [1,2,3], c: {x: true, y : false}}
- module Text.JSON.ToJSValue
- type JSONGen = JSONGenT Identity
- data JSONGenT m a
- runJSONGen :: JSONGen () -> JSValue
- runJSONGenT :: Monad m => JSONGenT m () -> m JSValue
- value :: (Monad m, ToJSValue a) => String -> a -> JSONGenT m ()
- valueM :: (Monad m, ToJSValue a) => String -> m a -> JSONGenT m ()
- object :: Monad m => String -> JSONGenT m () -> JSONGenT m ()
- objects :: Monad m => String -> [JSONGenT m ()] -> JSONGenT m ()
Documentation
module Text.JSON.ToJSValue
Basic types
A monad that keeps currently constructed JSON.
Runners
runJSONGen :: JSONGen () -> JSValue Source
Runner. Example:
let js = runJSONGen $ do value "abc" "def"
runJSONGenT :: Monad m => JSONGenT m () -> m JSValue Source
Runner as monad transformer. Example:
js <- runJSONGenT $ do d <- lift $ getFromOuterMonad value "abc" d
Creating JSON's
value :: (Monad m, ToJSValue a) => String -> a -> JSONGenT m () Source
Set pure value under given name in final JSON object. Example:
value "key" "value"
valueM :: (Monad m, ToJSValue a) => String -> m a -> JSONGenT m () Source
Monadic verion of value
using monad transformer. Example:
js <- runJSONGenT $ do valueM "abc" (getLine)