Function: createPaginationFragment()

Call Signature

createPaginationFragment<TQuery, TKey>(fragment, key): CreatePaginationFragmentReturn<TQuery, TKey, KeyTypeData<TKey, unknown>>

Defined in: index.d.mts:201

Reads a pagination fragment and exposes pagination controls.

The fragment must include Relay pagination metadata (@connection and @refetchable).

Type Parameters

TQuery

TQuery extends OperationType

TKey

TKey extends Readonly<{ $data?: unknown; $fragmentSpreads: unknown; }>

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document with pagination directives.

key

Accessor<TKey>

Fragment key accessor passed from a parent operation.

Returns

CreatePaginationFragmentReturn<TQuery, TKey, KeyTypeData<TKey, unknown>>

A DataStore containing the fragment data state, augmented with pagination and refetch helpers.

Call Signature

createPaginationFragment<TQuery, TKey>(fragment, key): CreatePaginationFragmentReturn<TQuery, TKey | null, KeyTypeData<TKey, unknown> | null | undefined>

Defined in: index.d.mts:202

Reads a pagination fragment and exposes pagination controls.

The fragment must include Relay pagination metadata (@connection and @refetchable).

Type Parameters

TQuery

TQuery extends OperationType

TKey

TKey extends Readonly<{ $data?: unknown; $fragmentSpreads: unknown; }>

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document with pagination directives.

key

Accessor<TKey | null | undefined>

Fragment key accessor passed from a parent operation.

Returns

CreatePaginationFragmentReturn<TQuery, TKey | null, KeyTypeData<TKey, unknown> | null | undefined>

A DataStore containing the fragment data state, augmented with pagination and refetch helpers.