Simple.JSON

type E a = Either MultipleErrors a

An alias for the Either result of decoding

readJSON :: forall a. ReadForeign a => String -> E a

Read a JSON string to a type a while returning a MultipleErrors if the parsing failed.

readJSON' :: forall a. ReadForeign a => String -> F a

Read a JSON string to a type a using F a. Useful with record types.

readJSON_ :: forall a. ReadForeign a => String -> Maybe a

Read a JSON string to a type a while returning Nothing if the parsing failed.

writeJSON :: forall a. WriteForeign a => a -> String

Write a JSON string from a type a.

write :: forall a. WriteForeign a => a -> Foreign

read :: forall a. ReadForeign a => Foreign -> E a

Read a Foreign value to a type

read' :: forall a. ReadForeign a => Foreign -> F a

read_ :: forall a. ReadForeign a => Foreign -> Maybe a

Read a Foreign value to a type, as a Maybe of type

readAsForeign :: forall a b. ReadForeign a => b -> E a

Read a value of any type as Foreign to a type

parseJSON :: String -> F Foreign

undefined :: Foreign

class ReadForeign a  where

A class for reading foreign values to a type

Members

• readImpl :: Foreign -> F a

Instances

• ReadForeign Foreign
• ReadForeign Char
• ReadForeign Number
• ReadForeign Int
• ReadForeign String
• ReadForeign Boolean
• (ReadForeign a) => ReadForeign (Array a)
• (ReadForeign a) => ReadForeign (List a)
• (ReadForeign a) => ReadForeign (Maybe a)
• ReadForeign Hextet
• ReadForeign Octet
• ReadForeign Port
• ReadForeign IpAddress
• ReadForeign Ip4Address
• ReadForeign Ip6Address
• (ReadForeign a) => ReadForeign (Nullable a)
• (ReadForeign a) => ReadForeign (Map String a)
• (Newtype b String, ReadForeign a) => ReadForeign (Map b a)
• (RowToList fields fieldList, ReadForeignFields fieldList () fields) => ReadForeign (Record fields)
• (RowToList variants rl, ReadForeignVariant rl variants) => ReadForeign (Variant variants)
• (ReadForeign a) => ReadForeign (NonEmptyArray a)

class ReadForeignFields :: RowList Type -> Row Type -> Row Type -> Constraintclass ReadForeignFields (xs :: RowList Type) (from :: Row Type) (to :: Row Type) | xs -> from to where

A class for reading foreign values from properties

Members

• getFields :: RLProxy xs -> Foreign -> F (Builder (Record from) (Record to))

Instances

• (IsSymbol name, ReadForeign ty, ReadForeignFields tail from from', Lacks name from', Cons name ty from' to) => ReadForeignFields (Cons name ty tail) from to
• ReadForeignFields Nil () ()

class ReadForeignVariant :: RowList Type -> Row Type -> Constraintclass ReadForeignVariant (xs :: RowList Type) (row :: Row Type) | xs -> row where

Members

• readVariantImpl :: RLProxy xs -> Foreign -> F (Variant row)

Instances

• ReadForeignVariant Nil trash
• (IsSymbol name, ReadForeign ty, Cons name ty trash row, ReadForeignVariant tail row) => ReadForeignVariant (Cons name ty tail) row

class WriteForeign a  where

Members

• writeImpl :: a -> Foreign

Instances

• WriteForeign Foreign
• WriteForeign String
• WriteForeign Int
• WriteForeign Char
• WriteForeign Number
• WriteForeign Boolean
• (WriteForeign a) => WriteForeign (Array a)
• (WriteForeign a) => WriteForeign (List a)
• (WriteForeign a) => WriteForeign (Maybe a)
• (WriteForeign a) => WriteForeign (Nullable a)
• (WriteForeign a) => WriteForeign (Map String a)
• (Newtype b String, WriteForeign a) => WriteForeign (Map b a)
• (RowToList row rl, WriteForeignFields rl row) => WriteForeign (Record row)
• (RowToList row rl, WriteForeignVariant rl row) => WriteForeign (Variant row)
• (WriteForeign a) => WriteForeign (NonEmptyArray a)

class WriteForeignFields :: RowList Type -> Row Type -> Constraintclass WriteForeignFields (rl :: RowList Type) row | rl -> row where

Members

• writeImplFields :: forall g. g rl -> Record row -> Map String Foreign

Instances

• (IsSymbol name, WriteForeign ty, WriteForeignFields tail row, Cons name ty whatever row) => WriteForeignFields (Cons name ty tail) row
• WriteForeignFields Nil row

class WriteForeignVariant :: RowList Type -> Row Type -> Constraintclass WriteForeignVariant (rl :: RowList Type) (row :: Row Type) | rl -> row where

Members

• writeVariantImpl :: forall g. g rl -> Variant row -> Foreign

Instances

• WriteForeignVariant Nil ()
• (IsSymbol name, WriteForeign ty, Cons name ty subRow row, WriteForeignVariant tail subRow) => WriteForeignVariant (Cons name ty tail) row