Documentation

Parse querystring from the Request into a datatype. See FromQuery

data Filters = Filters
  { search :: Text
  }
  deriving (ToQuery, FromQuery, Generic)

page :: (Hyperbole :> es) => Page es '[Todos]
page = do
  filters <- query @Filters
  todos <- loadTodos filters
  pure $ do
    hyper Todos $ todosView todos

Update the client's querystring to an encoded datatype. See ToQuery

instance HyperView Todos es where
  data Action Todos
    = SetSearch Text
    deriving (Generic, ViewAction)

  update (SetSearch term) = do
    let filters = Filters term
    setQuery filters
    todos <- loadTodos filters
    pure $ todosView todos

Parse a single query parameter. Return a 400 status if missing or if parsing fails. See decodeParam

page' :: (Hyperbole :> es) => Page es '[Message]
page' = do
  msg <- param "message"
  pure $ do
    hyper Message $ messageView msg

Parse a single parameter from the query string if available

page :: (Hyperbole :> es, Concurrent :> es, Reader Text :> es) => Page es '[SlowReader]
page = do
  pure $ hyper SlowReader $ messageView "..."

Modify the client's querystring to set a single parameter. See encodeParam

instance HyperView Message es where
  data Action Message
    = SetMessage Text
    deriving (Generic, ViewAction)

  update (SetMessage msg) = do
    setParam "message" msg
    pure $ messageView msg

Delete a single parameter from the query string

Return the querystring from Request as a QueryData