Module

Node.Express.App

Package: purescript-express
Repository: purescript-express/purescript-express

#AppM Source

newtype AppM a

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

Constructors

AppM (Application -> Effect a)

Instances

#App Source

type App = AppM Unit

#listenHttp Source

listenHttp :: App -> Port -> (Event -> Effect Unit) -> Effect HttpServer

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

#listenHttps Source

listenHttps :: forall opts. App -> Port -> opts -> (Event -> Effect Unit) -> Effect HttpsServer

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

#listenHostHttp Source

listenHostHttp :: App -> Port -> Host -> (Event -> Effect Unit) -> Effect HttpServer

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

#listenHostHttps Source

listenHostHttps :: forall opts. App -> Port -> Host -> opts -> (Event -> Effect Unit) -> Effect HttpsServer

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

#listenPipe Source

listenPipe :: App -> Pipe -> (Event -> Effect Unit) -> Effect HttpServer

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

#makeHttpServer Source

makeHttpServer :: App -> Effect HttpServer

Create a Node.HTTP server from the Express application. HTTP version

#makeHttpsServer Source

makeHttpsServer :: App -> Effect HttpsServer

Create a Node.HTTP server from the Express application. HTTPS version

#apply Source

apply :: App -> Application -> Effect Unit

Apply App actions to existent Express.js application

#use Source

use :: Handler -> App

Use specified middleware handler.

#useExternal Source

useExternal :: Middleware -> App

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 Source

useAt :: Path -> Handler -> App

Use specified middleware only on requests matching path.

#useAtExternal Source

useAtExternal :: Path -> Middleware -> App

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

#param Source

param :: String -> (String -> Handler) -> App

Process route param with specified handler.

#useOnError Source

useOnError :: (Error -> Handler) -> App

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

#getProp Source

getProp :: forall a. String -> AppM (Maybe a)

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

#setProp Source

setProp :: forall a. String -> a -> App

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

#http Source

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

Bind specified handler to handle request matching route and method.

#get Source

get :: forall r. RoutePattern r => r -> Handler -> App

Shortcut for http GET.

#post Source

post :: forall r. RoutePattern r => r -> Handler -> App

Shortcut for http POST.

#put Source

put :: forall r. RoutePattern r => r -> Handler -> App

Shortcut for http PUT.

#delete Source

delete :: forall r. RoutePattern r => r -> Handler -> App

Shortcut for http DELETE.

#all Source

all :: forall r. RoutePattern r => r -> Handler -> App

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

#mkApplication Source

mkApplication :: Effect Application

#_getProp Source

_getProp :: forall a. EffectFn2 Application String (Nullable a)

#_setProp Source

_setProp :: forall a. EffectFn3 Application String a Unit

#_http Source

_http :: EffectFn4 Application String Foreign HandlerFnInternal_Req_Res_Next Unit

#_httpServer Source

_httpServer :: EffectFn1 Application HttpServer

#_httpsServer Source

_httpsServer :: EffectFn1 Application HttpsServer

#_listenHttp Source

_listenHttp :: EffectFn3 Application Port (EffectFn1 Event Unit) HttpServer

#_listenHttps Source

_listenHttps :: forall opts. EffectFn4 Application Port opts (EffectFn1 Event Unit) HttpsServer

#_listenHostHttp Source

_listenHostHttp :: EffectFn4 Application Port Host (EffectFn1 Event Unit) HttpServer

#_listenHostHttps Source

_listenHostHttps :: forall opts. EffectFn5 Application Port Host opts (EffectFn1 Event Unit) HttpsServer

#_listenPipe Source

_listenPipe :: EffectFn3 Application Pipe (EffectFn1 Event Unit) HttpServer

#_use Source

_use :: EffectFn2 Application HandlerFnInternal_Req_Res_Next Unit

#_useAt Source

_useAt :: EffectFn3 Application Path HandlerFnInternal_Req_Res_Next Unit

#_param Source

_param :: EffectFn3 Application String HandlerFnInternal_Req_Res_Next_Param Unit

#_useOnError Source

_useOnError :: EffectFn2 Application HandlerFnInternal_Err_Req_Res_Next Unit

Modules: Node.Express.App; Node.Express.Handler; Node.Express.Middleware.CookieParser; Node.Express.Middleware.Static; Node.Express.Request; Node.Express.Response; Node.Express.Settings; Node.Express.Types