HTTP Response Status Code Utilities

Common errors

• TypeError: STATUS_CODES.getStat is not a function

  cause Attempting to use a non-existent function name, possibly copied from an incomplete example in release notes.
  fix Correct the function call to `STATUS_CODES.getStatusName` or `STATUS_CODES.getStatusCode`.

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

  cause Incorrect ESM import syntax, attempting to use a default import when only named or namespace imports are available.
  fix Change your import statement to `import { OK } from 'http-response-status-code';` for specific codes or `import * as STATUS_CODES from 'http-response-status-code';` to access all exports via `STATUS_CODES.OK`.

Warnings

• gotcha The release notes for v1.7.2 contain a typo in the `getStat` example, which is incomplete and incorrect. The correct function names are `getStatusName` or `getStatusCode`.
  Fix: Ensure you are calling the correct function, e.g., `STATUS_CODES.getStatusName(STATUS_CODES.OK)` or `STATUS_CODES.getStatusCode('OK')`.
• gotcha When migrating from CommonJS `require` to ESM `import`, ensure you use named imports for specific codes and functions (e.g., `import { OK, getStatusName } from 'pkg'`) or a namespace import (`import * as STATUS_CODES from 'pkg'`) if you want to access all exports under a single object.
  Fix: Avoid `import STATUS_CODES from 'pkg'` as a default import is not provided, which will result in `undefined`.
• gotcha The library primarily uses full upper-case strings for status code names (e.g., 'OK', 'NOT FOUND') when functions like `getStatusCode` are expecting a string input. Mismatched casing might lead to unexpected results.
  Fix: Always use the exact upper-case string name as defined in HTTP standards, or refer to the library's `CODES` object for a definitive list.

Install

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

Imports

• STATUS_CODES
  wrong:

  const STATUS_CODES = require('http-response-status-code');

  correct:

  import * as STATUS_CODES from 'http-response-status-code';

  Use this for CommonJS environments or to import all exports as a namespace in ESM.
• OK
  wrong:

  import STATUS_CODES from 'http-response-status-code'; STATUS_CODES.OK;

  correct:

  import { OK, getStatusName, CODES } from 'http-response-status-code';

  All individual status codes (e.g., OK, NOT_FOUND) and core utility functions are exported as named exports. This is the recommended ESM approach.
• getStatusName
  wrong:

  import * as STATUS_CODES from 'http-response-status-code'; STATUS_CODES.getStatName(...);

  correct:

  import { getStatusName } from 'http-response-status-code';

  Be mindful of exact function names; typos can lead to runtime errors.

Quickstart

This example demonstrates how to import and use various utilities to retrieve status codes, names, descriptions, and check code categories.

import { OK, NOT_FOUND, isSuccessCode, getStatusName, getStatusDescription, getNotFound, getStatusCode, CLIENT_ERROR_CODES } from 'http-response-status-code';

console.log('OK status code:', OK); // 200
console.log('Not Found status code:', NOT_FOUND); // 404

const status200Name = getStatusName(OK);
console.log('Name for 200:', status200Name); // OK

const status404Description = getStatusDescription(NOT_FOUND);
console.log('Description for 404:', status404Description); // Not Found

const nameForNotFound = getNotFound().name;
console.log('Name from getNotFound():', nameForNotFound); // Not Found

const codeForOK = getStatusCode('OK');
console.log('Code for "OK":', codeForOK); // 200

console.log('Is 200 a success code?', isSuccessCode(OK)); // true
console.log('Is 404 a success code?', isSuccessCode(NOT_FOUND)); // false

console.log('First 5 client error codes:', CLIENT_ERROR_CODES.slice(0, 5)); // [400, 401, 402, 403, 404]