Snap.Elm

This module provides a few functions for conveniently serving Elm files through the Snap web framework. Any changes made to the served files will be reflected in the browser upon a refresh.

The easiest way to get started is to use the default ElmOptions:

 app = makeSnaplet ... $ do
     opts <- defaultElmOptions
     ...
     addRoutes $ routes opts
     ...

Then, provide routes to the Elm runtime, and to any Elm files you wish to serve.

 routes opts =
     [ ("/elm", serveElm opts "static/elm/test.elm")
     , ...
     , serveElmRuntime opts
     ]

Additionally, you can customize the URI of the Elm runtime, the file path to the Elm runtime, or the paths to the directores that Elm will use to build and cache the compiled files.

 app = makeSnaplet ... $ do
     opts <- mkElmOptions
               "route/to/use/for/runtime.js"
               (Just "/my/own/local/file/for/the/actual/runtime.js")
               (Just "/tmp/location/for/build/dir")
               (Just "/tmp/location/for/cache/dir")
     ...
     addRoutes $ routes opts
     ...

Documentation

data ElmOptions

A set of options to coordinate the serving of Elm files and runtime.

Constructors

ElmOptions

Fields

elmRuntimeURI :: ByteString

elmRuntimePath :: FilePath

elmBuildPath :: FilePath

elmCachePath :: FilePath

defaultElmOptions :: MonadIO m => m ElmOptions

mkElmOptions

Arguments

:: MonadIO m

=> ByteString

Route at which to serve Elm runtime

-> Maybe FilePath

FilePath to custom Elm runtime

-> Maybe FilePath

FilePath to custom build directory

-> Maybe FilePath

FilePath to custom cache directory

-> m ElmOptions

Construct a custom set of options.

serveElm :: MonadSnap m => ElmOptions -> FilePath -> m ()

Serve an Elm file. The ElmOptions argument can be constructed at the initialization of your app.

serveElmRuntime :: MonadSnap m => ElmOptions -> (ByteString, m ())

A route handler for the Elm runtime. If given the ElmOptions used by serveElm, it will place the runtime at the route the Elm file will expect, as per the src=".../runtime.js" element included in the compiled file's head section.