Network.Wai.Middleware.Clacks

The Clacks middleware adds a X-Clacks-Overhead header to every response served by a Wai server.

To use this package to keep the legacy of Terry Pratchett alive, simply pass your wai application to clacks gnuTerryPratchett before passing it to the run function:

import Network.Wai.Handler.Warp (run)
import Network.Wai.Middleware.Clacks (clacks, gnuTerryPratchett)

import MyLib.App (myApp)

main :: IO ()
main = run 8080 $ clacks gnuTerryPratchett myApp

You can use the Clacks type to build a custom configuration for the clacks function, allowing you to pass anything into the header:

import Data.List.NonEmpty (NonEmpty(..))
import Network.Wai (Middleware)
import Network.Wai.Middleware.Clacks (Clacks(..), clacks)

myClacks :: Middleware
myClacks = clacks $ Clacks $ "GNU Ada Lovelace" :| ["GNU Hoban Washburne", "GNU Shephard Book"]

For more information about the Clacks or the X-Clacks-Overhead header, check out the GNU Terry Pratchett website.

Documentation

clacks :: Clacks -> Middleware

A Network.Wai Middleware that adds a X-Clacks-Overhead header containing the messages in the Clacks configuration.

newtype Clacks

Configuration for the Clacks WAI Middleware.

Constructors

Clacks

Fields

• clacksMessages :: NonEmpty Text

  The Clacks Messages to Include in the Header.

Instances

Eq Clacks

Defined in Network.Wai.Middleware.Clacks

Methods

(==) :: Clacks -> Clacks -> Bool

(/=) :: Clacks -> Clacks -> Bool

Read Clacks

Defined in Network.Wai.Middleware.Clacks

Methods

readsPrec :: Int -> ReadS Clacks

readList :: ReadS [Clacks]

readPrec :: ReadPrec Clacks

readListPrec :: ReadPrec [Clacks]

Show Clacks

Defined in Network.Wai.Middleware.Clacks

Methods

showsPrec :: Int -> Clacks -> ShowS

show :: Clacks -> String

showList :: [Clacks] -> ShowS

gnuTerryPratchett :: Clacks

Sends a Clacks message of GNU Terry Pratchett.

clacksHeaderName :: HeaderName

The name of the Clacks header.