Language.Haskell.To.Elm

Classes

class HasElmType a where

Represents that the corresponding Elm type for the Haskell type a is elmType @a.

This class has a default instance for types that satisfy HasElmDefinition, which refers to the name of that definition.

Minimal complete definition

Nothing

Methods

elmType :: Type v

elmType :: HasElmDefinition a => Type v

Instances

HasElmType Bool

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType Char

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType Double

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType Int

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType Text

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType UTCTime

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType a => HasElmType [a]

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

HasElmType a => HasElmType (Maybe a)

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

(HasElmType a, HasElmType b) => HasElmType (a, b)

Defined in Language.Haskell.To.Elm

Methods

elmType :: Type v

class HasElmDefinition a where

Represents that we can generate the definition for the Elm type that corresponds to a using elmDefinition @a.

See deriveElmTypeDefinition for a way to automatically derive elmDefinition.

Methods

elmDefinition :: Definition

class HasElmType a => HasElmDecoder value a where

Represents that the Elm type that corresponds to a has a decoder from value, namely elmDecoder @value @a.

This class has a default instance for types that satisfy HasElmDecoderDefinition, which refers to the name of that definition.

Minimal complete definition

Nothing

Methods

elmDecoder :: Expression v

elmDecoder :: HasElmDecoderDefinition value a => Expression v

Instances

HasElmDecoder Text Text

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value Bool

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value Char

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value Double

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value Int

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value Text

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value UTCTime

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value a => HasElmDecoder Value [a]

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

HasElmDecoder Value a => HasElmDecoder Value (Maybe a)

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

(HasElmDecoder Value a, HasElmDecoder Value b) => HasElmDecoder Value (a, b)

Defined in Language.Haskell.To.Elm

Methods

elmDecoder :: Expression v

class HasElmType a => HasElmEncoder value a where

Represents that the Elm type that corresponds to a has an encoder into value, namely elmEncoder @value @a.

This class has a default instance for types that satisfy HasElmEncoderDefinition, which refers to the name of that definition.

Minimal complete definition

Nothing

Methods

elmEncoder :: Expression v

elmEncoder :: HasElmEncoderDefinition value a => Expression v

Instances

HasElmEncoder Text Char

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Text Double

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Text Int

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Text Text

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value Bool

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value Char

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value Double

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value Int

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value Text

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value UTCTime

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value a => HasElmEncoder Value [a]

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder Value a => HasElmEncoder Value (Maybe a)

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

(HasElmEncoder Value a, HasElmEncoder Value b) => HasElmEncoder Value (a, b)

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

HasElmEncoder a b => HasElmEncoder (Maybe a) (Maybe b)

Defined in Language.Haskell.To.Elm

Methods

elmEncoder :: Expression v

class HasElmDecoderDefinition value a where

Represents that we can generate the Elm decoder definition from value for the Elm type that corresponds to a.

See deriveElmJSONDecoder for a way to automatically derive elmDecoderDefinition when value = Value.

Methods

elmDecoderDefinition :: Definition

class HasElmEncoderDefinition value a where

Represents that we can generate the Elm encoder definition into value for the Elm type that corresponds to a.

See deriveElmJSONEncoder for a way to automatically derive elmEncoderDefinition when value = Value.

Methods

elmEncoderDefinition :: Definition

Derivers

newtype Options

Elm code generation options

Constructors

Options

Fields

• fieldLabelModifier :: String -> String

  Use this function to go from Haskell record field name to Elm record field name.

defaultOptions :: Options

deriveElmTypeDefinition :: forall a. (HasDatatypeInfo a, All2 HasElmType (Code a)) => Options -> Qualified -> Definition

Automatically create an Elm definition given a Haskell type.

This is suitable for use as a HasElmDefinition instance:

instance HasElmDefinition MyType where
  elmDefinition =
    deriveElmTypeDefinition @MyType defaultOptions "Api.MyType.MyType"

deriveElmJSONDecoder :: forall a. (HasDatatypeInfo a, HasElmType a, All2 (HasElmDecoder Value) (Code a)) => Options -> Options -> Qualified -> Definition

Automatically create an Elm JSON decoder definition given a Haskell type.

This is suitable for use as a HasElmDecoderDefinition Value instance:

instance HasElmDecoderDefinition Value MyType where
  elmDecoderDefinition =
    deriveElmJSONDecoder @MyType defaultOptions defaultOptions "Api.MyType.decoder"

Uses the given Options to match the JSON format of derived FromJSON and ToJSON instances.

deriveElmJSONEncoder :: forall a. (HasDatatypeInfo a, HasElmType a, All2 (HasElmEncoder Value) (Code a)) => Options -> Options -> Qualified -> Definition

Automatically create an Elm JSON encoder definition given a Haskell type.

This is suitable for use as a HasElmEncoderDefinition Value instance:

instance HasElmEncoderDefinition Value MyType where
  elmEncoderDefinition =
    deriveElmJSONEncoder @MyType defaultOptions defaultOptions "Api.MyType.encoder"

Uses the given Options to match the JSON format of derived FromJSON and ToJSON instances.

jsonDefinitions :: forall t. (HasElmDefinition t, HasElmEncoderDefinition Value t, HasElmDecoderDefinition Value t) => [Definition]

A shorthand for a list of the type definitions for jsonDefinitions @MyType is a shorthand for creating a list of its elmDefinition, elmEncoderDefinition @Value, and elmDecoderDefinition @Value.