HTTPure.Response

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

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

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 :: forall m. MonadEffect m => MonadAff m => Response -> Response -> m 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 :: forall m b. MonadAff m => Body b => Status -> b -> m Response

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

response' :: forall m b. MonadAff m => Body b => Status -> Headers -> b -> m Response

The same as response but with headers.

emptyResponse :: forall m. MonadAff m => Status -> m Response

The same as response but without a body.

emptyResponse' :: forall m. MonadAff m => Status -> Headers -> m Response

The same as emptyResponse but with headers.

continue :: forall m. MonadAff m => m Response

100

continue' :: forall m. MonadAff m => Headers -> m Response

100 with headers

switchingProtocols :: forall m. MonadAff m => m Response

101

switchingProtocols' :: forall m. MonadAff m => Headers -> m Response

101 with headers

processing :: forall m. MonadAff m => m Response

102

processing' :: forall m. MonadAff m => Headers -> m Response

102 with headers

ok :: forall m b. MonadAff m => Body b => b -> m Response

200

ok' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

200 with headers

created :: forall m. MonadAff m => m Response

201

created' :: forall m. MonadAff m => Headers -> m Response

201 with headers

accepted :: forall m. MonadAff m => m Response

202

accepted' :: forall m. MonadAff m => Headers -> m Response

202 with headers

nonAuthoritativeInformation :: forall m b. MonadAff m => Body b => b -> m Response

203

nonAuthoritativeInformation' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

203 with headers

noContent :: forall m. MonadAff m => m Response

204

noContent' :: forall m. MonadAff m => Headers -> m Response

204 with headers

resetContent :: forall m. MonadAff m => m Response

205

resetContent' :: forall m. MonadAff m => Headers -> m Response

205 with headers

partialContent :: forall m b. MonadAff m => Body b => b -> m Response

206

partialContent' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

206 with headers

multiStatus :: forall m b. MonadAff m => Body b => b -> m Response

207

multiStatus' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

207 with headers

alreadyReported :: forall m. MonadAff m => m Response

208

alreadyReported' :: forall m. MonadAff m => Headers -> m Response

208 with headers

iMUsed :: forall m b. MonadAff m => Body b => b -> m Response

226

iMUsed' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

226 with headers

multipleChoices :: forall m b. MonadAff m => Body b => b -> m Response

300

multipleChoices' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

300 with headers

movedPermanently :: forall m b. MonadAff m => Body b => b -> m Response

301

movedPermanently' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

301 with headers

found :: forall m b. MonadAff m => Body b => b -> m Response

302

found' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

302 with headers

seeOther :: forall m b. MonadAff m => Body b => b -> m Response

303

seeOther' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

303 with headers

notModified :: forall m. MonadAff m => m Response

304

notModified' :: forall m. MonadAff m => Headers -> m Response

304 with headers

useProxy :: forall m b. MonadAff m => Body b => b -> m Response

305

useProxy' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

305 with headers

temporaryRedirect :: forall m b. MonadAff m => Body b => b -> m Response

307

temporaryRedirect' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

307 with headers

permanentRedirect :: forall m b. MonadAff m => Body b => b -> m Response

308

permanentRedirect' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

308 with headers

badRequest :: forall m b. MonadAff m => Body b => b -> m Response

400

badRequest' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

400 with headers

unauthorized :: forall m. MonadAff m => m Response

401

unauthorized' :: forall m. MonadAff m => Headers -> m Response

401 with headers

paymentRequired :: forall m. MonadAff m => m Response

402

paymentRequired' :: forall m. MonadAff m => Headers -> m Response

402 with headers

forbidden :: forall m. MonadAff m => m Response

403

forbidden' :: forall m. MonadAff m => Headers -> m Response

403 with headers

notFound :: forall m. MonadAff m => m Response

404

notFound' :: forall m. MonadAff m => Headers -> m Response

404 with headers

methodNotAllowed :: forall m. MonadAff m => m Response

405

methodNotAllowed' :: forall m. MonadAff m => Headers -> m Response

405 with headers

notAcceptable :: forall m. MonadAff m => m Response

406

notAcceptable' :: forall m. MonadAff m => Headers -> m Response

406 with headers

proxyAuthenticationRequired :: forall m. MonadAff m => m Response

407

proxyAuthenticationRequired' :: forall m. MonadAff m => Headers -> m Response

407 with headers

requestTimeout :: forall m. MonadAff m => m Response

408

requestTimeout' :: forall m. MonadAff m => Headers -> m Response

408 with headers

conflict :: forall m b. MonadAff m => Body b => b -> m Response

409

conflict' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

