or run

npx @tessl/cli init
Log in

Version

Tile

Overview

Evals

Files

docs

index.mdlegacy-constants.mdreason-phrases.mdstatus-codes.mdutility-functions.md
tile.json

tessl/npm-http-status-codes

Constants enumerating the HTTP status codes with utility functions for TypeScript and JavaScript applications

Workspace
tessl
Visibility
Public
Created
Last updated
Describes
npmpkg:npm/http-status-codes@2.3.x

To install, run

npx @tessl/cli install tessl/npm-http-status-codes@2.3.0

index.mddocs/

HTTP Status Codes

HTTP Status Codes is a zero-dependency TypeScript library providing comprehensive HTTP status code constants and utility functions. It offers enumerated constants for all standard HTTP status codes defined in RFC1945 (HTTP/1.0), RFC2616 (HTTP/1.1), RFC2518 (WebDAV), RFC6585 (Additional HTTP Status Codes), and RFC7538 (Permanent Redirect).

Package Information

  • Package Name: http-status-codes
  • Package Type: npm
  • Language: TypeScript
  • Installation: 
    npm install http-status-codes

Core Imports

import {
  StatusCodes,
  ReasonPhrases,
  getReasonPhrase,
  getStatusCode,
} from "http-status-codes";

For CommonJS:

const {
  StatusCodes,
  ReasonPhrases,
  getReasonPhrase,
  getStatusCode,
} = require("http-status-codes");

Basic Usage

import {
  StatusCodes,
  ReasonPhrases,
  getReasonPhrase,
  getStatusCode,
} from "http-status-codes";

// Using enum constants
response.status(StatusCodes.OK).send(ReasonPhrases.OK);

// Using utility functions
response
  .status(StatusCodes.INTERNAL_SERVER_ERROR)
  .send({
    error: getReasonPhrase(StatusCodes.INTERNAL_SERVER_ERROR)
  });

// Reverse lookup from reason phrase to status code
const statusCode = getStatusCode("Internal Server Error");
response.status(statusCode).send({ error: "Internal Server Error" });

Architecture

The library is organized around several key components:

  • StatusCodes Enum: Numeric constants for all HTTP status codes with descriptive names
  • ReasonPhrases Enum: String constants for corresponding human-readable reason phrases
  • Utility Functions: Bidirectional conversion between status codes and reason phrases
  • Legacy Constants: Individual constants for v1 backwards compatibility (deprecated)
  • Internal Lookups: Efficient Record-based mappings for fast conversions

Capabilities

Status Code Constants

Enumerated constants for all standard HTTP status codes with descriptive names and RFC documentation.

enum StatusCodes {
  // 1xx Informational
  CONTINUE = 100,
  SWITCHING_PROTOCOLS = 101,
  PROCESSING = 102,
  EARLY_HINTS = 103,
  // 2xx Success  
  OK = 200,
  CREATED = 201,
  ACCEPTED = 202,
  // ... (59 total status codes)
}

Status Code Constants

Reason Phrase Constants

Enumerated string constants for human-readable HTTP reason phrases corresponding to status codes.

enum ReasonPhrases {
  // 1xx Informational
  CONTINUE = "Continue",
  SWITCHING_PROTOCOLS = "Switching Protocols", 
  PROCESSING = "Processing",
  EARLY_HINTS = "Early Hints",
  // 2xx Success
  OK = "OK",
  CREATED = "Created",
  ACCEPTED = "Accepted",
  // ... (59 total reason phrases)
}

Reason Phrase Constants

Utility Functions

Bidirectional conversion functions between status codes and reason phrases with error handling.

function getReasonPhrase(statusCode: number | string): string;
function getStatusCode(reasonPhrase: string): number;
function getStatusText(statusCode: number | string): string; // @deprecated

Utility Functions

Legacy Support

Backwards compatibility with v1 API through individual status code constants (deprecated).

// Individual constants (deprecated - use StatusCodes enum instead)
const ACCEPTED = 202;
const BAD_REQUEST = 400;
const INTERNAL_SERVER_ERROR = 500;
// ... (54 total legacy constants)

Legacy Constants