Package Exports
- http-responder
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (http-responder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
HTTP Responder
A simple and easy way to create and use HTTP errors (extending the original node.js Error) whilst giving you the control over what is seen.
const hr = require('http-responder'); => and you're good to go!
To create a custom error: new hr(statusCode [, options]);
statusCode: Number your error's status code.
options: Error | {} the options object may be a nodejs error or include:
message: your custom error message.data: whatever data you what to send (also shows up in the payload property) - has to be truthy.
(new hr(); will give you a 500 status error default.)
Porperties:
status: the same as 'statusCode' - for compabilitypayload: holds only a pretty version of the error (ie, no stack), so no sensitive information will be leakedisRespError: a boolean saying if the object is of type HttpResponder
Or, you can create them by the pre-made static functions (hr.notFound() for example...).
Methods:
to append an Error to your custom one: appendError(error).
error: Error the error you want to append.
Static function list:
hr.continue(),
hr.switchingProtocols(),
hr.processing(),
hr.ok(),
hr.created(),
hr.accepted(),
hr.nonAuthoritativeInformation(),
hr.noContent(),
hr.resetContent(),
hr.partialContent(),
hr.multiStatus(),
hr.multipleChoices(),
hr.movedPermanently(),
hr.movedTemporarily(),
hr.seeOther(),
hr.notModified(),
hr.useProxy(),
hr.temporaryRedirect(),
hr.badRequest(),
hr.unauthorized(),
hr.paymentRequired(),
hr.forbidden(),
hr.notFound(),
hr.methodNotAllowed(),
hr.notAcceptable(),
hr.proxyAuthenticationRequired(),
hr.requestTimeOut(),
hr.conflict(),
hr.gone(),
hr.lengthRequired(),
hr.preconditionFailed(),
hr.requestEntityTooLarge(),
hr.requestUriTooLarge(),
hr.unsupportedMediaType(),
hr.requestedRangeNotSatisfiable(),
hr.expectationFailed(),
hr.iAmATeapot(),
hr.unprocessableEntity(),
hr.locked(),
hr.failedDependency(),
hr.unorderedCollection(),
hr.upgradeRequired(),
hr.preconditionRequired(),
hr.tooManyRequests(),
hr.requestHeaderFieldsTooLarge(),
hr.unavailableForLegalReasons(),
hr.internalServerError(),
hr.notImplemented(),
hr.badGateway(),
hr.serviceUnavailable(),
hr.gatewayTimeOut(),
hr.httpVersionNotSupported(),
hr.variantAlsoNegotiates(),
hr.insufficientStorage(),
hr.bandwidthLimitExceeded(),
hr.notExtended(),
hr.networkAuthenticationRequired()