409 with headers

gone :: forall m. MonadAff m => m Response

410

gone' :: forall m. MonadAff m => Headers -> m Response

410 with headers

lengthRequired :: forall m. MonadAff m => m Response

411

lengthRequired' :: forall m. MonadAff m => Headers -> m Response

411 with headers

preconditionFailed :: forall m. MonadAff m => m Response

412

preconditionFailed' :: forall m. MonadAff m => Headers -> m Response

412 with headers

payloadTooLarge :: forall m. MonadAff m => m Response

413

payloadTooLarge' :: forall m. MonadAff m => Headers -> m Response

413 with headers

uRITooLong :: forall m. MonadAff m => m Response

414

uRITooLong' :: forall m. MonadAff m => Headers -> m Response

414 with headers

unsupportedMediaType :: forall m. MonadAff m => m Response

415

unsupportedMediaType' :: forall m. MonadAff m => Headers -> m Response

415 with headers

rangeNotSatisfiable :: forall m. MonadAff m => m Response

416

rangeNotSatisfiable' :: forall m. MonadAff m => Headers -> m Response

416 with headers

expectationFailed :: forall m. MonadAff m => m Response

417

expectationFailed' :: forall m. MonadAff m => Headers -> m Response

417 with headers

imATeapot :: forall m. MonadAff m => m Response

418

imATeapot' :: forall m. MonadAff m => Headers -> m Response

418 with headers

misdirectedRequest :: forall m. MonadAff m => m Response

421

misdirectedRequest' :: forall m. MonadAff m => Headers -> m Response

421 with headers

unprocessableEntity :: forall m. MonadAff m => m Response

422

unprocessableEntity' :: forall m. MonadAff m => Headers -> m Response

422 with headers

locked :: forall m. MonadAff m => m Response

423

locked' :: forall m. MonadAff m => Headers -> m Response

423 with headers

failedDependency :: forall m. MonadAff m => m Response

424

failedDependency' :: forall m. MonadAff m => Headers -> m Response

424 with headers

upgradeRequired :: forall m. MonadAff m => m Response

426

upgradeRequired' :: forall m. MonadAff m => Headers -> m Response

426 with headers

preconditionRequired :: forall m. MonadAff m => m Response

428

preconditionRequired' :: forall m. MonadAff m => Headers -> m Response

428 with headers

tooManyRequests :: forall m. MonadAff m => m Response

429

tooManyRequests' :: forall m. MonadAff m => Headers -> m Response

429 with headers

requestHeaderFieldsTooLarge :: forall m. MonadAff m => m Response

431

requestHeaderFieldsTooLarge' :: forall m. MonadAff m => Headers -> m Response

431 with headers

unavailableForLegalReasons :: forall m. MonadAff m => m Response

451

unavailableForLegalReasons' :: forall m. MonadAff m => Headers -> m Response

451 with headers

internalServerError :: forall m b. MonadAff m => Body b => b -> m Response

500

internalServerError' :: forall m b. MonadAff m => Body b => Headers -> b -> m Response

500 with headers

notImplemented :: forall m. MonadAff m => m Response

501

notImplemented' :: forall m. MonadAff m => Headers -> m Response

501 with headers

badGateway :: forall m. MonadAff m => m Response

502

badGateway' :: forall m. MonadAff m => Headers -> m Response

502 with headers

serviceUnavailable :: forall m. MonadAff m => m Response

503

serviceUnavailable' :: forall m. MonadAff m => Headers -> m Response

503 with headers

gatewayTimeout :: forall m. MonadAff m => m Response

504

gatewayTimeout' :: forall m. MonadAff m => Headers -> m Response

504 with headers

hTTPVersionNotSupported :: forall m. MonadAff m => m Response

505

hTTPVersionNotSupported' :: forall m. MonadAff m => Headers -> m Response

505 with headers

variantAlsoNegotiates :: forall m. MonadAff m => m Response

506

variantAlsoNegotiates' :: forall m. MonadAff m => Headers -> m Response

506 with headers

insufficientStorage :: forall m. MonadAff m => m Response

507

insufficientStorage' :: forall m. MonadAff m => Headers -> m Response

507 with headers

loopDetected :: forall m. MonadAff m => m Response

508

loopDetected' :: forall m. MonadAff m => Headers -> m Response

508 with headers

notExtended :: forall m. MonadAff m => m Response

510

notExtended' :: forall m. MonadAff m => Headers -> m Response

510 with headers

networkAuthenticationRequired :: forall m. MonadAff m => m Response

511

networkAuthenticationRequired' :: forall m. MonadAff m => Headers -> m Response

511 with headers