Spock · Tutorials

Spock API reference

These package versions are built together from the Spock repository. Links between them stay within this reference; available dependency documentation links to Hackage.

Haskell in the browser

Spock-api-ghcjs 0.15.0.1 pairs with Spock-api 0.17.0.0. The client reference is generated from GHC JavaScript 9.12.2 interfaces; the native libraries use GHC 9.14.1. Start with callEndpoint and browserClient, or follow the shared browser/server tutorial.

For typed client-side navigation, see route and mountRouter.

Handling requests and responses

Web.Spock reexports the Web.Spock.Action module from Spock-core. Start there for request parsing and response helpers.

• param: typed query and form parameters
• params: all request parameters
• jsonBody: JSON request bodies
• body: raw request bytes
• header: request headers
• filesMulti: file uploads
• setHeader: response headers
• text: plain-text responses

Typed path captures are arguments to your route handler. Set status and headers before sending a response; response helpers finish the action.

Source repository · Generated with Cabal and Haddock.