Module

HTTPure.Response

Package
purescript-httpure
Repository
cprussin/purescript-httpure

#Response Source

type Response = { headers :: Headers, status :: Status, writeBody :: Response -> Aff Unit }

A Response is a status code, headers, and a body.

#ResponseM Source

type ResponseM = Aff Response

The ResponseM type simply conveniently wraps up an HTTPure monad that returns a response. This type is the return type of all router/route methods.

#send Source

send :: Response -> Response -> Aff Unit

Given an HTTP Response and a HTTPure Response, this method will return a monad encapsulating writing the HTTPure Response to the HTTP Response and closing the HTTP Response.

#response Source

response :: forall b. Body b => Status -> b -> ResponseM

For custom response statuses or providing a body for response codes that don't typically send one.

#response' Source

response' :: forall b. Body b => Status -> Headers -> b -> ResponseM

The same as response but with headers.

#emptyResponse Source

emptyResponse :: Status -> ResponseM

The same as response but without a body.

#emptyResponse' Source

emptyResponse' :: Status -> Headers -> ResponseM

The same as emptyResponse but with headers.

#continue Source

continue :: ResponseM

100

#continue' Source

continue' :: Headers -> ResponseM

100 with headers

#switchingProtocols Source

switchingProtocols :: ResponseM

101

#switchingProtocols' Source

switchingProtocols' :: Headers -> ResponseM

101 with headers

#processing Source

processing :: ResponseM

102

#processing' Source

processing' :: Headers -> ResponseM

102 with headers

#ok Source

ok :: forall b. Body b => b -> ResponseM

200

#ok' Source

ok' :: forall b. Body b => Headers -> b -> ResponseM

200 with headers

#created Source

created :: ResponseM

201

#created' Source

created' :: Headers -> ResponseM

201 with headers

#accepted Source

accepted :: ResponseM

202

#accepted' Source

accepted' :: Headers -> ResponseM

202 with headers

#nonAuthoritativeInformation Source

nonAuthoritativeInformation :: forall b. Body b => b -> ResponseM

203

#nonAuthoritativeInformation' Source

nonAuthoritativeInformation' :: forall b. Body b => Headers -> b -> ResponseM

203 with headers

#noContent Source

noContent :: ResponseM

204

#noContent' Source

noContent' :: Headers -> ResponseM

204 with headers

#resetContent Source

resetContent :: ResponseM

205

#resetContent' Source

resetContent' :: Headers -> ResponseM

205 with headers

#partialContent Source

partialContent :: forall b. Body b => b -> ResponseM

206

#partialContent' Source

partialContent' :: forall b. Body b => Headers -> b -> ResponseM

206 with headers

#multiStatus Source

multiStatus :: forall b. Body b => b -> ResponseM

207

#multiStatus' Source

multiStatus' :: forall b. Body b => Headers -> b -> ResponseM

207 with headers

#alreadyReported Source

alreadyReported :: ResponseM

208

#alreadyReported' Source

alreadyReported' :: Headers -> ResponseM

208 with headers

#iMUsed Source

iMUsed :: forall b. Body b => b -> ResponseM

226

#iMUsed' Source

iMUsed' :: forall b. Body b => Headers -> b -> ResponseM

226 with headers

#multipleChoices Source

multipleChoices :: forall b. Body b => b -> ResponseM

300

#multipleChoices' Source

multipleChoices' :: forall b. Body b => Headers -> b -> ResponseM

300 with headers

#movedPermanently Source

movedPermanently :: forall b. Body b => b -> ResponseM

301

#movedPermanently' Source

movedPermanently' :: forall b. Body b => Headers -> b -> ResponseM

301 with headers

#found Source

found :: forall b. Body b => b -> ResponseM

302

#found' Source

found' :: forall b. Body b => Headers -> b -> ResponseM

302 with headers

#seeOther Source

seeOther :: forall b. Body b => b -> ResponseM

303

#seeOther' Source

