Function: createFragment()

Call Signature

createFragment<TKey>(fragment, key, options?): DataStore<KeyTypeData<TKey>>

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

Reads fragment data from a fragment key and subscribes to updates.

Use this primitive when a parent query or fragment passes a generated ...Fragment$key reference into your component.

Type Parameters

TKey

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

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document.

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>>

A DataStore containing the fragment data state.

Call Signature

createFragment<TKey>(fragment, key, options?): DataStore<KeyTypeData<TKey> | null | undefined>

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

Reads fragment data from a fragment key and subscribes to updates.

Use this primitive when a parent query or fragment passes a generated ...Fragment$key reference into your component.

Type Parameters

TKey

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

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document.

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>

A DataStore containing the fragment data state.

Call Signature

createFragment<TKey>(fragment, key, options?): DataStore<ArrayKeyTypeData<TKey>>

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

Reads fragment data from a fragment key and subscribes to updates.

Use this primitive when a parent query or fragment passes a generated ...Fragment$key reference into your component.

Type Parameters

TKey

TKey extends ArrayKeyType

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document.

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<ArrayKeyTypeData<TKey>>

A DataStore containing the fragment data state.

Call Signature

createFragment<TKey>(fragment, key, options?): DataStore<MaybeArray<ArrayKeyTypeData<RequiredArray<TKey>>>>

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

Reads fragment data from a fragment key and subscribes to updates.

Use this primitive when a parent query or fragment passes a generated ...Fragment$key reference into your component.

Type Parameters

TKey

TKey extends readonly (Readonly<{ $data?: readonly unknown[]; $fragmentSpreads: unknown; }> | null | undefined)[]

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document.

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<MaybeArray<ArrayKeyTypeData<RequiredArray<TKey>>>>

A DataStore containing the fragment data state.

Call Signature

createFragment<TKey>(fragment, key, options?): DataStore<ArrayKeyTypeData<TKey> | null | undefined>

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

Reads fragment data from a fragment key and subscribes to updates.

Use this primitive when a parent query or fragment passes a generated ...Fragment$key reference into your component.

Type Parameters

TKey

TKey extends ArrayKeyType

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document.

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<ArrayKeyTypeData<TKey> | null | undefined>

A DataStore containing the fragment data state.

Call Signature

createFragment<TKey>(fragment, key, options?): DataStore<MaybeArray<ArrayKeyTypeData<RequiredArray<TKey>>> | null | undefined>

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

Reads fragment data from a fragment key and subscribes to updates.

Use this primitive when a parent query or fragment passes a generated ...Fragment$key reference into your component.

Type Parameters

TKey

TKey extends readonly (Readonly<{ $data?: readonly unknown[]; $fragmentSpreads: unknown; }> | null | undefined)[]

Parameters

fragment

GraphQLTaggedNode

GraphQL fragment document.

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<MaybeArray<ArrayKeyTypeData<RequiredArray<TKey>>> | null | undefined>

A DataStore containing the fragment data state.