HTTP Status Codes Map

Common errors

• ReferenceError: require is not defined

  cause Attempting to use CommonJS `require()` syntax in an ES Module context (e.g., in a file with `"type": "module"` in `package.json` or a `.mjs` file).
  fix Use `import codes from 'builtin-status-codes'` for ES Modules.

• TypeError: codes is not a function

  cause The `codes` export from `builtin-status-codes` is a plain object (a map of numbers to strings), not a callable function.
  fix Access status messages using bracket notation with the numeric code, e.g., `codes[200]`.

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

  cause This typically indicates that the `builtin-status-codes` module failed to load correctly, resulting in `codes` being `undefined`, or you're trying to access a non-existent status code in a context where `codes` might be null/undefined.
  fix Ensure `builtin-status-codes` is correctly installed (`npm install builtin-status-codes`) and imported. Verify that the status code you are trying to access is a valid HTTP status code.

Warnings

• breaking Version 3.0.0 is a major release. While specific breaking changes are not detailed in the provided README, major version bumps typically introduce API changes, updated environment requirements, or different default behaviors. Users upgrading from 2.x.x should consult the package's changelog.
  Fix: Review the package's GitHub repository or `CHANGELOG.md` for detailed migration instructions specific to the 3.0.0 release.
• gotcha The package provides a mapping from numeric HTTP status *codes* (e.g., `200`) to their descriptive *strings* (e.g., 'OK'). It does not offer a direct reverse lookup (string to number) without manually iterating through the map.
  Fix: If a reverse lookup is needed, iterate `Object.entries(codes)` and build your own reverse map or search dynamically.
• gotcha The browser bundle of `builtin-status-codes` (generated via `npm run build`) is a static snapshot. It might not reflect the absolute latest HTTP status codes as rapidly as the Node.js version, which dynamically queries Node's built-in `http` module at runtime.
  Fix: For the most current status codes in a browser environment, ensure your `builtin-status-codes` package is updated to the latest version and that your build process includes the most recent browser bundle.

Install

• npm install builtin-status-codes npm
• yarn add builtin-status-codes yarn
• pnpm add builtin-status-codes pnpm

Imports

• codes
  wrong:

  import { codes } from 'builtin-status-codes'

  correct:

  import codes from 'builtin-status-codes'

  The package exports the status code map as its default export. Named imports like `{ codes }` will not work.
• codes

  const codes = require('builtin-status-codes')

  This is the CommonJS import pattern, suitable for Node.js environments without ES Modules enabled.
• codes

  type HttpStatusCodeMap = Record<number, string>;
  import codes from 'builtin-status-codes'

  TypeScript users can import the module as a default export; its type is implicitly `Record<number, string>`.

Quickstart

Demonstrates importing the status codes map, retrieving messages for specific numeric codes, and iterating through all available codes.

import codes from 'builtin-status-codes';

// Get the message for a specific status code
const okMessage = codes[200];
console.log(`200: ${okMessage}`); // Output: 200: OK

const notFoundMessage = codes[404];
console.log(`404: ${notFoundMessage}`); // Output: 404: Not Found

const serverErrorMessage = codes[500];
console.log(`500: ${serverErrorMessage}`); // Output: 500: Internal Server Error

// Iterate over all known status codes and messages
console.log('\nAll available status codes:');
for (const codeStr in codes) {
  const code = Number(codeStr);
  // Filter out any non-numeric or inherited properties
  if (Number.isInteger(code) && code > 0) {
    console.log(`${code}: ${codes[code]}`);
  }
}