Module

QuickServe

Package: purescript-quickserve
Repository: paf31/purescript-quickserve

#Servable Source

class Servable server  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 (Effect Unit)

Instances

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

#IsResponse Source

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)

#IsRequest Source

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)

#JSON Source

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)

#Method Source

newtype Method (m :: Symbol) response

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

Constructors

Method (Aff response)

Instances

Newtype (Method m response) _
Functor (Method m)
Apply (Method m)
Applicative (Method m)
Bind (Method m)
Monad (Method m)
MonadEffect (Method m)
MonadAff (Method m)
(IsSymbol method, IsResponse response) => Servable (Method method response)

#GET Source

type GET = Method "GET"

A resource which responds to GET requests.

#POST Source

type POST = Method "POST"

A resource which responds to POST requests.

#PUT Source

type PUT = Method "PUT"

A resource which responds to PUT requests.

#RequestBody Source

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 service) => Servable (RequestBody request -> service)

#Capture Source

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 service) => Servable (Capture -> service)

#quickServe Source

quickServe :: forall server. Servable server => ListenOptions -> server -> Effect 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!""

#ServableList Source

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

Members

serveListWith :: RLProxy l -> Record r -> Request -> Response -> List String -> Maybe (Effect Unit)

Instances

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

Modules: QuickServe