Skip to content

App.md

Latest commit

 

History

History
162 lines (106 loc) · 3.08 KB

App.md

File metadata and controls

162 lines (106 loc) · 3.08 KB

Module Node.Express.App

AppM

data AppM e a

Monad responsible for application related operations (initial setup mostly).

Instances
instance functorAppM :: Functor (AppM e)
instance applyAppM :: Apply (AppM e)
instance applicativeAppM :: Applicative (AppM e)
instance bindAppM :: Bind (AppM e)
instance monadAppM :: Monad (AppM e)
instance monadEffAppM :: MonadEff eff (AppM eff)

App

type App e = AppM (express :: EXPRESS | e) Unit

listenHttp

listenHttp :: forall e1 e2. App e1 -> Port -> (Event -> Eff e2 Unit) -> ExpressM e1 Server

Run application on specified port and execute callback after launch. HTTP version

listenHttps

listenHttps :: forall e1 e2 opts. App e1 -> Port -> opts -> (Event -> Eff e2 Unit) -> ExpressM e1 Server

Run application on specified port and execute callback after launch. HTTPS version

apply

apply :: forall e. App e -> Application -> ExpressM e Unit

Apply App actions to existent Express.js application

use

use :: forall e. Handler e -> App e

Use specified middleware handler.

useExternal

useExternal :: forall e. Fn3 Request Response (ExpressM e Unit) (ExpressM e Unit) -> App e

Use any function as middleware. Introduced to ease usage of a bunch of external middleware written for express.js. See http://expressjs.com/4x/api.html#middleware

useAt

useAt :: forall e. Path -> Handler e -> App e

Use specified middleware only on requests matching path.

useOnParam

useOnParam :: forall e. String -> (String -> Handler e) -> App e

Process route param with specified handler.

useOnError

useOnError :: forall e. (Error -> Handler e) -> App e

Use error handler. Probably this should be the last middleware to attach.

getProp

getProp :: forall e a. (IsForeign a) => String -> AppM (express :: EXPRESS | e) (Maybe a)

Get application property. See http://expressjs.com/4x/api.html#app-settings

setProp

setProp :: forall e a. (IsForeign a) => String -> a -> App e

Set application property. See http://expressjs.com/4x/api.html#app-settings

http

http :: forall e r. (RoutePattern r) => Method -> r -> Handler e -> App e

Bind specified handler to handle request matching route and method.

get

get :: forall e r. (RoutePattern r) => r -> Handler e -> App e

Shortcut for http GET.

post

post :: forall e r. (RoutePattern r) => r -> Handler e -> App e

Shortcut for http POST.

put

put :: forall e r. (RoutePattern r) => r -> Handler e -> App e

Shortcut for http PUT.

delete

delete :: forall e r. (RoutePattern r) => r -> Handler e -> App e

Shortcut for http DELETE.

all

all :: forall e r. (RoutePattern r) => r -> Handler e -> App e

Shortcut for http ALL (match on any http method).