HTTP Status Codes

The HTTP Status Codes component provides a centralized and type-safe way to reference HTTP status codes across your backend.

Installation Guide

Install the component using the servercn CLI:

npx servercn-cli add http-status-codes

Why This Component Exists

In many backend codebases, HTTP status codes are often scattered and hard-coded, making the application harder to maintain and reason about:

res.status(200).json(...);
res.status(401).send(...);
res.status(500).json(...);

Basic Implementation

export const STATUS_CODES = {
  // 2xx Success
  OK: 200,
  CREATED: 201,
  ACCEPTED: 202,
  NO_CONTENT: 204,
 
  // 3xx Redirection
  MOVED_PERMANENTLY: 301,
  FOUND: 302,
  NOT_MODIFIED: 304,
 
  // 4xx Client Errors
  BAD_REQUEST: 400,
  UNAUTHORIZED: 401,
  FORBIDDEN: 403,
  NOT_FOUND: 404,
  CONFLICT: 409,
  UNPROCESSABLE_ENTITY: 422,
  TOO_MANY_REQUESTS: 429,
 
  // 5xx Server Errors
  INTERNAL_SERVER_ERROR: 500,
  NOT_IMPLEMENTED: 501,
  BAD_GATEWAY: 502,
  SERVICE_UNAVAILABLE: 503,
  GATEWAY_TIMEOUT: 504
} as const;
 
export type StatusCode = (typeof STATUS_CODES)[keyof typeof STATUS_CODES];

Usage Example

import { STATUS_CODES } from "../utils/status-codes";
 
res.status(STATUS_CODES.OK).json(...);
res.status(STATUS_CODES.BAD_REQUEST).send(...);
res.status(STATUS_CODES.INTERNAL_SERVER_ERROR).json(...);

The HTTP Status Codes component solves this by providing a clear, standardized, and type-safe way to reference status codes everywhere in your application.

Status Code Reference

2xx Success

These codes indicate that the client's request was successfully received, understood, and accepted.

3xx Redirection

These codes indicate that the client must take additional action to complete the request.

4xx Client Errors

These codes indicate that the request contains bad syntax or cannot be fulfilled.

5xx Server Errors

These codes indicate the server failed to fulfill an apparently valid request.