Payload.ResponseTypes

newtype Response r

The type of a server response, before encoding the body. Responses with modified statuses or headers can be created by returning this type (directly or via helper functions).

Constructors

• Response { body :: r, headers :: Headers, status :: HttpStatus }

Instances

• Newtype (Response a) _
• (Eq a) => Eq (Response a)
• (Show a) => Show (Response a)

type ResponseContent r = { body :: r, headers :: Headers, status :: HttpStatus }

type HttpStatus = { code :: Int, reason :: String }

data Empty

An empty response body

Constructors

• Empty

newtype Json a

A JSON response body

Constructors

• Json a

data Failure

All server error responses ultimately resolve into this type

Constructors

• Forward String
• Error RawResponse

Instances

• Show Failure

type RawResponse = Response ResponseBody

All server responses ultimately resolve into this type.

data ResponseBody

The base types of body responses that can be returned.

Constructors

• StringBody String
• StreamBody UnsafeStream
• EmptyBody

Instances

• Eq ResponseBody
• Show ResponseBody

data UnsafeStream

type Result a = ExceptT Failure Aff a

Internally handlers and guards all de-sugar into this type.