Response.md

July 11, 2018 · View on GitHub

Module Node.Express.Response

setStatus :: Int -> Handler

Set status code.

getResponseHeader :: String -> HandlerM (Maybe String)

Return response header value.

setResponseHeader :: forall a. String -> a -> Handler

Set response header value.

headersSent :: HandlerM Boolean

Check if headers have been sent already

setContentType :: String -> Handler

Set Content-Type header.

setCookie :: String -> String -> CookieOptions -> Handler

Set cookie by its name using specified options (maxAge, path, etc).

clearCookie :: String -> String -> Handler

Clear cookie.

send :: forall a. a -> Handler

Send a response. Could be object, string, buffer, etc.

sendJson :: forall a. a -> Handler

Send a JSON response. Necessary headers are set automatically.

sendJsonp :: forall a. a -> Handler

Send a JSON response with JSONP support.

redirect :: String -> Handler

Redirect to the given URL setting status to 302.

redirectWithStatus :: Int -> String -> Handler

Redirect to the given URL using custom status.

setLocation :: String -> Handler

Set Location header.

sendFile :: String -> Handler

Send file by its path.

sendFileExt :: forall o. String -> {  | o } -> (Error -> Effect Unit) -> Handler

Send file by its path using specified options and error handler. See http://expressjs.com/4x/api.html#res.sendfile

download :: String -> Handler

Transfer file as an attachment (will prompt user to download).

downloadExt :: String -> String -> (Error -> Effect Unit) -> Handler

Transfer file as an attachment using specified filename and error handler.

render :: forall a. String -> a -> Handler

Render a view with a view model object. Could be object, string, buffer, etc.

end :: Handler

Ends the response process.