Interface: PreloadedQuery<TQuery>

Defined in: index.d.mts:24

A retained query reference produced by loadQuery.

Pass this value to createPreloadedQuery to read the query result. Dispose it when no longer needed to release retained data and cancel any pending network work.

Type Parameters

TQuery

TQuery extends OperationType

Properties

controls?

readonly optional controls: OpaqueReference<{ dispose: DisposeFn; environment: Environment; getNetworkError: () => Error | null; isDisposed: () => boolean; releaseQuery: () => void; source: RelayObservable<GraphQLResponse> | undefined; }, undefined>

Defined in: index.d.mts:40

Internal controls for retaining, disposing, and observing preload state.

---

fetchKey

readonly fetchKey: string | number

Defined in: index.d.mts:34

Monotonic key used to distinguish subsequent loads.

---

fetchPolicy

readonly fetchPolicy: FetchPolicy

Defined in: index.d.mts:36

Fetch policy used for the preload request.

---

id?

readonly optional id: string | null

Defined in: index.d.mts:28

Persisted query id or cache id when available.

---

kind

readonly kind: "PreloadedQuery"

Defined in: index.d.mts:26

Discriminator used to identify preloaded query references.

---

name

readonly name: string

Defined in: index.d.mts:30

Operation name for diagnostics and debugging.

---

networkCacheConfig?

readonly optional networkCacheConfig: CacheConfig | null

Defined in: index.d.mts:38

Cache config forwarded to the network layer.

---

variables

readonly variables: VariablesOf<TQuery>

Defined in: index.d.mts:32

Variables used when preloading the query.