UNPKG

hono-ban

Version:

HTTP-friendly error objects for Hono, inspired by Boom

78 lines (77 loc) 3.72 kB
/** * Server error factory functions (5xx) * @module hono-ban/factories/server-errors */ import type { BanError, BanOptions } from "../types"; /** * Create a 500 Internal Server Error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function internal<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 501 Not Implemented error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function notImplemented<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 502 Bad Gateway error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function badGateway<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 503 Service Unavailable error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function serverUnavailable<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 504 Gateway Timeout error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function gatewayTimeout<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 505 HTTP Version Not Supported error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function httpVersionNotSupported<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 506 Variant Also Negotiates error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function variantAlsoNegotiates<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 507 Insufficient Storage error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function insufficientStorage<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 508 Loop Detected error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function loopDetected<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 510 Not Extended error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function notExtended<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 511 Network Authentication Required error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function networkAuthRequired<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>; /** * Create a 500 Internal Server Error marked as a developer error * @param messageOrOptions - Error message or options * @param options - Additional options */ export declare function badImplementation<T = unknown>(messageOrOptions?: string | Partial<BanOptions<T>>, options?: Partial<BanOptions<T>>): BanError<T>;