statuses-es

ESM build of statuses with bundled types.

IMPORTANT: During development tests are conducted on the latest node.js (LST) version it does not mean that this library works only with it, in theory it will work on earlier versions but to check it is not meaningful because the use of versions in production that do not get the security patch is not a good practice.

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:

# ✨ Auto-detect
npx nypm install statuses-es

# npm
npm install statuses-es

# yarn
yarn add statuses-es

# pnpm
pnpm install statuses-es

# bun
bun install statuses-es

API

ESM (Node.js, Bun)

import status from "statuses-es";

CommonJS (Legacy Node.js)

const status = require("statuses-es");

CDN (Deno, Bun and Browsers)

import status from "https://esm.sh/statuses-es";

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