Skip to main content

index/functions/mergeSafePaginationOptions.md

mergeSafePaginationOptions(base, overrides): BasePaginationOptions

Safely build pagination options from a base object and overrides

Merges base pagination options with overrides, ensuring no undefined values are passed for optional properties.

Parameters​

ParameterTypeDescription
basePartial<BasePaginationOptions>Base pagination options (may be partial)
overridesPartial<BasePaginationOptions>Override values (may have undefined values)

Returns​

BasePaginationOptions

Merged pagination options without undefined properties

Example​

const baseOptions = { pageSize: 50 };
const cursor = getCursor(); // May be undefined

// Merge safely without risk of TS2379 error
const merged = mergeSafePaginationOptions(baseOptions, { cursor });
// Result: { pageSize: 50, cursor: 'abc123' } (if cursor defined)
// Result: { pageSize: 50 } (if cursor undefined)

Since​

8.0.0