Name Last Update
..
HISTORY.md Loading commit data...
LICENSE Loading commit data...
README.md Loading commit data...
codes.json Loading commit data...
index.js Loading commit data...
package.json Loading commit data...

README.md

statuses

NPM Version NPM Downloads Node.js Version Build Status Test Coverage

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.js module available through the npm registry. Installation is done using the <code>npm install</code> command:

$ npm install statuses

API

<!-- eslint-disable no-unused-vars -->

var status = require('statuses')

status(code)

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.

<!-- eslint-disable no-undef -->

status(403) // => 'Forbidden'
status('403') // => 'Forbidden'
status(306) // throws

status(msg)

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.

<!-- eslint-disable no-undef -->

status('forbidden') // => 403
status('Forbidden') // => 403
status('foo') // throws

status.codes

Returns an array of all the status codes as Integers.

status.code[msg]

Returns the numeric status code for a known status message (in lower-case), otherwise undefined.

<!-- eslint-disable no-undef, no-unused-expressions -->

status['not found'] // => 404

status.empty[code]

Returns true if a status code expects an empty body.

<!-- eslint-disable no-undef, no-unused-expressions -->

status.empty[200] // => undefined
status.empty[204] // => true
status.empty[304] // => true

status.message[code]

Returns the string message for a known numeric status code, otherwise undefined. This object is the same format as the Node.js http module <code>http.STATUS_CODES</code>.

<!-- eslint-disable no-undef, no-unused-expressions -->

status.message[404] // => 'Not Found'

status.redirect[code]

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

<!-- eslint-disable no-undef, no-unused-expressions -->

status.redirect[200] // => undefined
status.redirect[301] // => true

status.retry[code]

Returns true if you should retry the rest.

<!-- eslint-disable no-undef, no-unused-expressions -->

status.retry[501] // => undefined
status.retry[503] // => true

License

MIT