@beignet/core/dist/errors/http.d.ts

Core framework primitives for Beignet

/**
 * Standard HTTP error catalog
 *
 * A base catalog of common HTTP-related errors that apps can reuse and extend.
 */
/**
 * A base catalog of common HTTP-related errors.
 *
 * Apps can spread this into their own error catalog:
 *
 * @example
 * ```ts
 * import { defineErrors } from "@beignet/core/errors";
 * import { httpErrors } from "@beignet/core/errors/http";
 *
 * export const errors = defineErrors({
 *   ...httpErrors,
 *   TodoNotFound: {
 *     code: "TODO_NOT_FOUND",
 *     status: 404,
 *     message: "Todo not found",
 *   },
 * });
 * ```
 */
export declare const httpErrors: {
    readonly BadRequest: {
        readonly code: "BAD_REQUEST";
        readonly status: 400;
        readonly message: "Bad request";
    };
    readonly Unauthorized: {
        readonly code: "UNAUTHORIZED";
        readonly status: 401;
        readonly message: "Unauthorized";
    };
    readonly Forbidden: {
        readonly code: "FORBIDDEN";
        readonly status: 403;
        readonly message: "Forbidden";
    };
    readonly NotFound: {
        readonly code: "NOT_FOUND";
        readonly status: 404;
        readonly message: "Resource not found";
    };
    readonly Conflict: {
        readonly code: "CONFLICT";
        readonly status: 409;
        readonly message: "Conflict";
    };
    readonly IdempotencyConflict: {
        readonly code: "IDEMPOTENCY_CONFLICT";
        readonly status: 409;
        readonly message: "Idempotency key was already used with a different request";
    };
    readonly IdempotencyInProgress: {
        readonly code: "IDEMPOTENCY_IN_PROGRESS";
        readonly status: 409;
        readonly message: "Idempotency key is already being processed";
    };
    readonly TooManyRequests: {
        readonly code: "TOO_MANY_REQUESTS";
        readonly status: 429;
        readonly message: "Too many requests";
    };
    readonly UnprocessableEntity: {
        readonly code: "UNPROCESSABLE_ENTITY";
        readonly status: 422;
        readonly message: "Unprocessable entity";
    };
    readonly ValidationError: {
        readonly code: "VALIDATION_ERROR";
        readonly status: 422;
        readonly message: "Validation failed";
    };
    readonly InternalServerError: {
        readonly code: "INTERNAL_SERVER_ERROR";
        readonly status: 500;
        readonly message: "Internal server error";
    };
};
/**
 * Type of the default HTTP error catalog.
 */
export type HttpErrorCatalog = typeof httpErrors;
//# sourceMappingURL=http.d.ts.map