[![NPM Version][npm-version-image]][npm-url] [![NPM Downloads][npm-downloads-image]][npm-url] [![Node.js Version][node-version-image]][node-version-url] [![Build Status][ci-image]][ci-url] [![Test Coverage][coveralls-image]][coveralls-url] [![OpenSSF Scorecard Badge][ossf-scorecard-badge]][ossf-scorecard-visualizer]
HTTP status utility for node.
This module provides a list of status codes and messages sourced from a few different projects:
* The IANA Status Code Registry * The Node.js project * The NGINX project * The Apache HTTP Server project
This is a Node.js module available through the
npm registry. Installation is done using the
npm install command:
$ npm install statuses
var status = require('statuses')
Returns the status message string for a known HTTP status code. The code may be a number or a string. An error is thrown for an unknown status code.
status(403) // => 'Forbidden'
status('403') // => 'Forbidden'
status(306) // throws
Returns the numeric status code for a known HTTP status message. The message is case-insensitive. An error is thrown for an unknown status message.
status('forbidden') // => 403
status('Forbidden') // => 403
status('foo') // throws
Returns an array of all the status codes as Integers.
Returns the numeric status code for a known status message (in lower-case),
otherwise undefined.
status['not found'] // => 404
Returns true if a status code expects an empty body.
status.empty[200] // => undefined
status.empty[204] // => true
status.empty[304] // => true
Returns the string message for a known numeric status code, otherwise
undefined. This object is the same format as the
Node.js http module http.STATUS_CODES.
status.message[404] // => 'Not Found'
Returns true if a status code is a valid redirect status.
status.redirect[200] // => undefined
status.redirect[301] // => true
Returns true if you should retry the rest.
status.retry[501] // => undefined
status.retry[503] // => true
[ci-image]: https://badgen.net/github/checks/jshttp/statuses/master?label=ci [ci-url]: https://github.com/jshttp/statuses/actions?query=workflow%3Aci [coveralls-image]: https://badgen.net/coveralls/c/github/jshttp/statuses/master [coveralls-url]: https://coveralls.io/r/jshttp/statuses?branch=master [node-version-image]: https://badgen.net/npm/node/statuses [node-version-url]: https://nodejs.org/en/download [npm-downloads-image]: https://badgen.net/npm/dm/statuses [npm-url]: https://npmjs.org/package/statuses [npm-version-image]: https://badgen.net/npm/v/statuses [ossf-scorecard-badge]: https://api.securityscorecards.dev/projects/github.com/jshttp/statuses/badge [ossf-scorecard-visualizer]: https://kooltheba.github.io/openssf-scorecard-api-visualizer/#/projects/github.com/jshttp/statuses