@ingeze/api-error
Version:
A TypeScript library for handling HTTP errors in Express, NestJS, and Fastify APIs.
150 lines • 4.62 kB
TypeScript
/**
* Defines custom error classes for handling various bad request scenarios.
*
* Each class extends `BadRequestError`, which itself extends `ErrorHandler`.
* These errors represent specific client-side validation failures and provide
* descriptive messages and error types for easier error handling and debugging.
*
* @module errors/bad-request-error
*/
import type { BadRequestErrorType } from '../types/index.js';
import { ErrorHandler } from './error-handler.js';
/**
* Represents a generic bad request error (HTTP 400).
*
* @extends ErrorHandler
*/
export declare class BadRequestError extends ErrorHandler {
/**
* Creates a new BadRequestError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
/**
* Creates a new BadRequestError instance with a message and type.
*
* @param {string=} message - Error message.
* @param {BadRequestErrorType=} type - Specific bad request error type.
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(message?: string, type?: BadRequestErrorType, details?: Record<string, unknown>);
}
/**
* Error for missing or invalid user data in the request.
*
* @extends BadRequestError
*/
export declare class InvalidUserDataError extends BadRequestError {
/**
* Creates a new InvalidUserDataError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing email field.
*
* @extends BadRequestError
*/
export declare class InvalidEmailError extends BadRequestError {
/**
* Creates a new InvalidEmailError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing product data.
*
* @extends BadRequestError
*/
export declare class InvalidProductDataError extends BadRequestError {
/**
* Creates a new InvalidProductDataError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing post data.
*
* @extends BadRequestError
*/
export declare class InvalidPostData extends BadRequestError {
/**
* Creates a new InvalidPostData instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing comment data.
*
* @extends BadRequestError
*/
export declare class InvalidCommentDataError extends BadRequestError {
/**
* Creates a new InvalidCommentDataError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing category information.
*
* @extends BadRequestError
*/
export declare class InvalidCategoryDataError extends BadRequestError {
/**
* Creates a new InvalidCategoryDataError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing file in the request.
*
* @extends BadRequestError
*/
export declare class InvalidFileError extends BadRequestError {
/**
* Creates a new InvalidFileError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing image data.
*
* @extends BadRequestError
*/
export declare class InvalidImageError extends BadRequestError {
/**
* Creates a new InvalidImageError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
/**
* Error for invalid or missing address information.
*
* @extends BadRequestError
*/
export declare class InvalidAddressError extends BadRequestError {
/**
* Creates a new InvalidAddressError instance.
*
* @param {Record<string, unknown>=} details - Optional additional error details.
*/
constructor(details?: Record<string, unknown>);
}
//# sourceMappingURL=bad-request-error.d.ts.map