http-response-status-code/dist/utils/status/index.d.ts

A lightweight utility for retrieving HTTP status codes, names, and descriptions. Easily validate, categorize, and manage HTTP responses with built-in methods for informational, success, redirection, client, and server error codes.

/**
 * Returns the HTTP status code from status code name.
 * @name Get Status Code
 * @param {string} name - The name of the status code (e.g., `"IM_A_TEAPOT"`).
 * @returns {number} code -  The code number of the status if code exists.
 * @throws {Error} An error object if something goes wrong, containing details about the issue.
 *
 * @example
 * var STATUS_CODES = require('http-response-status-code');
 * console.log(STATUS_CODES.getStatusCode("IM_A_TEAPOT")); // 418
 */
export declare function getStatusCode(name: string): number | Error;
/**
 * Returns the HTTP status code name from status code (e.g., `418`).
 * @name Get Status Name
 * @param {number} code - The code number of the status (e.g., `418`).
 * @returns {string} name - The name of the status code if name exists.
 * @throws {Error} An error object if something goes wrong, containing details about the issue.
 *
 * @example
 * var STATUS_CODES = require('http-response-status-code');
 * console.log(STATUS_CODES.getStatusName(418)); // "IM_A_TEAPOT"
 */
export declare function getStatusName(code: number): string | Error;
/**
 * Returns the status description from HTTP status code (e.g., 418).
 * @name Get Status Description
 * @param {number} code - The code number of the status (e.g., `418`).
 * @returns {string} description - The description of the status code if code exists.
 * @throws {Error} An error object if something goes wrong, containing details about the issue.
 *
 * @example
 * var STATUS_CODES = require('http-response-status-code');
 * console.log(STATUS_CODES.getStatusDescription(500)); // "Internal Server Error"
 */
export declare function getStatusDescription(code: number): string | Error;