index/functions/createPaginationQuery.md

createPaginationQuery(offset, limit?): PaginationQuery

Create pagination query object for API requests

Constructs a standardized pagination query with offset and limit. Validates that offset and limit are within acceptable bounds.

Parameters

Parameter	Type	Description
offset	number	Zero-based offset for pagination
limit?	number	Maximum results per page (default: PAGINATION_DEFAULTS.DEFAULT_LIMIT)

Returns

PaginationQuery

Object with offset and limit ready for API requests

Throws

Error if offset or limit is invalid

Examples

Basic usage

const query = createPaginationQuery(0, 20);
// Result: { offset: 0, limit: 20 }

const params = { ...query, search: 'anime' };
const result = await api.fetchTokens(params);

With default limit

const query = createPaginationQuery(20);
// Result: { offset: 20, limit: PAGINATION_DEFAULTS.DEFAULT_LIMIT }

In API request

const pools = await api.fetchPools({
  ...createPaginationQuery(40, 50),
  search: 'GALA'
});

Since

7.0.0