Flop.paginate

You're seeing just the function paginate, go back to Flop module for more information.

Specs

paginate(Ecto.Queryable.t(), t()) :: Ecto.Queryable.t()

Applies the pagination parameters of a Flop.t/0 to an Ecto.Queryable.t/0.

The function supports both offset/limit based pagination and page/page_size based pagination.

If you validated the Flop.t/0 with Flop.validate/1 before, you can be sure that the given Flop.t/0 only has pagination parameters set for one pagination method. If you pass an unvalidated Flop.t/0 that has pagination parameters set for multiple pagination methods, this function will arbitrarily only apply one of the pagination methods.

Used by Flop.query/2.