@banana-universe/bananajs

---

@banana-universe/bananajs / ApiResponse

Abstract Class: ApiResponse

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:23

Extended by

• SuccessResponse
• BadRequestResponse
• UnauthorizedResponse
• PaymentRequiredErrorResponse
• ForbiddenResponse
• NotFoundResponse
• ConflictResponse
• TooManyRequestsResponse
• InternalErrorResponse
• BadGatewayResponse
• ServiceUnavailableResponse
• GatewayTimeoutResponse

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

StatusCode

The status code indicating the success or failure of the operation.

status

ResponseStatus

The HTTP response status associated with this response.

message

string

A message providing additional information about the response.

Returns

ApiResponse

Properties

message

protected message: string

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:35

A message providing additional information about the response.

---

status

protected status: ResponseStatus

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:34

The HTTP response status associated with this response.

---

statusCode

protected statusCode: StatusCode

Defined in: packages/bananajs/src/lib/Response/ApiResponse.ts:33

The status code indicating the success or failure of the operation.

Methods

prepare()

protected prepare<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