statuses

What is statuses?

The 'statuses' npm package provides an easy way to handle HTTP status codes. It allows you to look up status codes by the code number or by the status message. It also provides a way to retrieve the message associated with a particular status code or vice versa.

What are statuses's main functionalities?

Get HTTP status code message

Retrieve the message associated with a specific HTTP status code.

"use strict";
const statuses = require('statuses');
const message = statuses[404]; // 'Not Found'

Get HTTP status code by message

Retrieve the status code by specifying the message.

"use strict";
const statuses = require('statuses');
const code = statuses('Not Found'); // 404

Check if status code is a redirect

Check if a given status code is classified as a redirect (3xx).

"use strict";
const statuses = require('statuses');
const isRedirect = statuses.redirect[301]; // true

Get the status code range

Determine if a status code falls within a specific range, such as informational (1xx), success (2xx), etc.

"use strict";
const statuses = require('statuses');
const isInformational = statuses.empty[204]; // true
const isSuccess = statuses.success[200]; // true

Other packages similar to statuses

http-status-codes

This package provides named exports for HTTP status codes and messages, similar to 'statuses'. It allows you to use constants instead of numbers for better readability in your code.

http-status

Similar to 'statuses', 'http-status' provides an easy way to reference HTTP status codes and their messages. It also includes utility functions to check the type of status code (e.g., isSuccess, isClientError).

README

statuses

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

Installation

This is a Node.js module available through the npm registry. Installation is done using the npm install command:

$ npm install statuses

API

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.

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') // => 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.

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

status.empty[code]

Returns true if a status code expects an empty body.

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 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] // => undefined
status.redirect[301] // => true

status.retry[code]

Returns true if you should retry the rest.

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

License

MIT