@nkzw/fate 1.1.0 → 1.2.0

package/docs/api/classes/FateClient.md

@@ -1,6 +1,6 @@
 # Class: FateClient\<Roots, Mutations, HydrationScope\>
 
-Defined in: [packages/fate/src/client.ts:401](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L401)
+Defined in: [packages/fate/src/client.ts:414](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L414)
 
 Core client that normalizes records, manages the view cache, and coordinates
 data fetching.
@@ -25,7 +25,7 @@ data fetching.
 
 > **new FateClient**\<`Roots`, `Mutations`, `HydrationScope`\>(`options`): `FateClient`\<`Roots`, `Mutations`, `HydrationScope`\>
 
-Defined in: [packages/fate/src/client.ts:447](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L447)
+Defined in: [packages/fate/src/client.ts:461](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L461)
 
 #### Parameters
 
@@ -43,7 +43,7 @@ Defined in: [packages/fate/src/client.ts:447](https://github.com/nkzw-tech/fate/
 
 > `readonly` **actions**: `MutationTreeFromRecord`\<`Mutations`\>
 
-Defined in: [packages/fate/src/client.ts:443](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L443)
+Defined in: [packages/fate/src/client.ts:457](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L457)
 
 ***
 
@@ -51,7 +51,7 @@ Defined in: [packages/fate/src/client.ts:443](https://github.com/nkzw-tech/fate/
 
 > `readonly` **mutations**: `MutationTreeFromRecord`\<`Mutations`\>
 
-Defined in: [packages/fate/src/client.ts:444](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L444)
+Defined in: [packages/fate/src/client.ts:458](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L458)
 
 ***
 
@@ -59,7 +59,7 @@ Defined in: [packages/fate/src/client.ts:444](https://github.com/nkzw-tech/fate/
 
 > `readonly` **roots**: `Roots`
 
-Defined in: [packages/fate/src/client.ts:445](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L445)
+Defined in: [packages/fate/src/client.ts:459](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L459)
 
 ***
 
@@ -67,7 +67,7 @@ Defined in: [packages/fate/src/client.ts:445](https://github.com/nkzw-tech/fate/
 
 > `readonly` **store**: `Store`
 
-Defined in: [packages/fate/src/client.ts:434](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L434)
+Defined in: [packages/fate/src/client.ts:448](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L448)
 
 ## Methods
 
@@ -75,7 +75,7 @@ Defined in: [packages/fate/src/client.ts:434](https://github.com/nkzw-tech/fate/
 
 > **assertLiveConnectionSupport**(): `void`
 
-Defined in: [packages/fate/src/client.ts:987](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L987)
+Defined in: [packages/fate/src/client.ts:1098](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1098)
 
 #### Returns
 
@@ -87,7 +87,7 @@ Defined in: [packages/fate/src/client.ts:987](https://github.com/nkzw-tech/fate/
 
 > **assertLiveViewSupport**(): `void`
 
-Defined in: [packages/fate/src/client.ts:979](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L979)
+Defined in: [packages/fate/src/client.ts:1090](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1090)
 
 #### Returns
 
@@ -99,7 +99,7 @@ Defined in: [packages/fate/src/client.ts:979](https://github.com/nkzw-tech/fate/
 
 > **clearOptimisticUpdate**(`token`): `void`
 
-Defined in: [packages/fate/src/client.ts:1638](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1638)
+Defined in: [packages/fate/src/client.ts:1749](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1749)
 
 #### Parameters
 
@@ -117,7 +117,7 @@ Defined in: [packages/fate/src/client.ts:1638](https://github.com/nkzw-tech/fate
 
 > **dehydrate**(): [`FateDehydratedState`](../type-aliases/FateDehydratedState.md)\<`HydrationScope`\>
 
-Defined in: [packages/fate/src/client.ts:539](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L539)
+Defined in: [packages/fate/src/client.ts:553](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L553)
 
 Exports the durable normalized cache as an opaque JSON-safe value for SSR
 transfer or persistence. Runtime requests, subscriptions, retainers, and
@@ -133,7 +133,7 @@ optimistic state are intentionally excluded.
 
 > **deleteRecord**(`type`, `id`, `snapshots?`, `listSnapshots?`): `void`
 
-Defined in: [packages/fate/src/client.ts:789](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L789)
+Defined in: [packages/fate/src/client.ts:803](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L803)
 
 #### Parameters
 
@@ -163,7 +163,7 @@ Defined in: [packages/fate/src/client.ts:789](https://github.com/nkzw-tech/fate/
 
 > **executeMutation**(`key`, `input`, `select`, `options?`): `Promise`\<`unknown`\>
 
-Defined in: [packages/fate/src/client.ts:731](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L731)
+Defined in: [packages/fate/src/client.ts:745](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L745)
 
 #### Parameters
 
@@ -199,7 +199,7 @@ Defined in: [packages/fate/src/client.ts:731](https://github.com/nkzw-tech/fate/
 
 > **filterSelectionForPendingOptimistics**(`entityId`, `select`, `options?`): `Set`\<`string`\>
 
-Defined in: [packages/fate/src/client.ts:1701](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1701)
+Defined in: [packages/fate/src/client.ts:1812](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1812)
 
 #### Parameters
 
@@ -227,7 +227,7 @@ Defined in: [packages/fate/src/client.ts:1701](https://github.com/nkzw-tech/fate
 
 > **gc**(): `void`
 
-Defined in: [packages/fate/src/client.ts:2024](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L2024)
+Defined in: [packages/fate/src/client.ts:2135](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2135)
 
 Removes records and lists that are not reachable from retained requests or
 the release buffer.
@@ -246,7 +246,7 @@ memory-management flows.
 
 > **getPendingOptimisticMask**(`entityId`, `options?`): `FieldMask` \| `null`
 
-Defined in: [packages/fate/src/client.ts:1660](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1660)
+Defined in: [packages/fate/src/client.ts:1771](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1771)
 
 #### Parameters
 
@@ -270,7 +270,7 @@ Defined in: [packages/fate/src/client.ts:1660](https://github.com/nkzw-tech/fate
 
 > **getRequestKey**(`request`): `string`
 
-Defined in: [packages/fate/src/client.ts:2255](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L2255)
+Defined in: [packages/fate/src/client.ts:2366](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2366)
 
 #### Parameters
 
@@ -288,7 +288,7 @@ Defined in: [packages/fate/src/client.ts:2255](https://github.com/nkzw-tech/fate
 
 > **getRequestResult**\<`R`\>(`request`): [`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
 
-Defined in: [packages/fate/src/client.ts:2395](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L2395)
+Defined in: [packages/fate/src/client.ts:2506](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2506)
 
 #### Type Parameters
 
@@ -312,7 +312,7 @@ Defined in: [packages/fate/src/client.ts:2395](https://github.com/nkzw-tech/fate
 
 > **getTypeConfig**(`type`): [`TypeConfig`](../type-aliases/TypeConfig.md)
 
-Defined in: [packages/fate/src/client.ts:723](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L723)
+Defined in: [packages/fate/src/client.ts:737](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L737)
 
 #### Parameters
 
@@ -330,7 +330,7 @@ Defined in: [packages/fate/src/client.ts:723](https://github.com/nkzw-tech/fate/
 
 > **hydrate**(`state`, `options?`): `void`
 
-Defined in: [packages/fate/src/client.ts:566](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L566)
+Defined in: [packages/fate/src/client.ts:580](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L580)
 
 Restores a durable normalized cache snapshot without restoring runtime
 request handles, retainers, subscriptions, or optimistic update state.
@@ -356,7 +356,7 @@ Hydrate before rendering SSR content. Replaying the same snapshot is safe.
 
 > **loadConnection**\<`V`\>(`view`, `connection`, `args`, `options?`): `Promise`\<`Readonly`\<\{ `backwardPageLimit?`: `number`; `cursors?`: readonly (`string` \| `undefined`)[]; `forwardPageLimit?`: `number`; `ids`: readonly `string`[]; `liveAfterIds?`: readonly `string`[]; `liveBeforeIds?`: readonly `string`[]; `pagination?`: [`Pagination`](../type-aliases/Pagination.md); `pendingAfterIds?`: readonly `string`[]; `pendingBeforeIds?`: readonly `string`[]; \}\> \| `undefined`\>
 
-Defined in: [packages/fate/src/client.ts:1725](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1725)
+Defined in: [packages/fate/src/client.ts:1836](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1836)
 
 #### Type Parameters
 
@@ -394,7 +394,7 @@ Defined in: [packages/fate/src/client.ts:1725](https://github.com/nkzw-tech/fate
 
 > **prepareRequestForRender**\<`R`\>(`request`, `options`): `Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
 
-Defined in: [packages/fate/src/client.ts:1906](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1906)
+Defined in: [packages/fate/src/client.ts:2017](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2017)
 
 #### Type Parameters
 
@@ -418,11 +418,35 @@ Defined in: [packages/fate/src/client.ts:1906](https://github.com/nkzw-tech/fate
 
 ***
 
+### readDeferred()
+
+> **readDeferred**\<`T`\>(`deferred`): `PromiseLike`\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: `T`; \}\>\>
+
+Defined in: [packages/fate/src/client.ts:993](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L993)
+
+#### Type Parameters
+
+##### T
+
+`T`
+
+#### Parameters
+
+##### deferred
+
+[`Deferred`](../type-aliases/Deferred.md)\<`T`\>
+
+#### Returns
+
+`PromiseLike`\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: `T`; \}\>\>
+
+***
+
 ### readView()
 
 > **readView**\<`T`, `S`, `V`\>(`view`, `ref`): [`FateThenable`](../interfaces/FateThenable.md)\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: [`ViewData`](../type-aliases/ViewData.md)\<`T`, `S`\>; \}\>\>
 
-Defined in: [packages/fate/src/client.ts:852](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L852)
+Defined in: [packages/fate/src/client.ts:866](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L866)
 
 #### Type Parameters
 
@@ -458,7 +482,7 @@ Defined in: [packages/fate/src/client.ts:852](https://github.com/nkzw-tech/fate/
 
 > **ref**\<`T`\>(`type`, `id`, `view`): [`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
 
-Defined in: [packages/fate/src/client.ts:839](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L839)
+Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L853)
 
 #### Type Parameters
 
@@ -490,7 +514,7 @@ Defined in: [packages/fate/src/client.ts:839](https://github.com/nkzw-tech/fate/
 
 > **registerOptimisticUpdate**(`entityId`, `select`): `number` \| `null`
 
-Defined in: [packages/fate/src/client.ts:1619](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1619)
+Defined in: [packages/fate/src/client.ts:1730](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1730)
 
 #### Parameters
 
@@ -512,7 +536,7 @@ Defined in: [packages/fate/src/client.ts:1619](https://github.com/nkzw-tech/fate
 
 > **registerPendingOptimisticMutation**(`entityId`, `promise`): `void`
 
-Defined in: [packages/fate/src/client.ts:1589](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1589)
+Defined in: [packages/fate/src/client.ts:1700](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1700)
 
 #### Parameters
 
@@ -534,7 +558,7 @@ Defined in: [packages/fate/src/client.ts:1589](https://github.com/nkzw-tech/fate
 
 > **releaseRequest**(`request`, `mode`): `void`
 
-Defined in: [packages/fate/src/client.ts:1963](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1963)
+Defined in: [packages/fate/src/client.ts:2074](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2074)
 
 #### Parameters
 
@@ -556,7 +580,7 @@ Defined in: [packages/fate/src/client.ts:1963](https://github.com/nkzw-tech/fate
 
 > **releaseRequestKey**(`requestKey`, `mode`): `void`
 
-Defined in: [packages/fate/src/client.ts:1967](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1967)
+Defined in: [packages/fate/src/client.ts:2078](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2078)
 
 #### Parameters
 
@@ -578,7 +602,7 @@ Defined in: [packages/fate/src/client.ts:1967](https://github.com/nkzw-tech/fate
 
 > **request**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
 
-Defined in: [packages/fate/src/client.ts:1889](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1889)
+Defined in: [packages/fate/src/client.ts:2000](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2000)
 
 #### Type Parameters
 
@@ -606,7 +630,7 @@ Defined in: [packages/fate/src/client.ts:1889](https://github.com/nkzw-tech/fate
 
 > **requestForRender**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
 
-Defined in: [packages/fate/src/client.ts:1899](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1899)
+Defined in: [packages/fate/src/client.ts:2010](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2010)
 
 #### Type Parameters
 
@@ -634,7 +658,7 @@ Defined in: [packages/fate/src/client.ts:1899](https://github.com/nkzw-tech/fate
 
 > **resolveOptimisticEntity**(`optimisticEntityId`, `resolvedEntityId`): `void`
 
-Defined in: [packages/fate/src/client.ts:1614](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1614)
+Defined in: [packages/fate/src/client.ts:1725](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1725)
 
 #### Parameters
 
@@ -656,7 +680,7 @@ Defined in: [packages/fate/src/client.ts:1614](https://github.com/nkzw-tech/fate
 
 > **restore**(`id`, `snapshot`): `void`
 
-Defined in: [packages/fate/src/client.ts:807](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L807)
+Defined in: [packages/fate/src/client.ts:821](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L821)
 
 #### Parameters
 
@@ -678,7 +702,7 @@ Defined in: [packages/fate/src/client.ts:807](https://github.com/nkzw-tech/fate/
 
 > **restoreList**(`name`, `list?`): `void`
 
-Defined in: [packages/fate/src/client.ts:812](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L812)
+Defined in: [packages/fate/src/client.ts:826](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L826)
 
 #### Parameters
 
@@ -700,7 +724,7 @@ Defined in: [packages/fate/src/client.ts:812](https://github.com/nkzw-tech/fate/
 
 > **retain**(`request`): `RetainHandle`
 
-Defined in: [packages/fate/src/client.ts:1998](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1998)
+Defined in: [packages/fate/src/client.ts:2109](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2109)
 
 Keeps the records and lists reachable from a request alive until the
 returned handle is disposed.
@@ -725,7 +749,7 @@ that must survive manual garbage collection.
 
 > **retainRequestKey**(`requestKey`, `mode?`): `RetainHandle`
 
-Defined in: [packages/fate/src/client.ts:1979](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1979)
+Defined in: [packages/fate/src/client.ts:2090](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2090)
 
 #### Parameters
 
@@ -747,7 +771,7 @@ Defined in: [packages/fate/src/client.ts:1979](https://github.com/nkzw-tech/fate
 
 > **rootListRef**(`entityId`, `rootView`): `Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
 
-Defined in: [packages/fate/src/client.ts:847](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L847)
+Defined in: [packages/fate/src/client.ts:861](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L861)
 
 #### Parameters
 
@@ -769,7 +793,7 @@ Defined in: [packages/fate/src/client.ts:847](https://github.com/nkzw-tech/fate/
 
 > **subscribeLiveListView**\<`V`\>(`view`, `connection`): () => `void`
 
-Defined in: [packages/fate/src/client.ts:1079](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L1079)
+Defined in: [packages/fate/src/client.ts:1190](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1190)
 
 #### Type Parameters
 
@@ -797,7 +821,7 @@ Defined in: [packages/fate/src/client.ts:1079](https://github.com/nkzw-tech/fate
 
 > **subscribeLiveView**\<`T`, `S`, `V`\>(`view`, `ref`): () => `void`
 
-Defined in: [packages/fate/src/client.ts:995](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L995)
+Defined in: [packages/fate/src/client.ts:1106](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L1106)
 
 #### Type Parameters
 
@@ -833,7 +857,7 @@ Defined in: [packages/fate/src/client.ts:995](https://github.com/nkzw-tech/fate/
 
 > **trackPendingRequest**\<`T`\>(`request`): `Promise`\<`T`\>
 
-Defined in: [packages/fate/src/client.ts:2212](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L2212)
+Defined in: [packages/fate/src/client.ts:2323](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L2323)
 
 #### Type Parameters
 
@@ -857,7 +881,7 @@ Defined in: [packages/fate/src/client.ts:2212](https://github.com/nkzw-tech/fate
 
 > **write**(`type`, `data`, `select`, `snapshots?`, `plan?`, `pathPrefix?`, `blockedMask?`, `insert?`, `listSnapshots?`): `string`
 
-Defined in: [packages/fate/src/client.ts:765](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L765)
+Defined in: [packages/fate/src/client.ts:779](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L779)
 
 #### Parameters
 

package/docs/api/functions/clientRoot.md

@@ -2,7 +2,7 @@
 
 > **clientRoot**\<`Result`, `Type`\>(`type`): `RootDefinition`\<`Type`, `Result`\>
 
-Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/root.ts#L7)
+Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/root.ts#L7)
 
 Defines a root query for an entity type, capturing the response shape.
 

package/docs/api/functions/createClient.md

@@ -2,7 +2,7 @@
 
 > **createClient**\<`T`, `HydrationScope`\>(`options`): [`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>
 
-Defined in: [packages/fate/src/client.ts:3181](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/client.ts#L3181)
+Defined in: [packages/fate/src/client.ts:3377](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/client.ts#L3377)
 
 ## Type Parameters
 

package/docs/api/functions/createGraphQLTransport.md

@@ -2,7 +2,7 @@
 
 > **createGraphQLTransport**\<`Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
 
-Defined in: [packages/fate/src/graphqlTransport.ts:578](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L578)
+Defined in: [packages/fate/src/graphqlTransport.ts:578](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/graphqlTransport.ts#L578)
 
 ## Type Parameters
 

package/docs/api/functions/createHTTPTransport.md

@@ -2,7 +2,7 @@
 
 > **createHTTPTransport**\<`API`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
 
-Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/httpTransport.ts#L265)
+Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/httpTransport.ts#L265)
 
 ## Type Parameters
 

package/docs/api/functions/createTRPCTransport.md

@@ -2,7 +2,7 @@
 
 > **createTRPCTransport**\<`AppRouter`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`MutationMapFromResolvers`\<`Mutations`\>\>
 
-Defined in: [packages/fate/src/transport.ts:149](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/transport.ts#L149)
+Defined in: [packages/fate/src/transport.ts:149](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/transport.ts#L149)
 
 Builds a `Transport` backed by a tRPC client using the configured resolvers
 for by-id queries, lists, and mutations.

package/docs/api/functions/defer.md

@@ -0,0 +1,21 @@
+# Function: defer()
+
+> **defer**\<`S`\>(`selection`): [`DeferredSelection`](../type-aliases/DeferredSelection.md)\<`S`\>
+
+Defined in: [packages/fate/src/defer.ts:9](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/defer.ts#L9)
+
+## Type Parameters
+
+### S
+
+`S`
+
+## Parameters
+
+### selection
+
+`S`
+
+## Returns
+
+[`DeferredSelection`](../type-aliases/DeferredSelection.md)\<`S`\>

package/docs/api/functions/getDeferredMetadata.md

@@ -0,0 +1,21 @@
+# Function: getDeferredMetadata()
+
+> **getDeferredMetadata**\<`T`\>(`deferred`): [`DeferredMetadata`](../type-aliases/DeferredMetadata.md)
+
+Defined in: [packages/fate/src/defer.ts:28](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/defer.ts#L28)
+
+## Type Parameters
+
+### T
+
+`T`
+
+## Parameters
+
+### deferred
+
+[`Deferred`](../type-aliases/Deferred.md)\<`T`\>
+
+## Returns
+
+[`DeferredMetadata`](../type-aliases/DeferredMetadata.md)

package/docs/api/functions/getListEntries.md

@@ -2,7 +2,7 @@
 
 > **getListEntries**(`listState`): `Readonly`\<\{ `cursor?`: `string`; `id`: `string`; \}\>[]
 
-Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/list.ts#L6)
+Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/list.ts#L6)
 
 ## Parameters
 

package/docs/api/functions/getSelectionPlan.md

@@ -2,7 +2,7 @@
 
 > **getSelectionPlan**\<`T`, `S`, `V`\>(`viewComposition`, `ref`): `SelectionPlan`
 
-Defined in: [packages/fate/src/selection.ts:37](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/selection.ts#L37)
+Defined in: [packages/fate/src/selection.ts:38](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/selection.ts#L38)
 
 Flattens a view into a `SelectionPlan`, expanding composed views and
 partitioning nested args so the client can fetch exactly what is declared.

package/docs/api/functions/graphqlMutation.md

@@ -2,7 +2,7 @@
 
 > **graphqlMutation**\<`T`, `Input`, `Output`\>(`entity`, `options`): [`GraphQLMutationDefinition`](../type-aliases/GraphQLMutationDefinition.md)\<`T`, `Input`, `Output`\>
 
-Defined in: [packages/fate/src/graphqlTransport.ts:567](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/graphqlTransport.ts#L567)
+Defined in: [packages/fate/src/graphqlTransport.ts:567](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/graphqlTransport.ts#L567)
 
 ## Type Parameters
 

package/docs/api/functions/isDeferred.md

@@ -0,0 +1,15 @@
+# Function: isDeferred()
+
+> **isDeferred**(`value`): `value is Deferred<unknown>`
+
+Defined in: [packages/fate/src/defer.ts:25](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/defer.ts#L25)
+
+## Parameters
+
+### value
+
+`unknown`
+
+## Returns
+
+`value is Deferred<unknown>`

package/docs/api/functions/isRecord.md

@@ -2,7 +2,7 @@
 
 > **isRecord**(`value`): `value is FateRecord`
 
-Defined in: [packages/fate/src/record.ts:3](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/record.ts#L3)
+Defined in: [packages/fate/src/record.ts:3](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/record.ts#L3)
 
 ## Parameters
 

package/docs/api/functions/isViewTag.md

@@ -2,7 +2,7 @@
 
 > **isViewTag**(`key`): `` key is `__fate-view__${string}` ``
 
-Defined in: [packages/fate/src/types.ts:59](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/types.ts#L59)
+Defined in: [packages/fate/src/types.ts:66](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/types.ts#L66)
 
 Determines whether a property key is a fate view tag.
 

package/docs/api/functions/liveConnectionTopic.md

@@ -2,7 +2,7 @@
 
 > **liveConnectionTopic**(`procedure`, `args?`): `string`
 
-Defined in: [packages/fate/src/liveTopics.ts:20](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/liveTopics.ts#L20)
+Defined in: [packages/fate/src/liveTopics.ts:20](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/liveTopics.ts#L20)
 
 ## Parameters
 

package/docs/api/functions/liveEntityTopic.md

@@ -2,7 +2,7 @@
 
 > **liveEntityTopic**(`type`, `id`): `string`
 
-Defined in: [packages/fate/src/liveTopics.ts:17](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/liveTopics.ts#L17)
+Defined in: [packages/fate/src/liveTopics.ts:17](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/liveTopics.ts#L17)
 
 ## Parameters
 

package/docs/api/functions/liveGlobalConnectionTopic.md

@@ -2,7 +2,7 @@
 
 > **liveGlobalConnectionTopic**(`procedure`): `string`
 
-Defined in: [packages/fate/src/liveTopics.ts:25](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/liveTopics.ts#L25)
+Defined in: [packages/fate/src/liveTopics.ts:25](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/liveTopics.ts#L25)
 
 ## Parameters
 

package/docs/api/functions/mutation.md

@@ -2,7 +2,7 @@
 
 > **mutation**\<`T`, `I`, `R`\>(`entity`): [`MutationDefinition`](../type-aliases/MutationDefinition.md)\<`T`, `I`, `R`\>
 
-Defined in: [packages/fate/src/mutation.ts:28](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/mutation.ts#L28)
+Defined in: [packages/fate/src/mutation.ts:28](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/mutation.ts#L28)
 
 Defines a mutation for a given entity type, preserving the input and output
 types for transports.

package/docs/api/functions/toEntityId.md

@@ -2,7 +2,7 @@
 
 > **toEntityId**(`type`, `rawId`): `string`
 
-Defined in: [packages/fate/src/ref.ts:16](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/ref.ts#L16)
+Defined in: [packages/fate/src/ref.ts:16](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/ref.ts#L16)
 
 Builds the canonical cache ID for an entity.
 

package/docs/api/functions/view.md

@@ -2,7 +2,7 @@
 
 > **view**\<`T`\>(): \<`S`\>(`select`) => [`View`](../type-aliases/View.md)\<`T`, `S`\>
 
-Defined in: [packages/fate/src/view.ts:111](https://github.com/nkzw-tech/fate/blob/b6f90b96eb193852523df58a538c7900829d4862/packages/fate/src/view.ts#L111)
+Defined in: [packages/fate/src/view.ts:111](https://github.com/nkzw-tech/fate/blob/92f28ac4263e4f242ab8546c3bc2123a24b18461/packages/fate/src/view.ts#L111)
 
 Creates a reusable view for an object using the declared selection.
 

package/docs/api/index.md

@@ -21,6 +21,10 @@ import { view } from '@nkzw/fate';
 
 - [ConnectionMetadata](type-aliases/ConnectionMetadata.md)
 - [ConnectionRef](type-aliases/ConnectionRef.md)
+- [Deferred](type-aliases/Deferred.md)
+- [DeferredMetadata](type-aliases/DeferredMetadata.md)
+- [DeferredSelection](type-aliases/DeferredSelection.md)
+- [DeferredSnapshot](type-aliases/DeferredSnapshot.md)
 - [Entity](type-aliases/Entity.md)
 - [EntityId](type-aliases/EntityId.md)
 - [FateDehydratedState](type-aliases/FateDehydratedState.md)
@@ -70,6 +74,8 @@ import { view } from '@nkzw/fate';
 ## Variables
 
 - [ConnectionTag](variables/ConnectionTag.md)
+- [DeferredTag](variables/DeferredTag.md)
+- [DeferTag](variables/DeferTag.md)
 
 ## Functions
 
@@ -78,9 +84,12 @@ import { view } from '@nkzw/fate';
 - [createGraphQLTransport](functions/createGraphQLTransport.md)
 - [createHTTPTransport](functions/createHTTPTransport.md)
 - [createTRPCTransport](functions/createTRPCTransport.md)
+- [defer](functions/defer.md)
+- [getDeferredMetadata](functions/getDeferredMetadata.md)
 - [getListEntries](functions/getListEntries.md)
 - [getSelectionPlan](functions/getSelectionPlan.md)
 - [graphqlMutation](functions/graphqlMutation.md)
+- [isDeferred](functions/isDeferred.md)
 - [isRecord](functions/isRecord.md)
 - [isViewTag](functions/isViewTag.md)
 - [liveConnectionTopic](functions/liveConnectionTopic.md)