http-response-status-code/dist/constants/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.

import { CODES } from "./codes.constant";
import { HTTP_STATUS_MAPPINGS } from "./http-status-codes.constant";
import { ClassLimits, ClassTypes } from "./class-limit.constant";
import { ICodeList, IHttpStatusCodes, IHttpStatusDescriptions, IHttpStatusNames } from "../interfaces";
/**
 * A mapping of HTTP status codes to their respective status names.
 * @constant {IHttpStatusNames} HTTP_STATUS_NAMES - A mapping of HTTP status codes to their respective status names.
 * @type {Object<number, string>}
 */
declare const HTTP_STATUS_NAMES: IHttpStatusNames;
/**
 * A mapping of HTTP status names to their respective status codes.
 * @constant {IHttpStatusCodes} HTTP_STATUS_CODES - A mapping of HTTP status names to their respective status codes.
 * @type {Object<string, number>}
 */
declare const HTTP_STATUS_CODES: IHttpStatusCodes;
/**
 * A mapping of HTTP status codes to their respective status descriptions.
 * @constant {IHttpStatusDescriptions} HTTP_STATUS_DESCRIPTION - A mapping of HTTP status codes to their respective status descriptions.
 * @type {Object<number, string>}
 */
declare const HTTP_STATUS_DESCRIPTION: IHttpStatusDescriptions;
/**
 * A List of all the informational HTTP status codes.
 * @constant {IHttpStatusDescriptions} INFORMATIONAL_CODES - A List of all the informational HTTP status codes.
 * @type {number[]}
 */
declare const INFORMATIONAL_CODES: ICodeList | Error;
/**
 * A List of all the success HTTP status codes.
 * @constant {IHttpStatusDescriptions} SUCCESS_CODES - A List of all the success HTTP status codes.
 * @type {number[]}
 */
declare const SUCCESS_CODES: ICodeList | Error;
/**
 * A List of all the redirection HTTP status codes.
 * @constant {IHttpStatusDescriptions} REDIRECTION_CODES - A List of all the redirection HTTP status codes.
 * @type {number[]}
 */
declare const REDIRECTION_CODES: ICodeList | Error;
/**
 * A List of all the client side error HTTP status codes.
 * @constant {IHttpStatusDescriptions} CLIENT_SIDE_ERROR_CODES - A List of all the client side error HTTP status codes.
 * @type {number[]}
 */
declare const CLIENT_ERROR_CODES: ICodeList | Error;
/**
 * A List of all the server side error HTTP status codes.
 * @constant {IHttpStatusDescriptions} SERVER_ERROR_CODES - A List of all the server side error HTTP status codes.
 * @type {number[]}
 */
declare const SERVER_ERROR_CODES: ICodeList | Error;
export { CODES, HTTP_STATUS_MAPPINGS, HTTP_STATUS_NAMES, HTTP_STATUS_CODES, HTTP_STATUS_DESCRIPTION, ClassLimits, ClassTypes, INFORMATIONAL_CODES, SUCCESS_CODES, REDIRECTION_CODES, CLIENT_ERROR_CODES, SERVER_ERROR_CODES, };