Function: createRefetchableFragment()

Call Signature

createRefetchableFragment<TQuery, TKey>(fragment, key, options?): [DataStore<KeyTypeData<TKey>>, RefetchFnDynamic<TQuery, TKey, RefetchOptions>]

Defined in: dist/index.d.mts:180

Reads a @refetchable fragment and returns fragment data plus a refetch function.

The returned refetch function merges provided variables with the fragment's owner variables.

Type Parameters

TQuery

TQuery extends OperationType

TKey

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

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document annotated with @refetchable.

key

Accessor<TKey>

Fragment key accessor passed from a parent operation.

options?

deferStream?

boolean

Whether to defer the SSR stream until the data is resolved.

Returns

[DataStore<KeyTypeData<TKey>>, RefetchFnDynamic<TQuery, TKey, RefetchOptions>]

A tuple of fragment DataStore and a refetch function.

Call Signature

createRefetchableFragment<TQuery, TKey>(fragment, key, options?): [DataStore<KeyTypeData<TKey> | null | undefined>, RefetchFnDynamic<TQuery, TKey, RefetchOptions>]

Defined in: dist/index.d.mts:183

Reads a @refetchable fragment and returns fragment data plus a refetch function.

The returned refetch function merges provided variables with the fragment's owner variables.

Type Parameters

TQuery

TQuery extends OperationType

TKey

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

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document annotated with @refetchable.

key

Accessor<TKey | null | undefined>

Fragment key accessor passed from a parent operation.

options?

deferStream?

boolean

Whether to defer the SSR stream until the data is resolved.

Returns

[DataStore<KeyTypeData<TKey> | null | undefined>, RefetchFnDynamic<TQuery, TKey, RefetchOptions>]

A tuple of fragment DataStore and a refetch function.