githubEdit

Statuses

NPM Versionarrow-up-right NPM Downloadsarrow-up-right Node.js Versionarrow-up-right Build Statusarrow-up-right Test Coveragearrow-up-right

HTTP status utility for node.

This module provides a list of status codes and messages sourced from a few different projects:

Installation

This is a Node.jsarrow-up-right module available through the npm registryarrow-up-right. Installation is done using the npm install commandarrow-up-right:

$ npm install statuses

API

var status = require('statuses')

var code = status(Integer || String)

If Integer or String is a valid HTTP code or status message, then the appropriate code will be returned. Otherwise, an error will be thrown.

status(403) // => 403
status('403') // => 403
status('forbidden') // => 403
status('Forbidden') // => 403
status(306) // throws, as it's not supported by node.js

status.STATUS_CODES

Returns an object which maps status codes to status messages, in the same format as the Node.js http modulearrow-up-right.

status.codes

Returns an array of all the status codes as Integers.

var msg = status[code]

Map of code to status message. undefined for invalid codes.

var code = status[msg]

Map of status message to code. msg can either be title-cased or lower-cased. undefined for invalid status messages.

status.redirect[code]

Returns true if a status code is a valid redirect status.

status.empty[code]

Returns true if a status code expects an empty body.

status.retry[code]

Returns true if you should retry the rest.

Last updated

Was this helpful?