Documentation

Valid responses for a Hyperbole effect. Use notFound, etc instead. Reminds you to use load in your Page

myPage :: (Hyperbole :> es) => Page es Response
myPage = do
  -- compiler error: () does not equal Response
  pure ()

Hyperbole applications are divided into Pages. Each Page must load the whole page , and handle each type of HyperView

myPage :: (Hyperbole :> es) => Page es Response
myPage = do
  handle messages
  load pageView

pageView = do
  el_ "My Page"
  hyper (Message 1) $ messageView "Starting Message"

An action, with its corresponding id

Low level effect mapping request/response to either HTTP or WebSockets

In any load or handle, you can use this Effect to get extra request information or control the response manually.

For most Pages, you won't need to use this effect directly. Use custom Routes for request info, and return Views to respond

Run the Hyperbole effect to Server

Return all information about the Request

Return the request path

>>> reqPath
["users", "100"]

Return the request body as a Web.FormUrlEncoded.Form

Prefer using Type-Safe Forms when possible

Lookup a session variable by keyword

load $ do
  tok <- session "token"
  ...

Set a session variable by keyword

load $ do
  t <- reqParam "token"
  setSession "token" t
  ...

Clear the user's session

Return the entire Query

myPage :: Page es Response
myPage = do
  load $ do
    q <- reqParams
    case lookupParam "token" q of
      Nothing -> pure $ errorView "Missing Token in Query String"
      Just t -> do
        sideEffectUsingToken token
        pure myPageView

Lookup the query param in the Query

Require a given parameter from the Query arguments

myPage :: Page es Response
myPage = do
  load $ do
    token <- reqParam "token"
    sideEffectUsingToken token
    pure myPageView

Respond immediately with 404 Not Found

userLoad :: (Hyperbole :> es, Users :> es) => UserId -> Eff es User
userLoad uid = do
  mu <- send (LoadUser uid)
  maybe notFound pure mu

myPage :: (Hyperbole :> es, Users :> es) => Eff es View
myPage = do
  load $ do
    u <- userLoad 100
    -- skipped if user = Nothing
    pure $ userView u

Respond immediately with a parse error

Redirect immediately to the Url

Respond with the given view, and stop execution

Manually set the response to the given view. Normally you return a View from load or handle instead of using this

The load handler is run when the page is first loaded. Run any side effects needed, then return a view of the full page

myPage :: (Hyperbole :> es) => UserId -> Page es Response
myPage userId = do
  load $ do
    user <- loadUserFromDatabase userId
    pure $ userPageView user

A handler is run when an action for that HyperView is triggered. Run any side effects needed, then return a view of the corresponding type

myPage :: (Hyperbole :> es) => Page es Response
myPage = do
  handle messages
  load pageView

messages :: (Hyperbole :> es, MessageDatabase) => Message -> MessageAction -> Eff es (View Message ())
messages (Message mid) ClearMessage = do
  deleteMessageSideEffect mid
  pure $ messageView ""

messages (Message mid) (Louder m) = do
  let new = m <> "!"
  saveMessageSideEffect mid new
  pure $ messageView new

Run a Page in Hyperbole