HTTP Error Constructor

Common errors

• ReferenceError: require is not defined

  cause Attempting to use `require()` in an ES Module context without proper setup, or when the file is treated as an ES Module (e.g., `"type": "module"` in `package.json`).
  fix If your project is ESM, ensure CJS interoperability is configured, or refactor to use dynamic `import()` for this package. If your file is treated as ESM, rename it to `.cjs` or ensure the containing `package.json` does not have `"type": "module"` if you intend to use CJS.

• TypeError: HttpError.BadRequest is not a constructor

  cause Trying to destructure `BadRequest` as a named export (e.g., `import { BadRequest } from 'http-error-constructor';`) or misusing it after a wrong import.
  fix Always access specific error constructors as static properties of the main `HttpError` object: `const HttpError = require('http-error-constructor'); const err = new HttpError.BadRequest();`

• TypeError: HttpError is not a constructor

  cause This usually happens if `HttpError` was imported incorrectly, e.g., using `import { HttpError } from 'http-error-constructor'` when the package provides a default export or is CommonJS-only.
  fix Ensure `HttpError` is imported correctly as a CommonJS module: `const HttpError = require('http-error-constructor');`

Warnings

• gotcha The `name`, `statusCode`, and `status` properties of `HttpError` instances are non-enumerable. This means they will not be included in the output when calling `JSON.stringify()` on an error instance.
  Fix: If these properties are required in the JSON output, manually create a serializable object: `const serializableError = { name: err.name, statusCode: err.statusCode, message: err.message, ...err };`
• gotcha This package is a very old project (v0.1.0, requiring Node.js >= 4.0.0 from 2015). It is likely unmaintained, may lack modern features, and could have unpatched security vulnerabilities or incompatibilities with very recent Node.js versions.
  Fix: Consider using a more actively maintained and modern HTTP error library for new projects, or thoroughly audit this package for security and compatibility if integrating into a current application.
• breaking This package is written in CommonJS (CJS) module format. Direct `import` statements (ESM) will not work without proper configuration (e.g., `"type": "module"` in `package.json` with `require` interoperability, or transpilation).
  Fix: Use `const HttpError = require('http-error-constructor');` for importing in CommonJS environments. For ESM, you might need a wrapper or dynamic import if direct usage fails: `const HttpError = await import('http-error-constructor');` (though this might still have CJS compatibility issues for named exports).

Install

• npm install http-error-constructor npm
• yarn add http-error-constructor yarn
• pnpm add http-error-constructor pnpm

Imports

• HttpError
  wrong:

  import HttpError from 'http-error-constructor';

  correct:

  const HttpError = require('http-error-constructor');

  This package primarily supports CommonJS modules. Attempting to use ESM `import` syntax will result in errors in environments without CJS interoperability.
• HttpError.BadRequest
  wrong:

  import { BadRequest } from 'http-error-constructor';

  correct:

  const HttpError = require('http-error-constructor');
  const err = new HttpError.BadRequest('Validation failed');

  Specific HTTP error constructors like `BadRequest` are static properties of the main `HttpError` object and cannot be destructured directly from the package's top-level export.
• HttpError[statusCode]
  wrong:

  import { 400 } from 'http-error-constructor';

  correct:

  const HttpError = require('http-error-constructor');
  const err = new HttpError[400]('Bad Request');

  Similar to named constructors, numeric status code constructors are accessed as properties on the main `HttpError` object, not as named exports.

Quickstart

Demonstrates instantiating HTTP errors with status codes, custom messages, additional properties, and using specific named constructors, highlighting how properties are handled during serialization.

const HttpError = require('http-error-constructor');

// Basic usage with a status code
const err1 = new HttpError(404);
console.log(`Error 1: ${err1.name}, Status: ${err1.statusCode}, Message: ${err1.message}`);
// Expected output: 'Error 1: NotFound, Status: 404, Message: Not Found'

// With a custom message and additional properties
const err2 = new HttpError(400, 'Validation Failed', {
    fields: {
        email: 'Invalid format'
    },
    requestId: 'abc-123'
});
console.log(`Error 2: ${err2.name}, Status: ${err2.statusCode}, Message: ${err2.message}`);
console.log('JSON Stringify err2:', JSON.stringify(err2));
// Expected JSON: '{"message":"Validation Failed","fields":{"email":"Invalid format"},"requestId":"abc-123"}'

// Using a specific named constructor
const err3 = new HttpError.Unauthorized({ message: 'Authentication required', retryable: true });
console.log(`Error 3: ${err3.name}, Status: ${err3.statusCode}, Message: ${err3.message}`);
console.log('Is err3 an HttpError instance?', err3 instanceof HttpError);