Skip to content

Repository files navigation

statuses

NPM VersionNPM DownloadsNode.js VersionBuild StatusTest CoverageOpenSSF Scorecard Badge

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 npm install command:

$ npm install statuses

API

varstatus=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.

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.

status('forbidden')// => 403status('Forbidden')// => 403status('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.

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

status.empty[code]

Returns true if a status code expects an empty body.

status.empty[200]// => undefinedstatus.empty[204]// => truestatus.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 http.STATUS_CODES.

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

status.redirect[code]

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

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

status.retry[code]

Returns true if you should retry the rest.

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

License

MIT

About

HTTP status utility

Topics

Resources

Code of conduct

Security policy

Stars

283 stars

Watchers

10 watching

Forks

Releases

Packages

Used by

Contributors

Languages