A request action with context (). m supplies the application's base effects and a is the result. For a core application m can be IO or a custom transformer stack; full Spock uses its WebStateM base monad.

A per-request computation: it reads the request and typed hook context ctx, accumulates response metadata, and can finish with a response or continue routing. m is the base monad and a is the result.

getContext reads the value supplied by a prehook. lift runs a computation in m; liftIO runs IO when m supports it. Neither changes the hook context. Response helpers finish the action, so statements after text, json, or another response helper are not executed.

Get the original Wai Request object

Read a header

Read a header without converting it to text

Read all cookies. The cookie value will already be urldecoded.

Request ID, when structured logging has been enabled.

Emit a message with structured fields through the configured request logger. With logging disabled this is a no-op. Fields are nested in JSON under fields so they cannot overwrite the request ID or other metadata.

Read a cookie. The cookie value will already be urldecoded. Note that it is more efficient to use cookies if you need do access many cookies during a request handler.

Returns the current request method, e.g. GET

Tries to dected the preferred format of the response using the Accept header

Get the raw request body

Parse the request body as json

Parse the request body as json and fails with 400 status code on error

Get the last uploaded file for each form field name. Use filesMulti to retrieve every file when a field has multiple uploads.

Get every uploaded file grouped by form field name, in upload order.

Get all request (POST + GET) params

Get all request GET params

Get all request POST params

Read a request parameter, searching query (GET) values before form (POST) values. Use paramsPost or paramsGet when the source matters.

Like param, but outputs an error when a param is missing

Get the context of the current request

Run an Action in a different context

Set a response status

Set a response header. If the response header is allowed to occur multiple times (as in RFC 2616), it will be appended. Otherwise the previous value is overwritten. See setMultiHeader.

Redirect to a given url

Abort the current action and jump the next one matching the route

Cookie settings

Default cookie settings, equals

CookieSettings
  { cs_EOL      = CookieValidForSession
  , cs_HTTPOnly = False
  , cs_secure   = False
  , cs_sameSite = Nothing
  , cs_domain   = Nothing
  , cs_path     = Just "/"
  }

Setting cookie expiration

Set a cookie. The cookie value will be urlencoded.

Delete a cookie

Send a ByteString as response body. Provide your own "Content-Type"

Send a lazy ByteString as response body. Provide your own "Content-Type"

Set a response header that can occur multiple times. (eg: Cache-Control)

Send text as a response body. Content-Type will be "text/plain"

Send a text as response body. Content-Type will be "text/html"

Send a file as response

Send json as response. Content-Type will be "application/json"

Use a WAI streaming body to generate a response.

Use a custom WAI response generator as response body.

Respond to the request by running a WAI application. This is usefull in combination with wildcard routes. This can not be used in combination with other request consuming combinators like jsonBody, body, paramsPost, ...

Respond to the request by running WAI middleware. This is usefull in combination with wildcard routes. This can not be used in combination with other request consuming combinators like jsonBody, body, paramsPost, ...

If the Spock application is used as a middleware, you can use this to pass request handling to the underlying application. If Spock is not uses as a middleware, or there is no underlying application this will result in 404 error.

Modify the vault (useful for sharing data between middleware and app)

Query the vault

Convenience Basic authentification provide a title for the prompt and a function to validate user and password. Usage example:

get ("auth" <//> var <//> var) $ \user pass ->
      let checker user' pass' =
              unless (user == user' && pass == pass') $
              do setStatus status401
                 text "err"
      in requireBasicAuth "Foo" checker $ \() -> text "ok"

"Lower level" basic authentification handeling. Does not set any headers that will promt browser users, only looks for an Authorization header in the request and breaks it into username and passwort component if present