Spaces:
Running
Running
File size: 3,172 Bytes
e9affa5 721abf7 e9affa5 9d56cbc 721abf7 e9affa5 484fdbc e9affa5 f39e411 e9affa5 f39e411 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
import { Response } from "express";
import {
IJSONSuccessResponse,
IJSONErrorResponse,
IJSONValidationErrorResponse,
} from "./json-responses";
import {
IJSONSuccessResponseProps,
IJSONErrorResponseProps,
IJSONValidationErrorResponseProps,
} from "./json-responses-params";
/**
* Represents a base class for JSON responses.
*/
export abstract class JsonResponse {
private constructor() {}
/**
* Generates a success response object.
*
* @param props - The properties for the success response.
* @param res - Optional Express response object to send the response.
* @returns The success response object or the Express response object if provided.
*/
static success<T>(props: IJSONSuccessResponseProps<T>): IJSONSuccessResponse<T>;
static success<T>(
props: IJSONSuccessResponseProps<T>,
res: Response<IJSONSuccessResponse<T>>
): Response<IJSONSuccessResponse<T>>;
static success<T>(
props: IJSONSuccessResponseProps<T>,
res?: Response<IJSONSuccessResponse<T>>
): IJSONSuccessResponse<T> | Response<IJSONSuccessResponse<T>> {
const data = {
status: props.status || 200,
message: props.message || "Success",
data: props.data || null,
meta: (props as any).meta,
} satisfies IJSONSuccessResponse<T>;
return (res && res.status(data.status).json(data)) || data;
}
/**
* Creates a JSON error response.
* @param props - The properties for the error response.
* @param res - Optional response object to send the error response.
* @returns The JSON error response object or the response object if provided.
*/
static error(props: IJSONErrorResponseProps): IJSONErrorResponse;
static error(
props: IJSONErrorResponseProps,
res: Response<IJSONErrorResponse>
): Response<IJSONErrorResponse>;
static error(
props: IJSONErrorResponseProps,
res?: Response<IJSONErrorResponse>
): IJSONErrorResponse | Response<IJSONErrorResponse> {
const data = {
status: props.status || 500,
message: props.message || "Something Went Wrong",
error: props.error,
} satisfies IJSONErrorResponse;
return (res && res.status(data.status).json(data)) || data;
}
/**
* Represents a validation error response.
* @param props - The properties of the validation error response.
* @param res - Optional response object to send the JSON response.
* @returns The validation error response object or the response object if provided.
*/
static validationError(
props: IJSONValidationErrorResponseProps
): IJSONValidationErrorResponse;
static validationError(
props: IJSONValidationErrorResponseProps,
res: Response<IJSONValidationErrorResponse>
): Response<IJSONValidationErrorResponse>;
static validationError(
props: IJSONValidationErrorResponseProps,
res?: Response<IJSONValidationErrorResponse>
): IJSONValidationErrorResponse | Response<IJSONValidationErrorResponse> {
const data = {
status: 422,
message: "Validation Error",
errors: props.errors,
} satisfies IJSONValidationErrorResponse;
return (res && res.status(data.status).json(data)) || data;
}
}
|