HTTP Status Meaning

A comprehensive library for working with HTTP status codes with internationalization support.

Features

• 🌐 Internationalization Support: Get status code meanings in multiple languages
• 📊 Categorization: Identify and filter status codes by their categories
• 🔍 Validation Helpers: Quickly check if a status code belongs to a specific category
• 📖 Use Cases: Access common use cases for specific status codes
• 🚀 Browser Compatible: Works in Node.js and browser environments

Installation

1npm install http-status-meaning

Usage

In Node.js (ESM)

1import httpStatusMeaning from "http-status-meaning";
2
3// Get status meaning
4console.log(httpStatusMeaning.getStatusMeaning(404)); // "Not Found"
5
6// With language support
7console.log(httpStatusMeaning.getStatusMeaning(404, "fr")); // "Non trouvé"

In Node.js (CommonJS)

1const httpStatusMeaning = require("http-status-meaning");
2
3// Get status meaning
4console.log(httpStatusMeaning.getStatusMeaning(404)); // "Not Found"

In Browser (UMD)

1<script src="node_modules/http-status-meaning/dist/http-status-meaning.min.js"></script>
2<script>
3  // Access through global variable
4  console.log(httpStatusMeaning.getStatusMeaning(404)); // "Not Found"
5</script>

In Browser (ESM)

1<script type="module">
2  import httpStatusMeaning from "./node_modules/http-status-meaning/dist/http-status-meaning.esm.js";
3
4  console.log(httpStatusMeaning.getStatusMeaning(404)); // "Not Found"
5</script>

API Reference

Status Code Information

getStatusMeaning(code, language = 'en')

Returns the human-readable meaning of an HTTP status code.

1httpStatusMeaning.getStatusMeaning(200); // "OK"
2httpStatusMeaning.getStatusMeaning(404, "fr"); // "Non trouvé"

Parameters:

• code (Number): The HTTP status code
• language (String, optional): The language code (defaults to 'en')

Returns:

• (String): The human-readable meaning of the status code

getStatusCategory(code, language = 'en')

Returns the category of an HTTP status code.

1httpStatusMeaning.getStatusCategory(200); // "Success"
2httpStatusMeaning.getStatusCategory(404, "fr"); // "Erreur Client"

Parameters:

• code (Number): The HTTP status code
• language (String, optional): The language code (defaults to 'en')

Returns:

• (String): The category of the status code

getStatusCodeUseCases(code)

Returns common use cases for a given status code.

1httpStatusMeaning.getStatusCodeUseCases(404);
2// ["Resource not found", "Endpoint doesn't exist", "Item has been removed"]

Parameters:

• code (Number): The HTTP status code

Returns:

• (Array): Array of strings describing common use cases

Category Validation

isInformational(code)

Checks if a status code is in the Informational category (1xx).

1httpStatusMeaning.isInformational(100); // true
2httpStatusMeaning.isInformational(200); // false

isSuccess(code)

Checks if a status code is in the Success category (2xx).

1httpStatusMeaning.isSuccess(200); // true
2httpStatusMeaning.isSuccess(404); // false

isRedirection(code)

Checks if a status code is in the Redirection category (3xx).

1httpStatusMeaning.isRedirection(301); // true
2httpStatusMeaning.isRedirection(404); // false

isClientError(code)

Checks if a status code is in the Client Error category (4xx).

1httpStatusMeaning.isClientError(404); // true
2httpStatusMeaning.isClientError(500); // false

isServerError(code)

Checks if a status code is in the Server Error category (5xx).

1httpStatusMeaning.isServerError(500); // true
2httpStatusMeaning.isServerError(404); // false

Collection Methods

getStatusCodesByCategory(category, language = 'en')

Returns all status codes in a specific category.

1httpStatusMeaning.getStatusCodesByCategory("success");
2/* Returns:
3{
4  "200": "OK",
5  "201": "Created",
6  "202": "Accepted",
7  ...
8}
9*/

Parameters:

• category (String): One of 'informational', 'success', 'redirection', 'clientError', 'serverError'
• language (String, optional): The language code (defaults to 'en')

Returns:

• (Object): An object with status codes as keys and their meanings as values

getAllStatusCodes(language = 'en')

Returns all status codes.

1httpStatusMeaning.getAllStatusCodes();
2/* Returns:
3{
4  "100": "Continue",
5  "101": "Switching Protocols",
6  "200": "OK",
7  ...
8}
9*/

Parameters:

• language (String, optional): The language code (defaults to 'en')

Returns:

• (Object): An object with status codes as keys and their meanings as values

Internationalization

getSupportedLanguages()

Returns all supported languages.

1httpStatusMeaning.getSupportedLanguages();
2// ["en", "fr", "es", "de", "pt", "it", "ru", "zh", "ja", "ar"]

Returns:

• (Array): Array of language codes

Supported Languages

Currently, the following languages are supported:

Code	Language
en	English
fr	French
es	Spanish
de	German
pt	Portuguese
it	Italian
ru	Russian
zh	Chinese
ja	Japanese
ar	Arabic

Examples

Working with Categories

1// Get all client error status codes
2const clientErrors = httpStatusMeaning.getStatusCodesByCategory("clientError");
3console.log(clientErrors);
4
5// Check if a status code is a server error
6if (httpStatusMeaning.isServerError(statusCode)) {
7  console.log("This is a server error!");
8}

Internationalization Examples

1// Get status meaning in different languages
2console.log(httpStatusMeaning.getStatusMeaning(404, "en")); // "Not Found"
3console.log(httpStatusMeaning.getStatusMeaning(404, "fr")); // "Non trouvé"
4console.log(httpStatusMeaning.getStatusMeaning(404, "es")); // "No encontrado"
5
6// Get all status codes in a specific language
7const germanStatusCodes = httpStatusMeaning.getAllStatusCodes("de");

Using in Express.js

1import express from "express";
2import httpStatusMeaning from "http-status-meaning";
3
4const app = express();
5
6app.use((err, req, res, next) => {
7  const statusCode = err.statusCode || 500;
8
9  // Get user's preferred language from Accept-Language header
10  const language =
11    req.headers["accept-language"]?.split(",")[0]?.split("-")[0] || "en";
12
13  res.status(statusCode).json({
14    error: {
15      status: statusCode,
16      message: httpStatusMeaning.getStatusMeaning(statusCode, language),
17      category: httpStatusMeaning.getStatusCategory(statusCode, language),
18    },
19  });
20});
21
22app.listen(3000);

Creating a Status Code Reference Page

1import httpStatusMeaning from "http-status-meaning";
2
3// Generate HTML for a status code reference
4function generateStatusCodeReference() {
5  const categories = [
6    "informational",
7    "success",
8    "redirection",
9    "clientError",
10    "serverError",
11  ];
12
13  let html = '<div class="status-codes">';
14
15  categories.forEach((category) => {
16    const categoryName = category
17      .replace(/([A-Z])/g, " $1")
18      .replace(/^./, (str) => str.toUpperCase());
19    html += `<h2>${categoryName}</h2><table>`;
20    html +=
21      "<tr><th>Code</th><th>Description</th><th>Common Use Cases</th></tr>";
22
23    const codes = httpStatusMeaning.getStatusCodesByCategory(category);
24
25    for (const code in codes) {
26      const useCases = httpStatusMeaning.getStatusCodeUseCases(Number(code));
27      const useCasesHtml = useCases.length
28        ? `<ul>${useCases
29            .map((useCase) => `<li>${useCase}</li>`)
30            .join("")}</ul>`
31        : "N/A";
32
33      html += `<tr>
34        <td>${code}</td>
35        <td>${codes[code]}</td>
36        <td>${useCasesHtml}</td>
37      </tr>`;
38    }
39
40    html += "</table>";
41  });
42
43  html += "</div>";
44  return html;
45}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.