Skip to main content

Function: addCursorToPagination()

Gala Launchpad SDK 9.0.0-rc.5

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

Function: addCursorToPagination()

addCursorToPagination(baseOptions, cursor): BasePaginationOptions

Defined in: packages/launchpad-sdk/dist/utils/pagination-validation.d.ts:87

Conditionally include a cursor in pagination options

Useful for the common pattern of optionally including cursor-based pagination.

Parameters​

baseOptions​

BasePaginationOptions

Base pagination options

cursor​

string | undefined

Cursor token (may be undefined)

Returns​

BasePaginationOptions

Options with cursor only if cursor is defined

Example​

const nextPageOptions = addCursorToPagination(
  { pageSize: 50 },
  pageInfo.endCursor ?? undefined
);
// Result: { pageSize: 50, cursor: 'abc123' } or { pageSize: 50 }
// depending on whether endCursor is set

Since​

8.0.0