Skip to main content

Function: createPaginationQuery()

Gala Launchpad SDK 9.0.0-rc.5

Gala Launchpad SDK 9.0.0-rc.5 / index / createPaginationQuery

Function: createPaginationQuery()

createPaginationQuery(offset, limit?): PaginationQuery

Defined in: packages/launchpad-sdk/dist/utils/pagination-helpers.d.ts:64

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​

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