Web.Hyperbole.Effect.Hyperbole

Documentation

data Hyperbole (a :: Type -> Type) b where

The Hyperbole Effect allows you to access information in the Request, manually respondEarly, and manipulate the Client session and query.

Constructors

GetRequest :: forall (a :: Type -> Type). Hyperbole a Request

RespondEarly :: forall (a :: Type -> Type) b. Response -> Hyperbole a b

ModClient :: forall (a :: Type -> Type). (Client -> Client) -> Hyperbole a ()

GetClient :: forall (a :: Type -> Type). Hyperbole a Client

Instances

type DispatchOf Hyperbole

Defined in Web.Hyperbole.Effect.Hyperbole

type DispatchOf Hyperbole = 'Dynamic

runHyperbole :: forall (es :: [Effect]). Server :> es => Eff (Hyperbole ': es) Response -> Eff es Response

Run the Hyperbole effect to Server

data HyperState

Constructors

HyperState

Fields

• request :: Request
• client :: Client