@banana-universe/bananajs

---

@banana-universe/bananajs / PaginatedResponse

Class: PaginatedResponse<T>

Defined in: packages/bananajs/src/lib/Pagination/Pagination.ts:12

Extends

• SuccessResponse<T[]>

Type Parameters

T

T

Constructors

Constructor

new PaginatedResponse<T>(message, data, meta): PaginatedResponse<T>

Defined in: packages/bananajs/src/lib/Pagination/Pagination.ts:13

Parameters

message

string

data

T[]

meta

PaginationMeta

Returns

PaginatedResponse<T>

Overrides

SuccessResponse.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

SuccessResponse.message

---

meta

readonly meta: PaginationMeta

Defined in: packages/bananajs/src/lib/Pagination/Pagination.ts:13

---

status

protected status: ResponseStatus

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

The HTTP response status associated with this response.

Inherited from

SuccessResponse.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

SuccessResponse.statusCode

Methods

getData()

getData(): T[]

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

Returns

T[]

Inherited from

SuccessResponse.getData

---

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

SuccessResponse.prepare

---

send()

send(res, headers?): Response

Defined in: packages/bananajs/src/lib/Pagination/Pagination.ts:17

Parameters

res

Response

headers?

Returns

Response

Overrides

SuccessResponse.send