@banana-universe/bananajs / ApiResponse
Abstract Class: ApiResponse
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:23
Extended by
SuccessResponseBadRequestResponseUnauthorizedResponsePaymentRequiredErrorResponseForbiddenResponseNotFoundResponseConflictResponseTooManyRequestsResponseInternalErrorResponseBadGatewayResponseServiceUnavailableResponseGatewayTimeoutResponse
Constructors
Constructor
new ApiResponse(
statusCode,status,message):ApiResponse
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:32
Constructs an instance of ApiResponse.
Parameters
statusCode
The status code indicating the success or failure of the operation.
status
The HTTP response status associated with this response.
message
string
A message providing additional information about the response.
Returns
ApiResponse
Properties
message
protectedmessage:string
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:35
A message providing additional information about the response.
status
protectedstatus:ResponseStatus
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:34
The HTTP response status associated with this response.
statusCode
protectedstatusCode:StatusCode
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:33
The status code indicating the success or failure of the operation.
Methods
prepare()
protectedprepare<T>(res,response,headers):Response
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:38
Type Parameters
T
T extends ApiResponse
Parameters
res
Response
response
T
headers
Returns
Response
send()
send(
res,headers?):Response
Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:47
Parameters
res
Response
headers?
Returns
Response