Airship.Config

Documentation

data AirshipConfig

An opaque data type encapsulating all Airship-specific configuration options.

We use lenses to modify AirshipConfig values -- though Airship only depends on the microlens library, its lenses are compatible with Control.Lens.

data HeaderInclusion

Constructors

IncludeHeader

OmitHeader

Instances

Eq HeaderInclusion

Defined in Airship.Config

Methods

(==) :: HeaderInclusion -> HeaderInclusion -> Bool

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

Show HeaderInclusion

Defined in Airship.Config

Methods

showsPrec :: Int -> HeaderInclusion -> ShowS

show :: HeaderInclusion -> String

showList :: [HeaderInclusion] -> ShowS

includeTraceHeader :: Lens' AirshipConfig HeaderInclusion

Determines whether or not the Airship-Trace header, which traces the execution of a given request in the Airship decision tree, is included in every HTTP response. While exposing the decision tree is usually innocuous (and makes for significantly easier debugging), you may want to turn it off in certain circumstances.

Defaults to IncludeHeader (enabled).

includeQuipHeader :: Lens' AirshipConfig HeaderInclusion

Determines whether or not the Airship-Quip header, which includes a pithy quote in your response headers, is included in every HTTP response.

Defaults to IncludeHeader (enabled).

defaultAirshipConfig :: AirshipConfig

The default configuration. Use this, in conjunction with the lenses declared above, to get and modify an AirshipConfig to pass to resourceToWai.