HTTP Status Code Utilities

Common errors

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

  cause The `HttpStatus` constructor was called with an `undefined` or `null` value, or an object missing a `status` property, when attempting to extract the status code.
  fix Ensure the argument passed to `new HttpStatus()` is either a valid numeric string (e.g., `'200'`) or an object with a `status` property (e.g., `{ status: 200 }`).

• TypeError: HttpStatus is not a constructor

  cause Attempting to use `HttpStatus` as a class constructor after an incorrect import (e.g., `const HttpStatus = require('http-status-response-codes').HttpStatus;` instead of directly `require`ing the default export).
  fix The `HttpStatus` class is the default export. Use `const HttpStatus = require('http-status-response-codes');` to import it correctly.

• SyntaxError: Named export 'statusCodes' not found. The requested module 'http-status-response-codes' does not provide an export named 'statusCodes'

  cause Attempting to use ESM `import { statusCodes } from 'http-status-response-codes';` in a CommonJS-only environment or for a package that does not explicitly support ESM named exports.
  fix For CommonJS, use `const { statusCodes } = require('http-status-response-codes');` to correctly destructure the named export.

Warnings

• gotcha The package is predominantly CommonJS (CJS) as indicated by all examples using `require()`. Attempting to use ESM `import` statements directly might lead to runtime errors or require specific build tool configurations, as the package may not explicitly export ESM modules.
  Fix: Use `const HttpStatus = require('http-status-response-codes');` and `const { statusCodes } = require('http-status-response-codes');` for all imports.
• gotcha The `HttpStatus` constructor can accept a 'Response Object' as input, but the exact structure is implicitly tied to older HTTP client libraries (e.g., `request-promise` used in the README's main example). Modern `fetch` API or `axios` response objects might require manually extracting the `status` property before passing it to `HttpStatus`.
  Fix: Ensure the object passed to `new HttpStatus()` has a `status` property containing the numeric HTTP status code, e.g., `new HttpStatus({ status: response.status })`.
• gotcha The package appears to be in a maintenance mode. It has a low version number (1.0.2) and the provided examples use older JavaScript patterns and libraries (like `request-promise`). While functional, it might not receive updates for new HTTP status codes, security patches, or modern JavaScript features (like TypeScript definitions or native ESM support).
  Fix: Evaluate against more actively maintained alternatives if up-to-date features, comprehensive type support, or continuous maintenance are critical for your project.

Install

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

Imports

• HttpStatus
  wrong:

  import HttpStatus from 'http-status-response-codes';

  correct:

  const HttpStatus = require('http-status-response-codes');

  The package primarily uses CommonJS. Direct ESM `import` statements may not work or could require specific Node.js configuration (e.g., using a CommonJS wrapper).
• statusCodes
  wrong:

  import { statusCodes } from 'http-status-response-codes';

  correct:

  const { statusCodes } = require('http-status-response-codes');

  Access to the `statusCodes` enum is via named CommonJS `require` destructuring. ESM imports are not directly supported by the examples or implied by the package's age.
• is2xxSuccessful

  const httpStatus = new HttpStatus('200'); httpStatus.is2xxSuccessful();

  These are instance methods on the `HttpStatus` class, not direct exports. Ensure you instantiate the class first.

Quickstart

This quickstart demonstrates how to instantiate `HttpStatus` with both a string and a mock response object, how to use its categorization methods (`is4xxClientError`, `is2xxSuccessful`, `isError`), and how to access specific status code values from the `statusCodes` object. It highlights common usage patterns for checking HTTP response types.

const HttpStatus = require('http-status-response-codes');
const { statusCodes } = require('http-status-response-codes');

async function demonstrateHttpStatus() {
  // Example 1: Instantiate with a numeric string
  const notFoundStatus = new HttpStatus('404');
  console.log(`Code: ${notFoundStatus.getCodeValue()} Name: ${notFoundStatus.getName()}`);
  console.log(`Is client error? ${notFoundStatus.is4xxClientError()}`); // true
  console.log(`Is error? ${notFoundStatus.isError()}`); // true
  console.log(`Description: ${notFoundStatus.getDescription()}`);

  // Example 2: Instantiate with a mock response object (simulating an HTTP client response)
  // The package expects an object with a '.status' property, similar to older libraries like request-promise.
  const mockSuccessResponse = { status: 200, body: 'OK' }; // Mock a response object
  const successStatus = new HttpStatus(mockSuccessResponse);
  console.log(`Code: ${successStatus.getCodeValue()} Name: ${successStatus.getName()}`);
  console.log(`Is successful? ${successStatus.is2xxSuccessful()}`); // true
  console.log(`Is error? ${successStatus.isError()}`); // false

  // Example 3: Accessing the statusCodes enum for numerical values
  console.log(`HTTP_BAD_REQUEST: ${statusCodes.BAD_REQUEST}`); // 400
  console.log(`HTTP_INTERNAL_SERVER_ERROR: ${statusCodes.INTERNAL_SERVER_ERROR}`); // 500

  // Using a simulated server error response
  const simulatedResponse = { status: 503, statusText: 'Service Unavailable' };
  const serverErrorStatus = new HttpStatus(simulatedResponse);
  if (serverErrorStatus.isError()) {
    console.log(`
Caught an HTTP error: ${serverErrorStatus.getCodeValue()} - ${serverErrorStatus.getDescription()}`);
    console.log(`Is server error? ${serverErrorStatus.is5xxServerError()}`); // true
  }
}

demonstrateHttpStatus();