Data.Argonaut

data Json :: Type

The type of JSON data. The underlying representation is the same as what would be returned from JavaScript's JSON.parse function; that is, ordinary JavaScript booleans, strings, arrays, objects, etc.

Instances

• Eq Json
• Ord Json

toString :: Json -> Maybe String

toObject :: Json -> Maybe (Object Json)

toNumber :: Json -> Maybe Number

toNull :: Json -> Maybe Unit

toBoolean :: Json -> Maybe Boolean

toArray :: Json -> Maybe (Array Json)

stringify :: Json -> String

jsonZero :: Json

jsonTrue :: Json

jsonSingletonObject :: String -> Json -> Json

jsonSingletonArray :: Json -> Json

jsonNull :: Json

jsonFalse :: Json

jsonEmptyString :: Json

jsonEmptyObject :: Json

jsonEmptyArray :: Json

isString :: Json -> Boolean

isObject :: Json -> Boolean

isNumber :: Json -> Boolean

isNull :: Json -> Boolean

isBoolean :: Json -> Boolean

isArray :: Json -> Boolean

fromString :: String -> Json

fromObject :: Object Json -> Json

fromNumber :: Number -> Json

fromBoolean :: Boolean -> Json

fromArray :: Array Json -> Json

caseJsonString :: forall a. a -> (String -> a) -> Json -> a

A simpler version of caseJson which accepts a callback for when the Json argument was a String, and a default value for all other cases.

caseJsonObject :: forall a. a -> (Object Json -> a) -> Json -> a

A simpler version of caseJson which accepts a callback for when the Json argument was an Object, and a default value for all other cases.

caseJsonNumber :: forall a. a -> (Number -> a) -> Json -> a

A simpler version of caseJson which accepts a callback for when the Json argument was a Number, and a default value for all other cases.

caseJsonNull :: forall a. a -> (Unit -> a) -> Json -> a

A simpler version of caseJson which accepts a callback for when the Json argument was null, and a default value for all other cases.

caseJsonBoolean :: forall a. a -> (Boolean -> a) -> Json -> a

A simpler version of caseJson which accepts a callback for when the Json argument was a Boolean, and a default value for all other cases.

caseJsonArray :: forall a. a -> (Array Json -> a) -> Json -> a

A simpler version of caseJson which accepts a callback for when the Json argument was a Array Json, and a default value for all other cases.

caseJson :: forall a. (Unit -> a) -> (Boolean -> a) -> (Number -> a) -> (String -> a) -> (Array Json -> a) -> (Object Json -> a) -> Json -> a

Case analysis for Json values. See the README for more information.

class DecodeJson a  where

Members

• decodeJson :: Json -> Either String a

Instances

• (DecodeJson a) => DecodeJson (Maybe a)
• (DecodeJson a, DecodeJson b) => DecodeJson (Tuple a b)
• (DecodeJson a, DecodeJson b) => DecodeJson (Either a b)
• DecodeJson Unit
• DecodeJson Boolean
• DecodeJson Number
• DecodeJson Int
• DecodeJson String
• DecodeJson Json
• DecodeJson CodePoint
• (DecodeJson a) => DecodeJson (Object a)
• (DecodeJson a) => DecodeJson (Array a)
• (DecodeJson a) => DecodeJson (List a)
• (Ord a, DecodeJson a, DecodeJson b) => DecodeJson (Map a b)
• DecodeJson Void

getFieldOptional :: forall a. DecodeJson a => Object Json -> String -> Either String (Maybe a)

getField :: forall a. DecodeJson a => Object Json -> String -> Either String a

defaultField :: forall a. Either String (Maybe a) -> a -> Either String a

Operator alias for Data.Argonaut.Decode.Combinators.getFieldOptional (non-associative / precedence 7)

Operator alias for Data.Argonaut.Decode.Combinators.defaultField (non-associative / precedence 6)

Operator alias for Data.Argonaut.Decode.Combinators.getField (non-associative / precedence 7)

class EncodeJson a  where

Members

• encodeJson :: a -> Json

Instances

• (EncodeJson a) => EncodeJson (Maybe a)
• (EncodeJson a, EncodeJson b) => EncodeJson (Tuple a b)
• (EncodeJson a, EncodeJson b) => EncodeJson (Either a b)
• EncodeJson Unit
• EncodeJson Boolean
• EncodeJson Number
• EncodeJson Int
• EncodeJson String
• EncodeJson Json
• EncodeJson CodePoint
• EncodeJson Char
• (EncodeJson a) => EncodeJson (Array a)
• (EncodeJson a) => EncodeJson (List a)
• (EncodeJson a) => EncodeJson (Object a)
• (Ord a, EncodeJson a, EncodeJson b) => EncodeJson (Map a b)
• EncodeJson Void

extend :: forall a. EncodeJson a => Tuple String Json -> a -> Json

The named implementation of the (~>) operator.

assoc :: forall a. EncodeJson a => String -> a -> Tuple String Json

The named implementation of the (:=) operator.

Operator alias for Data.Argonaut.Encode.Combinators.extend (right-associative / precedence 6)

Extends a Json object with a Tuple String Json property.

Operator alias for Data.Argonaut.Encode.Combinators.assoc (non-associative / precedence 7)

Creates a Tuple String Json entry, representing a key/value pair for an object.

newtype JsonPrim

Constructors

• JsonPrim (forall a. (Unit -> a) -> (Boolean -> a) -> (Number -> a) -> (String -> a) -> a)

Instances

• Show JsonPrim

data JCursor

Constructors

• JCursorTop
• JField String JCursor
• JIndex Int JCursor

Instances

• Eq JCursor
• Ord JCursor
• Show JCursor
• Semigroup JCursor
• Monoid JCursor
• EncodeJson JCursor
• DecodeJson JCursor

toPrims :: Json -> List (Tuple JCursor JsonPrim)

runJsonPrim :: JsonPrim -> (forall a. (Unit -> a) -> (Boolean -> a) -> (Number -> a) -> (String -> a) -> a)

primToJson :: JsonPrim -> Json

primStr :: String -> JsonPrim

primNum :: Number -> JsonPrim

primNull :: JsonPrim

primBool :: Boolean -> JsonPrim

insideOut :: JCursor -> JCursor

inferEmpty :: JCursor -> Json

fromPrims :: List (Tuple JCursor JsonPrim) -> Maybe Json

fail :: forall b a. Show a => a -> Either String b

downIndex :: Int -> JCursor -> JCursor

downField :: String -> JCursor -> JCursor

cursorSet :: JCursor -> Json -> Json -> Maybe Json

cursorGet :: JCursor -> Json -> Maybe Json

jsonParser :: String -> Either String Json

_String :: Prism' Json String

_Object :: Prism' Json (Object Json)

_Number :: Prism' Json Number

_Null :: Prism' Json Unit

_Boolean :: Prism' Json Boolean

_Array :: Prism' Json (Array Json)

_JsonString :: Traversal' Json Json

_JsonObject :: Traversal' Json Json

_JsonNumber :: Traversal' Json Json

_JsonNull :: Traversal' Json Json

_JsonBoolean :: Traversal' Json Json

_JsonArray :: Traversal' Json Json