nyro/src/helpers/errorHandler.ts

A simple and effective promise-based HTTP & HTTP/2 request library that supports all HTTP methods.

/**
 * Object containing the status text for each HTTP status code.
 */
  const StatusText: { [key: string]: string } = {
    '100': 'Continue',
    '101': 'Switching Protocols',
    '102': 'Processing',
    '103': 'Early Hints',
    '200': 'OK',
    '201': 'Created',
    '202': 'Accepted',
    '203': 'Non-Authoritative Information',
    '204': 'No Content',
    '205': 'Reset Content',
    '206': 'Partial Content',
    '207': 'Multi-Status',
    '208': 'Already Reported',
    '226': 'IM Used',
    '300': 'Multiple Choices',
    '301': 'Moved Permanently',
    '302': 'Found',
    '303': 'See Other',
    '304': 'Not Modified',
    '305': 'Use Proxy',
    '306': 'Unused',
    '307': 'Temporary Redirect',
    '308': 'Permanent Redirect',
    '309': 'Resume Incomplete',
    '310': 'Too Many Redirects',
    '311': 'Blocked by Windows Parental Controls',
    '312': 'Redirect',
    '313': 'Redirect Method',
    '314': 'Requested URI Too Long',
    '315': 'Moved Temporarily',
    '316': 'Switch Proxy',
    '317': 'Switch Redirect',
    '400': 'Bad Request',
    '401': 'Unauthorized',
    '402': 'Payment Required',
    '403': 'Forbidden',
    '404': 'Not Found',
    '405': 'Method Not Allowed',
    '406': 'Not Acceptable',
    '407': 'Proxy Authentication Required',
    '408': 'Request Timeout',
    '409': 'Conflict',
    '410': 'Gone',
    '411': 'Length Required',
    '412': 'Precondition Failed',
    '413': 'Payload Too Large',
    '414': 'URI Too Long',
    '415': 'Unsupported Media Type',
    '416': 'Range Not Satisfiable',
    '417': 'Expectation Failed',
    '418': 'I\'m a teapot',
    '421': 'Misdirected Request',
    '422': 'Unprocessable Entity',
    '423': 'Locked',
    '424': 'Failed Dependency',
    '425': 'Too Early',
    '426': 'Upgrade Required',
    '428': 'Precondition Required',
    '429': 'Too Many Requests',
    '431': 'Request Header Fields Too Large',
    '451': 'Unavailable For Legal Reasons',
    '500': 'Internal Server Error',
    '501': 'Not Implemented',
    '502': 'Bad Gateway',
    '503': 'Service Unavailable',
    '504': 'Gateway Timeout',
    '505': 'HTTP Version Not Supported',
    '506': 'Variant Also Negotiates',
    '507': 'Insufficient Storage',
    '508': 'Loop Detected',
    '510': 'Not Extended',
    '511': 'Network Authentication Required',
    'unknown': 'Unknown Error',
  };


/**
 * Interface representing the options for handling errors.
 * 
 * @interface ErrorHandlerOptions
 * 
 * @property {string} message - The error message to be displayed.
 * @property {any} [requestOptions] - Optional request options associated with the error.
 * @property {number} statusCode - The HTTP status code associated with the error.
 * @property {string} name - The name of the error.
 * @property {Error} [error] - Optional original error object.
 */
export interface NyroErrorInterface {
    message: string;
    requestOptions?: any;
    response?: any;
    request?: any;
    statusCode: number;
    name: string;
    error?: Error;
    body?: any;
};

/** 
* Interface representing the error response object.
* 
* @interface NyroErrorResponse
* 
* @property {string} message - The error message to be displayed.
* @property {any} [requestOptions] - Optional request options associated with the error.
* @property {string} [statusText] - The status text associated with the error.
* @property {number} statusCode - The HTTP status code associated with the error.
* @property {string} name - The name of the error.
* @property {Error} [error] - Optional original error object.
*/
export interface NyroErrorResponse {
    message: string;
    requestOptions?: any;
    request?: any;
    response?: any;
    statusText?: string;
    statusCode: number;
    name: string;
    error?: Error;
    body?: any;
};


export function isNyroError(error: any): error is ErrorHandler {
    return error instanceof ErrorHandler;
};


export default class ErrorHandler extends Error {
    requestOptions?: any;
    statusText?: string;
    statusCode: number;
    response?: any;
    request?: any;
    body?: any;
    constructor(errorHandlerOptions: NyroErrorInterface) {
        super(errorHandlerOptions.message);
        this.message = errorHandlerOptions.message;
        this.name = 'NyroError';
        this.statusText = StatusText[errorHandlerOptions.statusCode] || StatusText['unknown'];
        this.requestOptions = errorHandlerOptions.requestOptions;
        this.statusCode = errorHandlerOptions.statusCode;
        this.response = errorHandlerOptions.response;
        this.request = errorHandlerOptions.request;
        this.body = errorHandlerOptions.body;
        this.stack = errorHandlerOptions.error?.stack;
    }
}