mirror of
https://github.com/ilyakooo0/elm-bridge.git
synced 2024-09-11 14:05:55 +03:00
74 lines
1.8 KiB
Markdown
74 lines
1.8 KiB
Markdown
Elm Bridge
|
|
=====
|
|
|
|
[](https://travis-ci.org/agrafix/elm-bridge)
|
|
|
|
[](http://packdeps.haskellers.com/reverse/elm-bridge)
|
|
|
|
## Intro
|
|
|
|
Hackage: [elm-bridge](http://hackage.haskell.org/package/elm-bridge)
|
|
|
|
Building the bridge from [Haskell](http://haskell.org) to [Elm](http://elm-lang.org) and back. Define types once, use on both sides and enjoy easy (de)serialisation. Cheers!
|
|
|
|
Note that the [bartavelle/json-helpers](http://package.elm-lang.org/packages/bartavelle/json-helpers/latest/) package, with version >= 1.1.0, is expected by the generated Elm modules.
|
|
|
|
## Usage
|
|
|
|
```haskell
|
|
{-# LANGUAGE TemplateHaskell #-}
|
|
import Elm.Derive
|
|
import Elm.Module
|
|
|
|
import Data.Proxy
|
|
|
|
data Foo
|
|
= Foo
|
|
{ f_name :: String
|
|
, f_blablub :: Int
|
|
} deriving (Show, Eq)
|
|
|
|
deriveElmDef defaultOpts ''Foo
|
|
|
|
main :: IO ()
|
|
main =
|
|
putStrLn $ makeElmModule "Foo"
|
|
[ DefineElm (Proxy :: Proxy Foo)
|
|
]
|
|
|
|
```
|
|
|
|
Output will be:
|
|
|
|
```elm
|
|
module Foo where
|
|
|
|
import Json.Decode
|
|
import Json.Decode exposing ((:=))
|
|
import Json.Encode
|
|
|
|
|
|
type alias Foo =
|
|
{ f_name: String
|
|
, f_blablub: Int
|
|
}
|
|
|
|
jsonDecFoo =
|
|
("f_name" := Json.Decode.string) `Json.Decode.andThen` \pf_name ->
|
|
("f_blablub" := Json.Decode.int) `Json.Decode.andThen` \pf_blablub ->
|
|
Json.Decode.succeed {f_name = pf_name, f_blablub = pf_blablub}
|
|
|
|
jsonEncFoo val =
|
|
Json.Encode.object
|
|
[ ("f_name", Json.Encode.string val.f_name)
|
|
, ("f_blablub", Json.Encode.int val.f_blablub)
|
|
]
|
|
```
|
|
|
|
For more usage examples check the tests or the examples dir.
|
|
|
|
## Install
|
|
|
|
* Using cabal: `cabal install elm-bridge`
|
|
* From Source: `git clone https://github.com/agrafix/elm-bridge.git && cd elm-bridge && cabal install`
|