@ingeze/api-error/dist/utils/create-handle-error.d.ts

A TypeScript library for handling HTTP errors in Express, NestJS, and Fastify APIs.

import { ErrorHandler } from '../errors/index.js';
/**
 * Options for creating a custom error class.
 *
 * @template TType - A string literal type that defines specific error types (e.g. `'PAYMENT_FAILED'`).
 * @template TDetails - An object that describes additional details associated with the error.
 */
export interface CreateHandleErrorOptions<TType extends string = string, TDetails extends Record<string, unknown> = Record<string, unknown>> {
    /**
     * The name of the custom error class (e.g. `'PaymentFailedError'`).
     */
    name: string;
    /**
     * Default HTTP status code to associate with the error (e.g. `400`, `422`).
     */
    statusCode: number;
    /**
     * Default type identifier for the error (e.g. `'PAYMENT_FAILED'`).
     */
    defaultType: TType;
    /**
     * Optional default error message.
     */
    defaultMessage?: string;
}
/**
 * Factory function to create strongly-typed custom error classes.
 *
 * @template TType - A string literal type that defines specific error types.
 * @template TDetails - A shape of the additional metadata provided with the error.
 *
 * @param {CreateHandleErrorOptions<TType, TDetails>} options - Configuration for the custom error.
 * @returns {new (message?: string, type?: TType, details?: TDetails) => ErrorHandler & {
 *   name: string;
 *   statusCode: number;
 *   type: TType;
 *   details?: TDetails;
 * }} A class constructor for the custom error.
 *
 * @example
 * ```ts
 * const PaymentFailedError = createHandleError({
 *   name: 'PaymentFailedError',
 *   statusCode: 402,
 *   defaultType: 'PAYMENT_FAILED',
 *   defaultMessage: 'Payment could not be processed'
 * })
 *
 * throw new PaymentFailedError()
 * throw new PaymentFailedError('Card declined', 'PAYMENT_DECLINED', { retry: false })
 * ```
 */
export declare function createHandleError<TType extends string = string, TDetails extends Record<string, unknown> = Record<string, unknown>>(options: CreateHandleErrorOptions<TType, TDetails>): {
    new (message?: string, type?: TType, details?: TDetails): ErrorHandler & {
        name: string;
        statusCode: number;
        type: TType;
        details?: TDetails;
    };
};
//# sourceMappingURL=create-handle-error.d.ts.map