HTTP Status Codes Utility

httpStatus

The httpStatus is a default shared instance of the HttpStatus class.
It comes preloaded with all standard HTTP status codes and their metadata from MDN documentation.

Data Source

This utility includes all standard HTTP status codes with metadata adapted from MDN documentation.

• Each entry includes: code, name, readable name, description, and category
• Categories are pre-grouped for easy filtering (informational, success, redirection, clientError, serverError)

When to Use

• Use this instance when you don't need multiple configurations
• If you need isolated or custom status codes, create your own HttpStatus instance
• For status codes use constant HTTP_STATUS_CODES instead.

---

✨ Features

• ✅ Lookup status codes by number or name (both SOME_NAME and Some Name formats)
• ✅ Built-in standard HTTP status codes from MDN
• ✅ Modify status codes dynamically:
  • addCode() - Add custom status codes
  • setMessage() - Override default messages
• ✅ Pre-grouped categories for quick filtering
• ✅ Fully typed for TypeScript users

---

📦 Import

import { httpStatus } from 'nhb-toolbox';

---

🚀 Quick Usage

Lookup

// By code
httpStatus.getByCode(404)?.readableName; // "Not Found"

// By name
httpStatus.getByName('NOT_FOUND')?.code; // 404
httpStatus.getByName('Not Found')?.code; // 404

List

// All status codes
httpStatus.list();

// Only server errors
httpStatus.list('serverError');

Modify

// Override a message
httpStatus.setMessage(404, 'This page is gone');

// Add custom code
httpStatus.addCode({
  code: 799,
  name: 'CUSTOM_ERROR',
  readableName: 'Custom Error',
  message: 'Something custom happened',
  description: 'Example of user-defined HTTP status',
  category: 'clientError'
});

---

🔧 Extending Status Codes

Since httpStatus is an actual instance of HttpStatus, you can extend or modify it at runtime:

// Add a custom status code
httpStatus.addCode({
  code: 799,
  name: 'CUSTOM_ERROR',
  readableName: 'Custom Error',
  message: 'Something custom happened',
  description: 'Example of user-defined HTTP status',
  category: 'clientError'
});

// Override a message
httpStatus.setMessage(404, 'This page is gone');

These modifications affect all consumers of the shared instance.

---

🏗 Need your own configuration?

If you want an isolated instance with its own status codes, instantiate the class directly:

import { HttpStatus } from 'nhb-toolbox';

const myHttpStatus = new HttpStatus();
myHttpStatus.addCode({
  code: 799,
  name: 'CUSTOM_ERROR',
  readableName: 'Custom Error',
  message: 'Something custom happened',
  description: 'Example of user-defined HTTP status',
  category: 'clientError'
});

console.log(myHttpStatus.getByCode(799)?.readableName); // "Custom Error"

See the HttpStatus class docs for full details.

---

See also

• For status codes use constant HTTP_STATUS_CODES instead.
• HttpStatus class — low-level API for custom instances
• HTTP Status Codes Reference - MDN documentation

---

Summary

• Use httpStatus for common use-cases.
• Create new HttpStatus() for isolated/custom status codes.