Represents a paginated list response.

Wraps query results with pagination metadata for consistent JSON serialization. EctoTurbo.turbo/3 returns this struct.

The JSON keys for entries and pagination metadata can be customized via the :entry_name and :paginate_name options passed to new/3.

Default JSON Output

{
  "data": [...],
  "pagination": {
    "current_page": 1,
    "current_pages": [1],
    "per_page": 10,
    "next_page": 1,
    "prev_page": 1,
    "total_pages": 1
  },
  "total": 42
}

Custom keys

EctoTurbo.List.new(items, paginate, entry_name: "users", paginate_name: "meta")
# => {"data": [...], "pagination": {...}, "total": 42}