@banana-universe/bananajs

---

@banana-universe/bananajs / SuccessResponse

Class: SuccessResponse<T>

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

Extends

• ApiResponse

Extended by

• PaginatedResponse

Type Parameters

T

T

Constructors

Constructor

new SuccessResponse<T>(message, data): SuccessResponse<T>

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

Constructs a new instance of SuccessResponse.

Parameters

message

string

A descriptive message accompanying the response.

data

T

The data payload associated with the success response.

Returns

SuccessResponse<T>

Overrides

ApiResponse.constructor

Properties

message

protected message: string

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

A message providing additional information about the response.

Inherited from

ApiResponse.message

---

status

protected status: ResponseStatus

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

The HTTP response status associated with this response.

Inherited from

ApiResponse.status

---

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.

Inherited from

ApiResponse.statusCode

Methods

getData()

getData(): T

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

Returns

T

---

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

Inherited from

ApiResponse.prepare

---

send()

send(res, headers?): Response

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

Parameters

res

Response

headers?

Returns

Response

Overrides

ApiResponse.send