QuickServe

class Servable eff server | server -> eff where

A type class for types of values which define servers.

Servers are built from the Method data type, which defines the method, record types which define routes and function types which make things like the request body and query parameters available.

Members

• serveWith :: server -> Request -> Response -> List String -> Maybe (Eff (http :: HTTP | eff) Unit)

Instances

• (IsSymbol method, IsResponse response) => Servable eff (Method method eff response)
• (IsRequest request, Servable eff service) => Servable eff (RequestBody request -> service)
• (Servable eff service) => Servable eff (Capture -> service)
• (RowToList r l, ServableList eff l r) => Servable eff (Record r)

quickServe :: forall server eff. Servable (console :: CONSOLE | eff) server => ListenOptions -> server -> Eff (console :: CONSOLE, http :: HTTP | eff) Unit

Start a web server given some Servable type and an implementation of that type.

For example:

opts = { hostname: "localhost"
       , port: 3000
       , backlog: Nothing
       }

main = quickServe opts hello where
  hello :: GET String
  hello = pure "Hello, World!""

class IsResponse response  where

A type class for response data.

Members

• encodeResponse :: response -> String
• responseType :: Proxy response -> String

Instances

• IsResponse String
• (Encode a) => IsResponse (JSON a)

class IsRequest request  where

A type class for request data.

Members

• decodeRequest :: String -> Either String request
• requestType :: Proxy request -> String

Instances

• IsRequest String
• (Decode a) => IsRequest (JSON a)

newtype JSON a

A request/response type which uses JSON as its data representation.

Constructors

• JSON a

Instances

• Newtype (JSON a) _
• (Encode a) => IsResponse (JSON a)
• (Decode a) => IsRequest (JSON a)

newtype Method (m :: Symbol) eff response

A Servable type constructor which indicates the expected method (GET, POST, PUT, etc.) using a type-level string.

Constructors

• Method (Aff (http :: HTTP | eff) response)

Instances

• Newtype (Method m eff response) _
• Functor (Method m eff)
• Apply (Method m eff)
• Applicative (Method m eff)
• Bind (Method m eff)
• Monad (Method m eff)
• MonadEff (http :: HTTP | eff) (Method m eff)
• MonadAff (http :: HTTP | eff) (Method m eff)
• (IsSymbol method, IsResponse response) => Servable eff (Method method eff response)

type GET = Method "GET"

A resource which responds to GET requests.

type POST = Method "POST"

A resource which responds to POST requests.

type PUT = Method "PUT"

A resource which responds to PUT requests.

newtype RequestBody a

RequestBody can be used to read the request body.

To read the request body, use a function type with a function argument type which has an IsRequest instance:

main = quickServe opts echo where
  echo :: RequestBody String -> GET String
  echo (RequestBody s) = pure s

Constructors

• RequestBody a

Instances

• Newtype (RequestBody a) _
• (IsRequest request, Servable eff service) => Servable eff (RequestBody request -> service)

newtype Capture

Capture can be used to capture a part of the route.

Use a function type with a function argument of type Capture:

main = quickServe opts echo' where
  echo' :: Capture -> GET String
  echo' (Capture s) = pure s

Constructors

• Capture String

Instances

• Newtype Capture _
• (Servable eff service) => Servable eff (Capture -> service)

class ServableList eff (l :: RowList) (r :: Row Type) | l -> r where

Members

• serveListWith :: LProxy l -> Record r -> Request -> Response -> List String -> Maybe (Eff (http :: HTTP | eff) Unit)

Instances

• ServableList eff Nil ()
• (IsSymbol route, Servable eff s, ServableList eff l r1, RowCons route s r1 r) => ServableList eff (Cons route s l) r