seeOther' :: forall b. Body b => Headers -> b -> ResponseM

303 with headers

#notModified Source

notModified :: ResponseM

304

#notModified' Source

notModified' :: Headers -> ResponseM

304 with headers

#useProxy Source

useProxy :: forall b. Body b => b -> ResponseM

305

#useProxy' Source

useProxy' :: forall b. Body b => Headers -> b -> ResponseM

305 with headers

#temporaryRedirect Source

temporaryRedirect :: forall b. Body b => b -> ResponseM

307

#temporaryRedirect' Source

temporaryRedirect' :: forall b. Body b => Headers -> b -> ResponseM

307 with headers

#permanentRedirect Source

permanentRedirect :: forall b. Body b => b -> ResponseM

308

#permanentRedirect' Source

permanentRedirect' :: forall b. Body b => Headers -> b -> ResponseM

308 with headers

#badRequest Source

badRequest :: forall b. Body b => b -> ResponseM

400

#badRequest' Source

badRequest' :: forall b. Body b => Headers -> b -> ResponseM

400 with headers

#unauthorized Source

unauthorized :: ResponseM

401

#unauthorized' Source

unauthorized' :: Headers -> ResponseM

401 with headers

#paymentRequired Source

paymentRequired :: ResponseM

402

#paymentRequired' Source

paymentRequired' :: Headers -> ResponseM

402 with headers

#forbidden Source

forbidden :: ResponseM

403

#forbidden' Source

forbidden' :: Headers -> ResponseM

403 with headers

#notFound Source

notFound :: ResponseM

404

#notFound' Source

notFound' :: Headers -> ResponseM

404 with headers

#methodNotAllowed Source

methodNotAllowed :: ResponseM

405

#methodNotAllowed' Source

methodNotAllowed' :: Headers -> ResponseM

405 with headers

#notAcceptable Source

notAcceptable :: ResponseM

406

#notAcceptable' Source

notAcceptable' :: Headers -> ResponseM

406 with headers

#proxyAuthenticationRequired Source

proxyAuthenticationRequired :: ResponseM

407

#proxyAuthenticationRequired' Source

proxyAuthenticationRequired' :: Headers -> ResponseM

407 with headers

#requestTimeout Source

requestTimeout :: ResponseM

408

#requestTimeout' Source

requestTimeout' :: Headers -> ResponseM

408 with headers

#conflict Source

conflict :: forall b. Body b => b -> ResponseM

409

#conflict' Source

conflict' :: forall b. Body b => Headers -> b -> ResponseM

409 with headers

#gone' Source

gone' :: Headers -> ResponseM

410 with headers

#lengthRequired Source

lengthRequired :: ResponseM

411

#lengthRequired' Source

lengthRequired' :: Headers -> ResponseM

411 with headers

#preconditionFailed Source

preconditionFailed :: ResponseM

412

#preconditionFailed' Source

preconditionFailed' :: Headers -> ResponseM

412 with headers

#payloadTooLarge Source

payloadTooLarge :: ResponseM

413

#payloadTooLarge' Source

payloadTooLarge' :: Headers -> ResponseM

413 with headers

#uRITooLong Source

uRITooLong :: ResponseM

414

#uRITooLong' Source

uRITooLong' :: Headers -> ResponseM

414 with headers

#unsupportedMediaType Source

unsupportedMediaType :: ResponseM

415

#unsupportedMediaType' Source

unsupportedMediaType' :: Headers -> ResponseM

415 with headers

#rangeNotSatisfiable Source

rangeNotSatisfiable :: ResponseM

416

#rangeNotSatisfiable' Source

rangeNotSatisfiable' :: Headers -> ResponseM

416 with headers

#expectationFailed Source

expectationFailed :: ResponseM

417

#expectationFailed' Source

expectationFailed' :: Headers -> ResponseM

417 with headers

#imATeapot Source

imATeapot :: ResponseM

418

