Module

Data.Argonaut

Package: purescript-argonaut
Repository: purescript-contrib/purescript-argonaut

Re-exports from Data.Argonaut.Core

#Json Source

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

#JString Source

type JString = String

A String value inside some JSON data. Note that this type is exactly the same as the primitive String type; this synonym acts only to help indicate intent.

#JObject Source

type JObject = StrMap Json

A JSON object; a JavaScript object containing Json values.

#JNumber Source

type JNumber = Number

A Number value inside some JSON data. Note that this type is exactly the same as the primitive Number type; this synonym acts only to help indicate intent.

#JNull Source

data JNull :: Type

The type of null values inside JSON data. There is exactly one value of this type: in JavaScript, it is written null. This module exports this value as jsonNull.

Instances

#JBoolean Source

type JBoolean = Boolean

A Boolean value inside some JSON data. Note that this type is exactly the same as the primitive Boolean type; this synonym acts only to help indicate intent.

#JAssoc Source

type JAssoc = Tuple String Json

#JArray Source

type JArray = Array Json

A JSON array; an array containing Json values.

#toString Source

toString :: Json -> Maybe JString

#toObject Source

toObject :: Json -> Maybe JObject

#toNumber Source

toNumber :: Json -> Maybe JNumber

#toNull Source

toNull :: Json -> Maybe JNull

#toBoolean Source

toBoolean :: Json -> Maybe JBoolean

#toArray Source

toArray :: Json -> Maybe JArray

#jsonZero Source

jsonZero :: Json

#jsonTrue Source

jsonTrue :: Json

#jsonSingletonObject Source

jsonSingletonObject :: String -> Json -> Json

#jsonSingletonArray Source

jsonSingletonArray :: Json -> Json

#jsonNull Source

jsonNull :: Json

#jsonFalse Source

jsonFalse :: Json

#jsonEmptyObject Source

jsonEmptyObject :: Json

#jsonEmptyArray Source

jsonEmptyArray :: Json

#jNull Source

jNull :: JNull

#isString Source

isString :: Json -> Boolean

#isObject Source

isObject :: Json -> Boolean

#isNumber Source

isNumber :: Json -> Boolean

#isNull Source

isNull :: Json -> Boolean

#isBoolean Source

isBoolean :: Json -> Boolean

#isArray Source

isArray :: Json -> Boolean

#fromString Source

fromString :: JString -> Json

#fromObject Source

fromObject :: JObject -> Json

#fromNumber Source

fromNumber :: JNumber -> Json

#fromNull Source

fromNull :: JNull -> Json

#fromBoolean Source

fromBoolean :: JBoolean -> Json

#fromArray Source

fromArray :: JArray -> Json

#foldJsonString Source

foldJsonString :: forall a. a -> (JString -> a) -> Json -> a

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

#foldJsonObject Source

foldJsonObject :: forall a. a -> (JObject -> a) -> Json -> a

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

#foldJsonNumber Source

foldJsonNumber :: forall a. a -> (JNumber -> a) -> Json -> a

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

#foldJsonNull Source

foldJsonNull :: forall a. a -> (JNull -> a) -> Json -> a

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

#foldJsonBoolean Source

foldJsonBoolean :: forall a. a -> (JBoolean -> a) -> Json -> a

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

#foldJsonArray Source

foldJsonArray :: forall a. a -> (JArray -> a) -> Json -> a

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

#foldJson Source

foldJson :: forall a. (JNull -> a) -> (JBoolean -> a) -> (JNumber -> a) -> (JString -> a) -> (JArray -> a) -> (JObject -> a) -> Json -> a

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

Re-exports from Data.Argonaut.Decode

#DecodeJson Source

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 Char
(DecodeJson a) => DecodeJson (StrMap a)
(DecodeJson a) => DecodeJson (Array a)
(DecodeJson a) => DecodeJson (List a)
(Ord a, DecodeJson a, DecodeJson b) => DecodeJson (Map a b)
DecodeJson Void

#getField Source

getField :: forall a. DecodeJson a => JObject -> String -> Either String a

#(.?) Source

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

Re-exports from Data.Argonaut.Encode

#EncodeJson Source

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 Char
(EncodeJson a) => EncodeJson (Array a)
(EncodeJson a) => EncodeJson (List a)
(EncodeJson a) => EncodeJson (StrMap a)
(Ord a, EncodeJson a, EncodeJson b) => EncodeJson (Map a b)
EncodeJson Void

#extend Source

extend :: forall a. EncodeJson a => JAssoc -> a -> Json

The named implementation of the (~>) operator.

#assoc Source

assoc :: forall a. EncodeJson a => String -> a -> JAssoc

The named implementation of the (:=) operator.

#(~>) Source

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

Extends a Json object with a JAssoc property.

#(:=) Source

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

Creates a JAssoc entry, representing a key/value pair for an object.

Re-exports from Data.Argonaut.JCursor

#JsonPrim Source

newtype JsonPrim

Constructors

JsonPrim (forall a. (JNull -> a) -> (JBoolean -> a) -> (JNumber -> a) -> (JString -> a) -> a)

Instances

Show JsonPrim

#JCursor Source

data JCursor

Constructors

Instances

#toPrims Source

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

#runJsonPrim Source

runJsonPrim :: JsonPrim -> (forall a. (JNull -> a) -> (JBoolean -> a) -> (JNumber -> a) -> (JString -> a) -> a)

#primToJson Source

primToJson :: JsonPrim -> Json

#primStr Source

primStr :: JString -> JsonPrim

#primNum Source

primNum :: JNumber -> JsonPrim

#primNull Source

primNull :: JsonPrim

#primBool Source

primBool :: JBoolean -> JsonPrim

#insideOut Source

insideOut :: JCursor -> JCursor

#inferEmpty Source

inferEmpty :: JCursor -> Json

#fromPrims Source

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

#fail Source

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

#downIndex Source

downIndex :: Int -> JCursor -> JCursor

#downField Source

downField :: String -> JCursor -> JCursor

#cursorSet Source

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

#cursorGet Source

cursorGet :: JCursor -> Json -> Maybe Json

Re-exports from Data.Argonaut.Parser

#jsonParser Source

jsonParser :: String -> Either String Json

Re-exports from Data.Argonaut.Prisms

#_String Source

_String :: Prism' Json JString

#_Object Source

_Object :: Prism' Json JObject

#_Number Source

_Number :: Prism' Json JNumber

#_Null Source

_Null :: Prism' Json JNull

#_Boolean Source

_Boolean :: Prism' Json JBoolean

#_Array Source

_Array :: Prism' Json JArray

Re-exports from Data.Argonaut.Traversals

#_JsonString Source

_JsonString :: Traversal' Json Json

#_JsonObject Source

_JsonObject :: Traversal' Json Json

#_JsonNumber Source

_JsonNumber :: Traversal' Json Json

#_JsonNull Source

_JsonNull :: Traversal' Json Json

#_JsonBoolean Source

_JsonBoolean :: Traversal' Json Json

#_JsonArray Source

_JsonArray :: Traversal' Json Json

Modules: Data.Argonaut