UNPKG

node-js-api-response

Version:

Unified API response and error handling for Express.js in TypeScript. This package provides a middleware for consistent API responses and error handling in Express applications, making it easier to manage API responses and errors in a standardized way.

651 lines (650 loc) 21.5 kB
declare const BadRequestError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; /** * Custom error classes generated from ErrorDefinitions. * Each class extends a BaseError with corresponding metadata. */ export declare class BadRequestError extends BadRequestError_base { } declare const UnauthorizedError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class UnauthorizedError extends UnauthorizedError_base { } declare const ForbiddenError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class ForbiddenError extends ForbiddenError_base { } declare const NotFoundError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class NotFoundError extends NotFoundError_base { } declare const MethodNotAllowedError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class MethodNotAllowedError extends MethodNotAllowedError_base { } declare const NotAcceptableError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class NotAcceptableError extends NotAcceptableError_base { } declare const ConflictError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class ConflictError extends ConflictError_base { } declare const GoneError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class GoneError extends GoneError_base { } declare const PreconditionFailedError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class PreconditionFailedError extends PreconditionFailedError_base { } declare const UnprocessableEntityError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class UnprocessableEntityError extends UnprocessableEntityError_base { } declare const TooManyRequestsError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class TooManyRequestsError extends TooManyRequestsError_base { } declare const InternalServerError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class InternalServerError extends InternalServerError_base { } declare const NotImplementedError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class NotImplementedError extends NotImplementedError_base { } declare const BadGatewayError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class BadGatewayError extends BadGatewayError_base { } declare const ServiceUnavailableError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class ServiceUnavailableError extends ServiceUnavailableError_base { } declare const GatewayTimeoutError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class GatewayTimeoutError extends GatewayTimeoutError_base { } declare const HttpVersionNotSupportedError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class HttpVersionNotSupportedError extends HttpVersionNotSupportedError_base { } declare const AuthenticationError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class AuthenticationError extends AuthenticationError_base { } declare const AuthorizationError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class AuthorizationError extends AuthorizationError_base { } declare const TokenExpiredError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class TokenExpiredError extends TokenExpiredError_base { } declare const TokenInvalidError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class TokenInvalidError extends TokenInvalidError_base { } declare const SessionTimeoutError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class SessionTimeoutError extends SessionTimeoutError_base { } declare const ValidationError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class ValidationError extends ValidationError_base { } declare const FieldRequiredError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FieldRequiredError extends FieldRequiredError_base { } declare const FieldLengthError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FieldLengthError extends FieldLengthError_base { } declare const FieldFormatError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FieldFormatError extends FieldFormatError_base { } declare const DatabaseConnectionError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class DatabaseConnectionError extends DatabaseConnectionError_base { } declare const RecordNotFoundError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class RecordNotFoundError extends RecordNotFoundError_base { } declare const DuplicateKeyError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class DuplicateKeyError extends DuplicateKeyError_base { } declare const QueryTimeoutError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class QueryTimeoutError extends QueryTimeoutError_base { } declare const DatabaseValidationError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class DatabaseValidationError extends DatabaseValidationError_base { } declare const FileUploadError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FileUploadError extends FileUploadError_base { } declare const FileNotFoundError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FileNotFoundError extends FileNotFoundError_base { } declare const FilePermissionError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FilePermissionError extends FilePermissionError_base { } declare const FileTooLargeError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FileTooLargeError extends FileTooLargeError_base { } declare const ExternalServiceError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class ExternalServiceError extends ExternalServiceError_base { } declare const ServiceTimeoutError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class ServiceTimeoutError extends ServiceTimeoutError_base { } declare const RateLimitExceededError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class RateLimitExceededError extends RateLimitExceededError_base { } declare const FeatureNotEnabledError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class FeatureNotEnabledError extends FeatureNotEnabledError_base { } declare const InvalidStateError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class InvalidStateError extends InvalidStateError_base { } declare const OperationFailedError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class OperationFailedError extends OperationFailedError_base { } declare const InvalidInputError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class InvalidInputError extends InvalidInputError_base { } declare const UnknownError_base: { new (messageOverride?: string): { statusCode: number; status: boolean; errorCode?: string; name: string; message: string; stack?: string; }; captureStackTrace(targetObject: object, constructorOpt?: Function): void; prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any; stackTraceLimit: number; }; export declare class UnknownError extends UnknownError_base { } export {};