PaginatedResponse

interface PaginatedResponse<T> {
data: T[];
meta?: ResponseMeta;
pagination: PaginationMeta;
success: true;
}

Source: api.ts:251

Paginated API response

Type Parameters

T — Item type

Example

CODE

const response: PaginatedResponse<User> = {
  success: true,
  data: [user1, user2, user3],
  pagination: {
    page: 1,
    limit: 10,
    total: 100,
    totalPages: 10,
    hasNextPage: true,
    hasPreviousPage: false
  }
}

Properties

`data: T[]`

api.ts:255

Array of items

`meta: ResponseMeta`

api.ts:259

Additional metadata

`pagination: PaginationMeta`

api.ts:257

Pagination metadata

`success: true`

api.ts:253

Success flag