HTTP Status Code Utilities

Common errors

• TypeError: Cannot read properties of undefined (reading 'getMessage')

  cause Attempting to call `getMessage` on an undefined `HTTPStatusCode` object, likely due to incorrect CommonJS import syntax.
  fix Ensure `HTTPStatusCode` is correctly imported: `const HTTPStatusCode = require('http-status-code');` in CommonJS or `import HTTPStatusCode from 'http-status-code';` in ESM.

• TypeError: (0 , http_status_code_1.getMessage) is not a function

  cause Incorrectly trying to destructure `getMessage` as a named export from an ESM import, when it's a method of the default export.
  fix Access `getMessage` as a method of the default import: `import HTTPStatusCode from 'http-status-code'; HTTPStatusCode.getMessage(200);`

Warnings

• gotcha The `getMessage` function returns 'Unknown' if the status code or protocol combination is not found. There is no explicit error thrown, which might mask issues if expecting specific messages.
  Fix: Always check the return value of `getMessage` to ensure it's not 'Unknown' if you need to rely on a specific message being present. Consider falling back to a generic message or logging a warning if 'Unknown' is returned.
• gotcha The package primarily uses CommonJS `require` syntax in its examples. While modern tools can often consume it with ESM `import`, ensure your build pipeline correctly handles CommonJS module interoperability if you encounter import issues in an ESM-only environment.
  Fix: If using TypeScript or a modern bundler, `import HTTPStatusCode from 'http-status-code';` should work. For strict CommonJS environments, use `const HTTPStatusCode = require('http-status-code');`.
• gotcha Protocol names are case-sensitive and must match the internal definitions (e.g., 'HTTP/1.1', 'HTTP/2'). Providing an incorrectly cased or non-existent protocol name will result in an 'Unknown' message or an empty list of status codes.
  Fix: Refer to the documentation or source for exact protocol string names. Common valid values are 'HTTP/1.0', 'HTTP/1.1', 'HTTP/2'.

Install

• npm install http-status-code npm
• yarn add http-status-code yarn
• pnpm add http-status-code pnpm

Imports

• HTTPStatusCode
  wrong:

  const HTTPStatusCode = require('http-status-code').HTTPStatusCode;

  correct:

  import HTTPStatusCode from 'http-status-code';

  While the README shows CommonJS `require`, modern Node.js and bundlers often resolve `default` export for CommonJS modules. The package may not explicitly ship ESM, but this import pattern generally works. For pure CJS, `const HTTPStatusCode = require('http-status-code');` is correct.
• getMessage
  wrong:

  import { getMessage } from 'http-status-code';

  correct:

  import HTTPStatusCode from 'http-status-code';
  const message = HTTPStatusCode.getMessage(200);

  The `getMessage` function is a method of the default exported object, not a named export. Attempting to destructure it directly will result in an undefined function.
• All HTTP/1.1 Status Codes
  wrong:

  import { HTTP11_CODES } from 'http-status-code';

  correct:

  import HTTPStatusCode from 'http-status-code';
  const codes = HTTPStatusCode.getProtocolStatusCodes('HTTP/1.1');

  The library exposes an API to retrieve codes based on protocol, rather than exporting individual protocol code objects. Access through the `getProtocolStatusCodes` method is the intended pattern.

Quickstart

Demonstrates retrieving HTTP status messages for various codes, including protocol-specific lookups, and fetching a list of all codes for a given protocol.

import HTTPStatusCode from 'http-status-code';

// Get the message for a common status code without specifying a protocol
console.log('HTTP 200 message:', HTTPStatusCode.getMessage(200));

// Get the message for a status code specific to HTTP/1.1
console.log('HTTP/1.1 429 message:', HTTPStatusCode.getMessage(429, 'HTTP/1.1'));

// Get the message for a status code that might differ or be unknown in a specific protocol
console.log('WEBDAV 429 message (example of unknown):', HTTPStatusCode.getMessage(429, 'WEBDAV'));

// Retrieve all status codes for a specific protocol
const http2Codes = HTTPStatusCode.getProtocolStatusCodes('HTTP/2');
console.log('\nHTTP/2 status codes (first 5):', Object.entries(http2Codes).slice(0, 5));