status code response helper
npm install express-statusbash
npm install express-status
`
Test
test with code coverage
`bash
gulp
`
unit test only
`bash
gulp test
`
Document
Documentation is managed by commenting code with jsdoc and editing the template.
You can regenerate the README.md by executing
`bash
gulp doc
`
express-status
Exports an object with status codes and extends the express request object by adding a method that will set the status code and return the request object.Example
`javascript
var statusCodes = require()
`* express-status
* .switchingProtocols()
* .processing()
* .ok()
* .created()
* .accepted()
* .nonAuthoritative()
* .noContent()
* .resetContent()
* .partialContent()
* .multiStatus()
* .alreadyReported()
* .imUsed()
* .multipleChoices()
* .movedPermanently()
* .found()
* .seeOther()
* .notModified()
* .useProxy()
* .switchProxy()
* .temporaryRedirect()
* .permanentRedirect()
* .badRequest()
* .unauthorized()
* .forbidden()
* .notFound()
* .methodNotAllowed()
* .notAcceptable()
* .proxyAuthenticationRequired()
* .requestTimeout()
* .conflict()
* .gone()
* .lengthRequired()
* .preconditionFailed()
* .requestEntityTooLarge()
* .requestUriTooLang()
* .unsupportedMediaType()
* .requestedRangeNotSatisfiable()
* .expectationFailed()
* .imATeapot()
* .authenticationTimeout()
* .locked()
* .failedDependency()
* .upgradeRequired()
* .preconditionRequired()
* .tooManyRequests()
* .requestHeaderFieldTooLarge()
* .loginTimeout()
* .unavailableForLegalReasons()
* .internalServerError()
* .notImplemented()
* .badGateway()
* .serviceUnavailable()
* .gatewayTimeout()
* .httpVersionNutSupported()
* .variantAlsoNegotiates()
* .insufficientStorage()
* .loopDetected()
* .notExtended()
* .networkAuthenticationRequired()
$3
sets res status code to 101Kind: static method of express-status
Example
javascript
function(req, res){
res.switchingProtocols().end();
}
`
$3
sets res status code to 102Kind: static method of express-status
Example
javascript
function(req, res){
res.processing().end();
}
`
$3
sets res status code to 200Kind: static method of express-status
Example
javascript
function(req, res){
res.ok().end();
}
`
$3
sets res status code to 201Kind: static method of express-status
Example
javascript
function(req, res){
res.created().end();
}
`
$3
sets res status code to 202Kind: static method of express-status
Example
javascript
function(req, res){
res.accepted().end();
}
`
$3
sets res status code to 203Kind: static method of express-status
Example
javascript
function(req, res){
res.nonAuthoritative().end();
}
`
$3
sets res status code to 204Kind: static method of express-status
Example
javascript
function(req, res){
res.noContent().end();
}
`
$3
sets res status code to 205Kind: static method of express-status
Example
javascript
function(req, res){
res.resetContent().end();
}
`
$3
sets res status code to 206Kind: static method of express-status
Example
javascript
function(req, res){
res.partialContent().end();
}
`
$3
sets res status code to 207Kind: static method of express-status
Example
javascript
function(req, res){
res.multiStatus().end();
}
`
$3
sets res status code to 208Kind: static method of express-status
Example
javascript
function(req, res){
res.alreadyReported().end();
}
`
$3
sets res status code to 226Kind: static method of express-status
Example
javascript
function(req, res){
res.imUsed().end();
}
`
$3
sets res status code to 300Kind: static method of express-status
Example
javascript
function(req, res){
res.multipleChoices().end();
}
`
$3
sets res status code to 301Kind: static method of express-status
Example
javascript
function(req, res){
res.movedPermanently().end();
}
`
$3
sets res status code to 302Kind: static method of express-status
Example
javascript
function(req, res){
res.found().end();
}
`
$3
sets res status code to 303Kind: static method of express-status
Example
javascript
function(req, res){
res.seeOther().end();
}
`
$3
sets res status code to 304Kind: static method of express-status
Example
javascript
function(req, res){
res.notModified().end();
}
`
$3
sets res status code to 305Kind: static method of express-status
Example
javascript
function(req, res){
res.useProxy().end();
}
`
$3
sets res status code to 306Kind: static method of express-status
Example
javascript
function(req, res){
res.switchProxy().end();
}
`
$3
sets res status code to 307Kind: static method of express-status
Example
javascript
function(req, res){
res.temporaryRedirect().end();
}
`
$3
sets res status code to 308Kind: static method of express-status
Example
javascript
function(req, res){
res.permanentRedirect().end();
}
`
$3
sets res status code to 400Kind: static method of express-status
Example
javascript
function(req, res){
res.badRequest().end();
}
`
$3
sets res status code to 401Kind: static method of express-status
Example
javascript
function(req, res){
res.unauthorized().end();
}
`
$3
sets res status code to 403Kind: static method of express-status
Example
javascript
function(req, res){
res.forbidden().end();
}
`
$3
sets res status code to 404Kind: static method of express-status
Example
javascript
function(req, res){
res.notFound().end();
}
`
$3
sets res status code to 405Kind: static method of express-status
Example
javascript
function(req, res){
res.methodNotAllowed().end();
}
`
$3
sets res status code to 406Kind: static method of express-status
Example
javascript
function(req, res){
res.notAcceptable().end();
}
`
$3
sets res status code to 407Kind: static method of express-status
Example
javascript
function(req, res){
res.proxyAuthenticationRequired().end();
}
`
$3
sets res status code to 408Kind: static method of express-status
Example
javascript
function(req, res){
res.requestTimeout().end();
}
`
$3
sets res status code to 409Kind: static method of express-status
Example
javascript
function(req, res){
res.conflict().end();
}
`
$3
sets res status code to 410Kind: static method of express-status
Example
javascript
function(req, res){
res.gone().end();
}
`
$3
sets res status code to 411Kind: static method of express-status
Example
javascript
function(req, res){
res.lengthRequired().end();
}
`
$3
sets res status code to 412Kind: static method of express-status
Example
javascript
function(req, res){
res.preconditionFailed().end();
}
`
$3
sets res status code to 413Kind: static method of express-status
Example
javascript
function(req, res){
res.requestEntityTooLarge().end();
}
`
$3
sets res status code to 414Kind: static method of express-status
Example
javascript
function(req, res){
res.requestUriTooLang().end();
}
`
$3
sets res status code to 415Kind: static method of express-status
Example
javascript
function(req, res){
res.unsupportedMediaType().end();
}
`
$3
sets res status code to 416Kind: static method of express-status
Example
javascript
function(req, res){
res.requestedRangeNotSatisfiable().end();
}
`
$3
sets res status code to 417Kind: static method of express-status
Example
javascript
function(req, res){
res.expectationFailed().end();
}
`
$3
sets res status code to 418Kind: static method of express-status
Example
javascript
function(req, res){
res.imATeapot().end();
}
`
$3
sets res status code to 419Kind: static method of express-status
Example
javascript
function(req, res){
res.authenticationTimeout().end();
}
`
$3
sets res status code to 423Kind: static method of express-status
Example
javascript
function(req, res){
res.locked().end();
}
`
$3
sets res status code to 424Kind: static method of express-status
Example
javascript
function(req, res){
res.failedDependency().end();
}
`
$3
sets res status code to 426Kind: static method of express-status
Example
javascript
function(req, res){
res.upgradeRequired().end();
}
`
$3
sets res status code to 428Kind: static method of express-status
Example
javascript
function(req, res){
res.preconditionRequired().end();
}
`
$3
sets res status code to 429Kind: static method of express-status
Example
javascript
function(req, res){
res.tooManyRequests().end();
}
`
$3
sets res status code to 431Kind: static method of express-status
Example
javascript
function(req, res){
res.requestHeaderFieldTooLarge().end();
}
`
$3
sets res status code to 440Kind: static method of express-status
Example
javascript
function(req, res){
res.loginTimeout().end();
}
`
$3
sets res status code to 451Kind: static method of express-status
Example
javascript
function(req, res){
res.unavailableForLegalReasons().end();
}
`
$3
sets res status code to 500Kind: static method of express-status
Example
javascript
function(req, res){
res.internalServerError().end();
}
`
$3
sets res status code to 501Kind: static method of express-status
Example
javascript
function(req, res){
res.notImplemented().end();
}
`
$3
sets res status code to 502Kind: static method of express-status
Example
javascript
function(req, res){
res.badGateway().end();
}
`
$3
sets res status code to 503Kind: static method of express-status
Example
javascript
function(req, res){
res.serviceUnavailable().end();
}
`
$3
sets res status code to 504Kind: static method of express-status
Example
javascript
function(req, res){
res.gatewayTimeout().end();
}
`
$3
sets res status code to 505Kind: static method of express-status
Example
javascript
function(req, res){
res.httpVersionNutSupported().end();
}
`
$3
sets res status code to 506Kind: static method of express-status
Example
javascript
function(req, res){
res.variantAlsoNegotiates().end();
}
`
$3
sets res status code to 507Kind: static method of express-status
Example
javascript
function(req, res){
res.insufficientStorage().end();
}
`
$3
sets res status code to 508Kind: static method of express-status
Example
javascript
function(req, res){
res.loopDetected().end();
}
`
$3
sets res status code to 510Kind: static method of express-status
Example
javascript
function(req, res){
res.notExtended().end();
}
`
$3
sets res status code to 511Kind: static method of express-status
Example
javascript
function(req, res){
res.notExtended().end();
}
``