# `AshScylla.Search.Query.Paginator`
[🔗](https://github.com/ohhi-vn/ash_scylla/blob/main/lib/ash_scylla/search/query/paginator.ex#L1)

Pagination helpers for search results.

# `entry`

```elixir
@type entry() :: {String.t(), float()}
```

# `page`

```elixir
@type page() :: %{
  entries: [entry()],
  page_number: pos_integer(),
  page_size: pos_integer(),
  total_count: non_neg_integer(),
  total_pages: non_neg_integer(),
  has_next?: boolean(),
  has_prev?: boolean()
}
```

# `paginate`

```elixir
@spec paginate(
  [entry()],
  keyword()
) :: {:ok, page()} | {:error, term()}
```

Paginates a list of results.

## Options
  * `:page` — page number, starting at 1 (default: `1`)
  * `:page_size` — number of results per page (default: `20`)

Returns a map with metadata about the current page.

---

*Consult [api-reference.md](api-reference.md) for complete listing*
