Module

Foreign.Generic

Package
purescript-foreign-generic
Repository
paf31/purescript-foreign-generic

#defaultOptions Source

defaultOptions :: Options

Default decoding/encoding options:

  • Represent sum types as records with tag and contents fields
  • Unwrap single arguments
  • Don't unwrap single constructors
  • Use the constructor names as-is
  • Use the field names as-is

#genericDecode Source

genericDecode :: forall rep a. Generic a rep => GenericDecode rep => Options -> Foreign -> F a

Read a value which has a Generic type.

#genericEncode Source

genericEncode :: forall rep a. Generic a rep => GenericEncode rep => Options -> a -> Foreign

Generate a Foreign value compatible with the genericDecode function.

#decodeJSON Source

decodeJSON :: forall a. Decode a => String -> F a

Decode a JSON string using a Decode instance.

#encodeJSON Source

encodeJSON :: forall a. Encode a => a -> String

Encode a JSON string using an Encode instance.

#genericDecodeJSON Source

genericDecodeJSON :: forall rep a. Generic a rep => GenericDecode rep => Options -> String -> F a

Read a value which has a Generic type from a JSON String

#genericEncodeJSON Source

genericEncodeJSON :: forall rep a. Generic a rep => GenericEncode rep => Options -> a -> String

Write a value which has a Generic type as a JSON String