#imATeapot' Source

imATeapot' :: Headers -> ResponseM

418 with headers

#misdirectedRequest Source

misdirectedRequest :: ResponseM

421

#misdirectedRequest' Source

misdirectedRequest' :: Headers -> ResponseM

421 with headers

#unprocessableEntity Source

unprocessableEntity :: ResponseM

422

#unprocessableEntity' Source

unprocessableEntity' :: Headers -> ResponseM

422 with headers

#locked Source

locked :: ResponseM

423

#locked' Source

locked' :: Headers -> ResponseM

423 with headers

#failedDependency Source

failedDependency :: ResponseM

424

#failedDependency' Source

failedDependency' :: Headers -> ResponseM

424 with headers

#upgradeRequired Source

upgradeRequired :: ResponseM

426

#upgradeRequired' Source

upgradeRequired' :: Headers -> ResponseM

426 with headers

#preconditionRequired Source

preconditionRequired :: ResponseM

428

#preconditionRequired' Source

preconditionRequired' :: Headers -> ResponseM

428 with headers

#tooManyRequests Source

tooManyRequests :: ResponseM

429

#tooManyRequests' Source

tooManyRequests' :: Headers -> ResponseM

429 with headers

#requestHeaderFieldsTooLarge Source

requestHeaderFieldsTooLarge :: ResponseM

431

#requestHeaderFieldsTooLarge' Source

requestHeaderFieldsTooLarge' :: Headers -> ResponseM

431 with headers

#unavailableForLegalReasons Source

unavailableForLegalReasons :: ResponseM

451

#unavailableForLegalReasons' Source

unavailableForLegalReasons' :: Headers -> ResponseM

451 with headers

#internalServerError Source

internalServerError :: forall b. Body b => b -> ResponseM

500

#internalServerError' Source

internalServerError' :: forall b. Body b => Headers -> b -> ResponseM

500 with headers

#notImplemented Source

notImplemented :: ResponseM

501

#notImplemented' Source

notImplemented' :: Headers -> ResponseM

501 with headers

#badGateway Source

badGateway :: ResponseM

502

#badGateway' Source

badGateway' :: Headers -> ResponseM

502 with headers

#serviceUnavailable Source

serviceUnavailable :: ResponseM

503

#serviceUnavailable' Source

serviceUnavailable' :: Headers -> ResponseM

503 with headers

#gatewayTimeout Source

gatewayTimeout :: ResponseM

504

#gatewayTimeout' Source

gatewayTimeout' :: Headers -> ResponseM

504 with headers

#hTTPVersionNotSupported Source

hTTPVersionNotSupported :: ResponseM

505

#hTTPVersionNotSupported' Source

hTTPVersionNotSupported' :: Headers -> ResponseM

505 with headers

#variantAlsoNegotiates Source

variantAlsoNegotiates :: ResponseM

506

#variantAlsoNegotiates' Source

variantAlsoNegotiates' :: Headers -> ResponseM

506 with headers

#insufficientStorage Source

insufficientStorage :: ResponseM

507

#insufficientStorage' Source

insufficientStorage' :: Headers -> ResponseM

507 with headers

#loopDetected Source

loopDetected :: ResponseM

508

#loopDetected' Source

loopDetected' :: Headers -> ResponseM

508 with headers

#notExtended Source

notExtended :: ResponseM

510

#notExtended' Source

notExtended' :: Headers -> ResponseM

510 with headers

#networkAuthenticationRequired Source

networkAuthenticationRequired :: ResponseM

511

#networkAuthenticationRequired' Source

networkAuthenticationRequired' :: Headers -> ResponseM

511 with headers

Modules
HTTPure
HTTPure.Body
HTTPure.Headers
HTTPure.Lookup
HTTPure.Method
HTTPure.Path
HTTPure.Query
HTTPure.Request
HTTPure.Response
HTTPure.Server
HTTPure.Status
HTTPure.Utils
HTTPure.Version