@nkzw/fate 1.4.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +326 -0
- package/docs/api/classes/FateClient.md +51 -199
- package/docs/api/functions/clientRoot.md +1 -1
- package/docs/api/functions/createClient.md +1 -1
- package/docs/api/functions/createGraphQLTransport.md +1 -1
- package/docs/api/functions/createHTTPTransport.md +1 -1
- package/docs/api/functions/createTRPCTransport.md +5 -1
- package/docs/api/functions/defer.md +1 -1
- package/docs/api/functions/getDeferredMetadata.md +1 -1
- package/docs/api/functions/getListEntries.md +1 -1
- package/docs/api/functions/getSelectionPlan.md +1 -1
- package/docs/api/functions/graphqlMutation.md +1 -1
- package/docs/api/functions/isDeferred.md +1 -1
- package/docs/api/functions/isRecord.md +1 -1
- package/docs/api/functions/isViewTag.md +1 -1
- package/docs/api/functions/liveConnectionTopic.md +1 -1
- package/docs/api/functions/liveEntityTopic.md +1 -1
- package/docs/api/functions/liveGlobalConnectionTopic.md +1 -1
- package/docs/api/functions/mutation.md +1 -1
- package/docs/api/functions/toEntityId.md +1 -1
- package/docs/api/functions/view.md +1 -1
- package/docs/api/index.md +4 -1
- package/docs/api/interfaces/FateThenable.md +3 -3
- package/docs/api/interfaces/Persistence.md +23 -0
- package/docs/api/interfaces/PersistenceSession.md +109 -0
- package/docs/api/interfaces/Transport.md +46 -7
- package/docs/api/server/classes/FateRequestError.md +5 -5
- package/docs/api/server/drizzle/functions/createDrizzleFate.md +1 -1
- package/docs/api/server/drizzle/functions/createDrizzleSourceAdapter.md +1 -1
- package/docs/api/server/drizzle/functions/createDrizzleSourceRegistry.md +1 -1
- package/docs/api/server/drizzle/type-aliases/DrizzleManyToManyConfig.md +1 -1
- package/docs/api/server/drizzle/type-aliases/DrizzleManyToManyInput.md +1 -1
- package/docs/api/server/drizzle/type-aliases/DrizzleQueryExtra.md +3 -3
- package/docs/api/server/drizzle/type-aliases/DrizzleSourceAdapter.md +9 -9
- package/docs/api/server/drizzle/type-aliases/DrizzleViewConfig.md +1 -1
- package/docs/api/server/functions/bindSourceProcedures.md +1 -1
- package/docs/api/server/functions/computed.md +1 -1
- package/docs/api/server/functions/count.md +1 -1
- package/docs/api/server/functions/createFateFetchHandler.md +1 -1
- package/docs/api/server/functions/createFateServer.md +1 -1
- package/docs/api/server/functions/createHonoFateHandler.md +1 -1
- package/docs/api/server/functions/createLiveEventBus.md +1 -1
- package/docs/api/server/functions/createNestedSourcePlan.md +1 -1
- package/docs/api/server/functions/createResolver.md +1 -1
- package/docs/api/server/functions/createSourcePlan.md +1 -1
- package/docs/api/server/functions/createSourceProcedures.md +1 -1
- package/docs/api/server/functions/dataView.md +1 -1
- package/docs/api/server/functions/field.md +1 -1
- package/docs/api/server/functions/getNestedSelection.md +1 -1
- package/docs/api/server/functions/getScopedArgs.md +1 -1
- package/docs/api/server/functions/hasNestedSelection.md +1 -1
- package/docs/api/server/functions/list.md +1 -1
- package/docs/api/server/functions/refetchSourceById.md +1 -1
- package/docs/api/server/functions/resolveSourceById.md +1 -1
- package/docs/api/server/functions/resolveSourceByIds.md +1 -1
- package/docs/api/server/functions/resolveSourceConnection.md +1 -1
- package/docs/api/server/functions/resolver.md +1 -1
- package/docs/api/server/functions/toPrismaSelect.md +1 -1
- package/docs/api/server/functions/withConnection.md +1 -1
- package/docs/api/server/prisma/functions/createPrismaFate.md +1 -1
- package/docs/api/server/prisma/functions/createPrismaSourceAdapter.md +1 -1
- package/docs/api/server/prisma/functions/createPrismaSourceRegistry.md +1 -1
- package/docs/api/server/prisma/functions/prismaConnectionArgs.md +1 -1
- package/docs/api/server/prisma/type-aliases/PrismaDelegate.md +4 -4
- package/docs/api/server/prisma/type-aliases/PrismaQueryExtra.md +1 -1
- package/docs/api/server/prisma/type-aliases/PrismaSourceAdapter.md +9 -9
- package/docs/api/server/prisma/type-aliases/PrismaViewConfig.md +1 -1
- package/docs/api/server/type-aliases/ComputedField.md +5 -5
- package/docs/api/server/type-aliases/ComputedSelection.md +1 -1
- package/docs/api/server/type-aliases/ConnectionItem.md +3 -3
- package/docs/api/server/type-aliases/ConnectionPagination.md +5 -5
- package/docs/api/server/type-aliases/ConnectionResult.md +3 -3
- package/docs/api/server/type-aliases/CountSelection.md +4 -4
- package/docs/api/server/type-aliases/CountWhere.md +1 -1
- package/docs/api/server/type-aliases/DataViewListOptions.md +2 -2
- package/docs/api/server/type-aliases/DataViewOrderBy.md +1 -1
- package/docs/api/server/type-aliases/DataViewOrderDirection.md +1 -1
- package/docs/api/server/type-aliases/DataViewResult.md +1 -1
- package/docs/api/server/type-aliases/Entity.md +1 -1
- package/docs/api/server/type-aliases/FateServer.md +5 -5
- package/docs/api/server/type-aliases/FateServerManifest.md +1 -1
- package/docs/api/server/type-aliases/FieldSelection.md +3 -3
- package/docs/api/server/type-aliases/LiveConnectionEventType.md +1 -1
- package/docs/api/server/type-aliases/LiveConnectionSourceEvent.md +1 -1
- package/docs/api/server/type-aliases/LiveEventBus.md +1 -1
- package/docs/api/server/type-aliases/LiveEventType.md +1 -1
- package/docs/api/server/type-aliases/LiveSourceEvent.md +1 -1
- package/docs/api/server/type-aliases/NativeFateAPI.md +4 -4
- package/docs/api/server/type-aliases/OrderDirection.md +1 -1
- package/docs/api/server/type-aliases/SourceConfig.md +6 -6
- package/docs/api/server/type-aliases/SourceDefinition.md +6 -6
- package/docs/api/server/type-aliases/SourceOrder.md +1 -1
- package/docs/api/server/type-aliases/SourceOrderField.md +3 -3
- package/docs/api/server/type-aliases/SourcePlan.md +1 -1
- package/docs/api/server/type-aliases/SourcePlanNode.md +1 -1
- package/docs/api/server/type-aliases/SourceRegistry.md +1 -1
- package/docs/api/server/type-aliases/SourceRelation.md +1 -1
- package/docs/api/server/type-aliases/SourceRelationConfig.md +1 -1
- package/docs/api/server/variables/byIdInput.md +1 -1
- package/docs/api/server/variables/connectionArgs.md +1 -1
- package/docs/api/type-aliases/ConnectionMetadata.md +1 -1
- package/docs/api/type-aliases/ConnectionRef.md +1 -1
- package/docs/api/type-aliases/Deferred.md +1 -1
- package/docs/api/type-aliases/DeferredMetadata.md +1 -1
- package/docs/api/type-aliases/DeferredSelection.md +1 -1
- package/docs/api/type-aliases/DeferredSnapshot.md +1 -1
- package/docs/api/type-aliases/Entity.md +2 -2
- package/docs/api/type-aliases/EntityId.md +1 -1
- package/docs/api/type-aliases/FateDehydratedState.md +1 -1
- package/docs/api/type-aliases/FateLiveConnectionEvent.md +1 -1
- package/docs/api/type-aliases/FateLiveEvent.md +1 -1
- package/docs/api/type-aliases/FateMutations.md +1 -1
- package/docs/api/type-aliases/FateOperation.md +2 -2
- package/docs/api/type-aliases/FateProtocolRequest.md +1 -1
- package/docs/api/type-aliases/FateProtocolResponse.md +1 -1
- package/docs/api/type-aliases/FateRecord.md +1 -1
- package/docs/api/type-aliases/FateRoots.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationDefinition.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationInput.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationMap.md +1 -1
- package/docs/api/type-aliases/GraphQLMutationOutput.md +1 -1
- package/docs/api/type-aliases/GraphQLTransportOptions.md +19 -11
- package/docs/api/type-aliases/HydrateOptions.md +1 -1
- package/docs/api/type-aliases/HydrationLimits.md +1 -1
- package/docs/api/type-aliases/InferFateAPI.md +1 -1
- package/docs/api/type-aliases/List.md +1 -1
- package/docs/api/type-aliases/ListEntry.md +1 -1
- package/docs/api/type-aliases/ListItem.md +1 -1
- package/docs/api/type-aliases/Mask.md +1 -1
- package/docs/api/type-aliases/MutationDefinition.md +1 -1
- package/docs/api/type-aliases/MutationEntity.md +1 -1
- package/docs/api/type-aliases/MutationIdentifier.md +1 -1
- package/docs/api/type-aliases/MutationIdentity.md +7 -0
- package/docs/api/type-aliases/MutationInput.md +1 -1
- package/docs/api/type-aliases/MutationResult.md +1 -1
- package/docs/api/type-aliases/NodesItem.md +1 -1
- package/docs/api/type-aliases/Pagination.md +5 -5
- package/docs/api/type-aliases/PersistenceSnapshot.md +5 -0
- package/docs/api/type-aliases/Request.md +1 -1
- package/docs/api/type-aliases/RequestMode.md +1 -1
- package/docs/api/type-aliases/RequestOptions.md +2 -2
- package/docs/api/type-aliases/RequestResult.md +1 -1
- package/docs/api/type-aliases/Selection.md +1 -1
- package/docs/api/type-aliases/TypeConfig.md +4 -4
- package/docs/api/type-aliases/View.md +1 -1
- package/docs/api/type-aliases/ViewData.md +1 -1
- package/docs/api/type-aliases/ViewEntity.md +1 -1
- package/docs/api/type-aliases/ViewEntityName.md +1 -1
- package/docs/api/type-aliases/ViewRef.md +1 -1
- package/docs/api/type-aliases/ViewSelection.md +1 -1
- package/docs/api/type-aliases/ViewSnapshot.md +1 -1
- package/docs/api/type-aliases/ViewTag.md +1 -1
- package/docs/api/variables/ConnectionTag.md +1 -1
- package/docs/api/variables/DeferTag.md +1 -1
- package/docs/api/variables/DeferredTag.md +1 -1
- package/docs/guide/getting-started.md +2 -0
- package/docs/guide/persistence.md +323 -0
- package/lib/{liveTopics-uVP0LG-Q.mjs → args-CRLIRl_v.mjs} +1 -59
- package/lib/{executor-BRudKWDY.d.mts → executor-DoiTBiVv.d.mts} +1 -1
- package/lib/{graphqlTransport-BDR1pnUQ.d.mts → graphqlTransport-DGLYyRxL.d.mts} +3 -2
- package/lib/{graphqlTransport-DSBVS2Fq.mjs → graphqlTransport-DmheG3AO.mjs} +3 -2
- package/lib/graphqlTransport.d.mts +1 -1
- package/lib/graphqlTransport.mjs +1 -1
- package/lib/hydration-DPZRJgnu.mjs +273 -0
- package/lib/idempotency-types-CqA-BFpn.d.mts +15 -0
- package/lib/idempotency.d.mts +26 -0
- package/lib/idempotency.mjs +34 -0
- package/lib/index.d.mts +5 -5
- package/lib/index.mjs +265 -1567
- package/lib/{list-Bb1SeABn.d.mts → list-BRT1VtiT.d.mts} +1 -1
- package/lib/list.d.mts +1 -1
- package/lib/liveTopics-DuFkDZQm.mjs +17 -0
- package/lib/persistence.d.mts +38 -0
- package/lib/persistence.mjs +1529 -0
- package/lib/protocol-DS5sf6sd.mjs +44 -0
- package/lib/{record-BTUXkHQU.d.mts → record-DITM4zb_.d.mts} +8 -4
- package/lib/server/drizzle.d.mts +2 -2
- package/lib/server/drizzle.mjs +1 -1
- package/lib/server/prisma.d.mts +2 -2
- package/lib/server/prisma.mjs +1 -6
- package/lib/server.d.mts +3 -3
- package/lib/server.mjs +19 -7
- package/lib/sortObjectKeys-yhuitEQZ.mjs +9 -0
- package/lib/{sourceRouter-DSaADXSf.mjs → sourceRouter-51POBlEE.mjs} +9 -6
- package/lib/store-CeatPJeK.mjs +1350 -0
- package/lib/{transport-Bo1Jgo9R.d.mts → transport-DqjhjLfC.d.mts} +594 -412
- package/lib/vite.mjs +18 -10
- package/package.json +12 -2
- package/docs/api/type-aliases/Snapshot.md +0 -7
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Class: FateClient\<Roots, Mutations, HydrationScope\>
|
|
2
2
|
|
|
3
|
-
Defined in: [packages/fate/src/client.ts:
|
|
3
|
+
Defined in: [packages/fate/src/client.ts:419](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L419)
|
|
4
4
|
|
|
5
5
|
Core client that normalizes records, manages the view cache, and coordinates
|
|
6
6
|
data fetching.
|
|
@@ -25,7 +25,7 @@ data fetching.
|
|
|
25
25
|
|
|
26
26
|
> **new FateClient**\<`Roots`, `Mutations`, `HydrationScope`\>(`options`): `FateClient`\<`Roots`, `Mutations`, `HydrationScope`\>
|
|
27
27
|
|
|
28
|
-
Defined in: [packages/fate/src/client.ts:
|
|
28
|
+
Defined in: [packages/fate/src/client.ts:479](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L479)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -43,7 +43,7 @@ Defined in: [packages/fate/src/client.ts:461](https://github.com/nkzw-tech/fate/
|
|
|
43
43
|
|
|
44
44
|
> `readonly` **actions**: `MutationTreeFromRecord`\<`Mutations`\>
|
|
45
45
|
|
|
46
|
-
Defined in: [packages/fate/src/client.ts:
|
|
46
|
+
Defined in: [packages/fate/src/client.ts:475](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L475)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -51,7 +51,15 @@ Defined in: [packages/fate/src/client.ts:457](https://github.com/nkzw-tech/fate/
|
|
|
51
51
|
|
|
52
52
|
> `readonly` **mutations**: `MutationTreeFromRecord`\<`Mutations`\>
|
|
53
53
|
|
|
54
|
-
Defined in: [packages/fate/src/client.ts:
|
|
54
|
+
Defined in: [packages/fate/src/client.ts:476](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L476)
|
|
55
|
+
|
|
56
|
+
***
|
|
57
|
+
|
|
58
|
+
### persistence?
|
|
59
|
+
|
|
60
|
+
> `readonly` `optional` **persistence?**: [`PersistenceSession`](../interfaces/PersistenceSession.md)
|
|
61
|
+
|
|
62
|
+
Defined in: [packages/fate/src/client.ts:474](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L474)
|
|
55
63
|
|
|
56
64
|
***
|
|
57
65
|
|
|
@@ -59,7 +67,7 @@ Defined in: [packages/fate/src/client.ts:458](https://github.com/nkzw-tech/fate/
|
|
|
59
67
|
|
|
60
68
|
> `readonly` **roots**: `Roots`
|
|
61
69
|
|
|
62
|
-
Defined in: [packages/fate/src/client.ts:
|
|
70
|
+
Defined in: [packages/fate/src/client.ts:477](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L477)
|
|
63
71
|
|
|
64
72
|
***
|
|
65
73
|
|
|
@@ -67,7 +75,7 @@ Defined in: [packages/fate/src/client.ts:459](https://github.com/nkzw-tech/fate/
|
|
|
67
75
|
|
|
68
76
|
> `readonly` **store**: `Store`
|
|
69
77
|
|
|
70
|
-
Defined in: [packages/fate/src/client.ts:
|
|
78
|
+
Defined in: [packages/fate/src/client.ts:456](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L456)
|
|
71
79
|
|
|
72
80
|
## Methods
|
|
73
81
|
|
|
@@ -75,7 +83,7 @@ Defined in: [packages/fate/src/client.ts:448](https://github.com/nkzw-tech/fate/
|
|
|
75
83
|
|
|
76
84
|
> **assertLiveConnectionSupport**(): `void`
|
|
77
85
|
|
|
78
|
-
Defined in: [packages/fate/src/client.ts:
|
|
86
|
+
Defined in: [packages/fate/src/client.ts:1258](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1258)
|
|
79
87
|
|
|
80
88
|
#### Returns
|
|
81
89
|
|
|
@@ -87,25 +95,7 @@ Defined in: [packages/fate/src/client.ts:1106](https://github.com/nkzw-tech/fate
|
|
|
87
95
|
|
|
88
96
|
> **assertLiveViewSupport**(): `void`
|
|
89
97
|
|
|
90
|
-
Defined in: [packages/fate/src/client.ts:
|
|
91
|
-
|
|
92
|
-
#### Returns
|
|
93
|
-
|
|
94
|
-
`void`
|
|
95
|
-
|
|
96
|
-
***
|
|
97
|
-
|
|
98
|
-
### clearOptimisticUpdate()
|
|
99
|
-
|
|
100
|
-
> **clearOptimisticUpdate**(`token`): `void`
|
|
101
|
-
|
|
102
|
-
Defined in: [packages/fate/src/client.ts:1757](https://github.com/nkzw-tech/fate/blob/aec05ea2ab0386693600d573021cd2a93f1d8b59/packages/fate/src/client.ts#L1757)
|
|
103
|
-
|
|
104
|
-
#### Parameters
|
|
105
|
-
|
|
106
|
-
##### token
|
|
107
|
-
|
|
108
|
-
`number` \| `null`
|
|
98
|
+
Defined in: [packages/fate/src/client.ts:1250](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1250)
|
|
109
99
|
|
|
110
100
|
#### Returns
|
|
111
101
|
|
|
@@ -117,7 +107,7 @@ Defined in: [packages/fate/src/client.ts:1757](https://github.com/nkzw-tech/fate
|
|
|
117
107
|
|
|
118
108
|
> **dehydrate**(): [`FateDehydratedState`](../type-aliases/FateDehydratedState.md)\<`HydrationScope`\>
|
|
119
109
|
|
|
120
|
-
Defined in: [packages/fate/src/client.ts:
|
|
110
|
+
Defined in: [packages/fate/src/client.ts:581](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L581)
|
|
121
111
|
|
|
122
112
|
Exports the durable normalized cache as an opaque JSON-safe value for SSR
|
|
123
113
|
transfer or persistence. Runtime requests, subscriptions, retainers, and
|
|
@@ -131,9 +121,9 @@ optimistic state are intentionally excluded.
|
|
|
131
121
|
|
|
132
122
|
### deleteRecord()
|
|
133
123
|
|
|
134
|
-
> **deleteRecord**(`type`, `id
|
|
124
|
+
> **deleteRecord**(`type`, `id`): `void`
|
|
135
125
|
|
|
136
|
-
Defined in: [packages/fate/src/client.ts:
|
|
126
|
+
Defined in: [packages/fate/src/client.ts:933](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L933)
|
|
137
127
|
|
|
138
128
|
#### Parameters
|
|
139
129
|
|
|
@@ -145,14 +135,6 @@ Defined in: [packages/fate/src/client.ts:811](https://github.com/nkzw-tech/fate/
|
|
|
145
135
|
|
|
146
136
|
`string` \| `number`
|
|
147
137
|
|
|
148
|
-
##### snapshots?
|
|
149
|
-
|
|
150
|
-
`Map`\<`string`, `Readonly`\<\{ `mask?`: `FieldMask`; `record?`: [`FateRecord`](../type-aliases/FateRecord.md); \}\>\>
|
|
151
|
-
|
|
152
|
-
##### listSnapshots?
|
|
153
|
-
|
|
154
|
-
`Map`\<`string`, `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`[]; \}\>\>
|
|
155
|
-
|
|
156
138
|
#### Returns
|
|
157
139
|
|
|
158
140
|
`void`
|
|
@@ -163,7 +145,7 @@ Defined in: [packages/fate/src/client.ts:811](https://github.com/nkzw-tech/fate/
|
|
|
163
145
|
|
|
164
146
|
> **executeMutation**(`key`, `input`, `select`, `options?`): `Promise`\<`unknown`\>
|
|
165
147
|
|
|
166
|
-
Defined in: [packages/fate/src/client.ts:
|
|
148
|
+
Defined in: [packages/fate/src/client.ts:885](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L885)
|
|
167
149
|
|
|
168
150
|
#### Parameters
|
|
169
151
|
|
|
@@ -185,6 +167,10 @@ Defined in: [packages/fate/src/client.ts:753](https://github.com/nkzw-tech/fate/
|
|
|
185
167
|
|
|
186
168
|
[`FateRecord`](../type-aliases/FateRecord.md)
|
|
187
169
|
|
|
170
|
+
###### identity?
|
|
171
|
+
|
|
172
|
+
`Readonly`\<\{ `id`: `string`; `replayOnly?`: `true`; `scope`: `string`; \}\>
|
|
173
|
+
|
|
188
174
|
###### plan?
|
|
189
175
|
|
|
190
176
|
`SelectionPlan`
|
|
@@ -195,39 +181,11 @@ Defined in: [packages/fate/src/client.ts:753](https://github.com/nkzw-tech/fate/
|
|
|
195
181
|
|
|
196
182
|
***
|
|
197
183
|
|
|
198
|
-
### filterSelectionForPendingOptimistics()
|
|
199
|
-
|
|
200
|
-
> **filterSelectionForPendingOptimistics**(`entityId`, `select`, `options?`): `Set`\<`string`\>
|
|
201
|
-
|
|
202
|
-
Defined in: [packages/fate/src/client.ts:1820](https://github.com/nkzw-tech/fate/blob/aec05ea2ab0386693600d573021cd2a93f1d8b59/packages/fate/src/client.ts#L1820)
|
|
203
|
-
|
|
204
|
-
#### Parameters
|
|
205
|
-
|
|
206
|
-
##### entityId
|
|
207
|
-
|
|
208
|
-
`string` \| `null`
|
|
209
|
-
|
|
210
|
-
##### select
|
|
211
|
-
|
|
212
|
-
`Set`\<`string`\>
|
|
213
|
-
|
|
214
|
-
##### options?
|
|
215
|
-
|
|
216
|
-
###### excludeToken?
|
|
217
|
-
|
|
218
|
-
`number` \| `null`
|
|
219
|
-
|
|
220
|
-
#### Returns
|
|
221
|
-
|
|
222
|
-
`Set`\<`string`\>
|
|
223
|
-
|
|
224
|
-
***
|
|
225
|
-
|
|
226
184
|
### gc()
|
|
227
185
|
|
|
228
186
|
> **gc**(): `void`
|
|
229
187
|
|
|
230
|
-
Defined in: [packages/fate/src/client.ts:
|
|
188
|
+
Defined in: [packages/fate/src/client.ts:2221](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2221)
|
|
231
189
|
|
|
232
190
|
Removes records and lists that are not reachable from retained requests or
|
|
233
191
|
the release buffer.
|
|
@@ -242,35 +200,11 @@ memory-management flows.
|
|
|
242
200
|
|
|
243
201
|
***
|
|
244
202
|
|
|
245
|
-
### getPendingOptimisticMask()
|
|
246
|
-
|
|
247
|
-
> **getPendingOptimisticMask**(`entityId`, `options?`): `FieldMask` \| `null`
|
|
248
|
-
|
|
249
|
-
Defined in: [packages/fate/src/client.ts:1779](https://github.com/nkzw-tech/fate/blob/aec05ea2ab0386693600d573021cd2a93f1d8b59/packages/fate/src/client.ts#L1779)
|
|
250
|
-
|
|
251
|
-
#### Parameters
|
|
252
|
-
|
|
253
|
-
##### entityId
|
|
254
|
-
|
|
255
|
-
`string` \| `null`
|
|
256
|
-
|
|
257
|
-
##### options?
|
|
258
|
-
|
|
259
|
-
###### excludeToken?
|
|
260
|
-
|
|
261
|
-
`number` \| `null`
|
|
262
|
-
|
|
263
|
-
#### Returns
|
|
264
|
-
|
|
265
|
-
`FieldMask` \| `null`
|
|
266
|
-
|
|
267
|
-
***
|
|
268
|
-
|
|
269
203
|
### getRequestKey()
|
|
270
204
|
|
|
271
205
|
> **getRequestKey**(`request`): `string`
|
|
272
206
|
|
|
273
|
-
Defined in: [packages/fate/src/client.ts:
|
|
207
|
+
Defined in: [packages/fate/src/client.ts:2505](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2505)
|
|
274
208
|
|
|
275
209
|
#### Parameters
|
|
276
210
|
|
|
@@ -288,7 +222,7 @@ Defined in: [packages/fate/src/client.ts:2366](https://github.com/nkzw-tech/fate
|
|
|
288
222
|
|
|
289
223
|
> **getRequestResult**\<`R`\>(`request`): [`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
|
|
290
224
|
|
|
291
|
-
Defined in: [packages/fate/src/client.ts:
|
|
225
|
+
Defined in: [packages/fate/src/client.ts:2681](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2681)
|
|
292
226
|
|
|
293
227
|
#### Type Parameters
|
|
294
228
|
|
|
@@ -312,7 +246,7 @@ Defined in: [packages/fate/src/client.ts:2506](https://github.com/nkzw-tech/fate
|
|
|
312
246
|
|
|
313
247
|
> **getTypeConfig**(`type`): [`TypeConfig`](../type-aliases/TypeConfig.md)
|
|
314
248
|
|
|
315
|
-
Defined in: [packages/fate/src/client.ts:
|
|
249
|
+
Defined in: [packages/fate/src/client.ts:830](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L830)
|
|
316
250
|
|
|
317
251
|
#### Parameters
|
|
318
252
|
|
|
@@ -330,7 +264,7 @@ Defined in: [packages/fate/src/client.ts:737](https://github.com/nkzw-tech/fate/
|
|
|
330
264
|
|
|
331
265
|
> **hydrate**(`state`, `options?`): `void`
|
|
332
266
|
|
|
333
|
-
Defined in: [packages/fate/src/client.ts:
|
|
267
|
+
Defined in: [packages/fate/src/client.ts:608](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L608)
|
|
334
268
|
|
|
335
269
|
Restores a durable normalized cache snapshot without restoring runtime
|
|
336
270
|
request handles, retainers, subscriptions, or optimistic update state.
|
|
@@ -356,7 +290,7 @@ Hydrate before rendering SSR content. Replaying the same snapshot is safe.
|
|
|
356
290
|
|
|
357
291
|
> **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`\>
|
|
358
292
|
|
|
359
|
-
Defined in: [packages/fate/src/client.ts:
|
|
293
|
+
Defined in: [packages/fate/src/client.ts:1910](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1910)
|
|
360
294
|
|
|
361
295
|
#### Type Parameters
|
|
362
296
|
|
|
@@ -394,7 +328,7 @@ Defined in: [packages/fate/src/client.ts:1844](https://github.com/nkzw-tech/fate
|
|
|
394
328
|
|
|
395
329
|
> **prepareRequestForRender**\<`R`\>(`request`, `options`): `Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
|
|
396
330
|
|
|
397
|
-
Defined in: [packages/fate/src/client.ts:
|
|
331
|
+
Defined in: [packages/fate/src/client.ts:2083](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2083)
|
|
398
332
|
|
|
399
333
|
#### Type Parameters
|
|
400
334
|
|
|
@@ -410,7 +344,7 @@ Defined in: [packages/fate/src/client.ts:2017](https://github.com/nkzw-tech/fate
|
|
|
410
344
|
|
|
411
345
|
##### options
|
|
412
346
|
|
|
413
|
-
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); \}\> \| `undefined`
|
|
347
|
+
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`: \{ `maxAge`: `number`; \}; \}\> \| `undefined`
|
|
414
348
|
|
|
415
349
|
#### Returns
|
|
416
350
|
|
|
@@ -422,7 +356,7 @@ Defined in: [packages/fate/src/client.ts:2017](https://github.com/nkzw-tech/fate
|
|
|
422
356
|
|
|
423
357
|
> **readDeferred**\<`T`\>(`deferred`): `PromiseLike`\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: `T`; \}\>\>
|
|
424
358
|
|
|
425
|
-
Defined in: [packages/fate/src/client.ts:
|
|
359
|
+
Defined in: [packages/fate/src/client.ts:1153](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1153)
|
|
426
360
|
|
|
427
361
|
#### Type Parameters
|
|
428
362
|
|
|
@@ -446,7 +380,7 @@ Defined in: [packages/fate/src/client.ts:1001](https://github.com/nkzw-tech/fate
|
|
|
446
380
|
|
|
447
381
|
> **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`\>; \}\>\>
|
|
448
382
|
|
|
449
|
-
Defined in: [packages/fate/src/client.ts:
|
|
383
|
+
Defined in: [packages/fate/src/client.ts:980](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L980)
|
|
450
384
|
|
|
451
385
|
#### Type Parameters
|
|
452
386
|
|
|
@@ -482,7 +416,7 @@ Defined in: [packages/fate/src/client.ts:874](https://github.com/nkzw-tech/fate/
|
|
|
482
416
|
|
|
483
417
|
> **ref**\<`T`\>(`type`, `id`, `view`): [`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
|
|
484
418
|
|
|
485
|
-
Defined in: [packages/fate/src/client.ts:
|
|
419
|
+
Defined in: [packages/fate/src/client.ts:967](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L967)
|
|
486
420
|
|
|
487
421
|
#### Type Parameters
|
|
488
422
|
|
|
@@ -510,33 +444,11 @@ Defined in: [packages/fate/src/client.ts:861](https://github.com/nkzw-tech/fate/
|
|
|
510
444
|
|
|
511
445
|
***
|
|
512
446
|
|
|
513
|
-
### registerOptimisticUpdate()
|
|
514
|
-
|
|
515
|
-
> **registerOptimisticUpdate**(`entityId`, `select`): `number` \| `null`
|
|
516
|
-
|
|
517
|
-
Defined in: [packages/fate/src/client.ts:1738](https://github.com/nkzw-tech/fate/blob/aec05ea2ab0386693600d573021cd2a93f1d8b59/packages/fate/src/client.ts#L1738)
|
|
518
|
-
|
|
519
|
-
#### Parameters
|
|
520
|
-
|
|
521
|
-
##### entityId
|
|
522
|
-
|
|
523
|
-
`string` \| `null`
|
|
524
|
-
|
|
525
|
-
##### select
|
|
526
|
-
|
|
527
|
-
`ReadonlySet`\<`string`\>
|
|
528
|
-
|
|
529
|
-
#### Returns
|
|
530
|
-
|
|
531
|
-
`number` \| `null`
|
|
532
|
-
|
|
533
|
-
***
|
|
534
|
-
|
|
535
447
|
### registerPendingOptimisticMutation()
|
|
536
448
|
|
|
537
449
|
> **registerPendingOptimisticMutation**(`entityId`, `promise`): `void`
|
|
538
450
|
|
|
539
|
-
Defined in: [packages/fate/src/client.ts:
|
|
451
|
+
Defined in: [packages/fate/src/client.ts:1873](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1873)
|
|
540
452
|
|
|
541
453
|
#### Parameters
|
|
542
454
|
|
|
@@ -558,7 +470,7 @@ Defined in: [packages/fate/src/client.ts:1708](https://github.com/nkzw-tech/fate
|
|
|
558
470
|
|
|
559
471
|
> **releaseRequest**(`request`, `mode`): `void`
|
|
560
472
|
|
|
561
|
-
Defined in: [packages/fate/src/client.ts:
|
|
473
|
+
Defined in: [packages/fate/src/client.ts:2160](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2160)
|
|
562
474
|
|
|
563
475
|
#### Parameters
|
|
564
476
|
|
|
@@ -580,7 +492,7 @@ Defined in: [packages/fate/src/client.ts:2074](https://github.com/nkzw-tech/fate
|
|
|
580
492
|
|
|
581
493
|
> **releaseRequestKey**(`requestKey`, `mode`): `void`
|
|
582
494
|
|
|
583
|
-
Defined in: [packages/fate/src/client.ts:
|
|
495
|
+
Defined in: [packages/fate/src/client.ts:2164](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2164)
|
|
584
496
|
|
|
585
497
|
#### Parameters
|
|
586
498
|
|
|
@@ -602,7 +514,7 @@ Defined in: [packages/fate/src/client.ts:2078](https://github.com/nkzw-tech/fate
|
|
|
602
514
|
|
|
603
515
|
> **request**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
|
|
604
516
|
|
|
605
|
-
Defined in: [packages/fate/src/client.ts:
|
|
517
|
+
Defined in: [packages/fate/src/client.ts:2061](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2061)
|
|
606
518
|
|
|
607
519
|
#### Type Parameters
|
|
608
520
|
|
|
@@ -618,7 +530,7 @@ Defined in: [packages/fate/src/client.ts:2000](https://github.com/nkzw-tech/fate
|
|
|
618
530
|
|
|
619
531
|
##### options?
|
|
620
532
|
|
|
621
|
-
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); \}\>
|
|
533
|
+
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`: \{ `maxAge`: `number`; \}; \}\>
|
|
622
534
|
|
|
623
535
|
#### Returns
|
|
624
536
|
|
|
@@ -630,7 +542,7 @@ Defined in: [packages/fate/src/client.ts:2000](https://github.com/nkzw-tech/fate
|
|
|
630
542
|
|
|
631
543
|
> **requestForRender**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
|
|
632
544
|
|
|
633
|
-
Defined in: [packages/fate/src/client.ts:
|
|
545
|
+
Defined in: [packages/fate/src/client.ts:2076](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2076)
|
|
634
546
|
|
|
635
547
|
#### Type Parameters
|
|
636
548
|
|
|
@@ -646,7 +558,7 @@ Defined in: [packages/fate/src/client.ts:2010](https://github.com/nkzw-tech/fate
|
|
|
646
558
|
|
|
647
559
|
##### options?
|
|
648
560
|
|
|
649
|
-
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); \}\>
|
|
561
|
+
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`: \{ `maxAge`: `number`; \}; \}\>
|
|
650
562
|
|
|
651
563
|
#### Returns
|
|
652
564
|
|
|
@@ -658,7 +570,7 @@ Defined in: [packages/fate/src/client.ts:2010](https://github.com/nkzw-tech/fate
|
|
|
658
570
|
|
|
659
571
|
> **resolveOptimisticEntity**(`optimisticEntityId`, `resolvedEntityId`): `void`
|
|
660
572
|
|
|
661
|
-
Defined in: [packages/fate/src/client.ts:
|
|
573
|
+
Defined in: [packages/fate/src/client.ts:1898](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1898)
|
|
662
574
|
|
|
663
575
|
#### Parameters
|
|
664
576
|
|
|
@@ -676,55 +588,11 @@ Defined in: [packages/fate/src/client.ts:1733](https://github.com/nkzw-tech/fate
|
|
|
676
588
|
|
|
677
589
|
***
|
|
678
590
|
|
|
679
|
-
### restore()
|
|
680
|
-
|
|
681
|
-
> **restore**(`id`, `snapshot`): `void`
|
|
682
|
-
|
|
683
|
-
Defined in: [packages/fate/src/client.ts:829](https://github.com/nkzw-tech/fate/blob/aec05ea2ab0386693600d573021cd2a93f1d8b59/packages/fate/src/client.ts#L829)
|
|
684
|
-
|
|
685
|
-
#### Parameters
|
|
686
|
-
|
|
687
|
-
##### id
|
|
688
|
-
|
|
689
|
-
`string`
|
|
690
|
-
|
|
691
|
-
##### snapshot
|
|
692
|
-
|
|
693
|
-
[`Snapshot`](../type-aliases/Snapshot.md)
|
|
694
|
-
|
|
695
|
-
#### Returns
|
|
696
|
-
|
|
697
|
-
`void`
|
|
698
|
-
|
|
699
|
-
***
|
|
700
|
-
|
|
701
|
-
### restoreList()
|
|
702
|
-
|
|
703
|
-
> **restoreList**(`name`, `list?`): `void`
|
|
704
|
-
|
|
705
|
-
Defined in: [packages/fate/src/client.ts:834](https://github.com/nkzw-tech/fate/blob/aec05ea2ab0386693600d573021cd2a93f1d8b59/packages/fate/src/client.ts#L834)
|
|
706
|
-
|
|
707
|
-
#### Parameters
|
|
708
|
-
|
|
709
|
-
##### name
|
|
710
|
-
|
|
711
|
-
`string`
|
|
712
|
-
|
|
713
|
-
##### list?
|
|
714
|
-
|
|
715
|
-
`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`[]; \}\>
|
|
716
|
-
|
|
717
|
-
#### Returns
|
|
718
|
-
|
|
719
|
-
`void`
|
|
720
|
-
|
|
721
|
-
***
|
|
722
|
-
|
|
723
591
|
### retain()
|
|
724
592
|
|
|
725
593
|
> **retain**(`request`): `RetainHandle`
|
|
726
594
|
|
|
727
|
-
Defined in: [packages/fate/src/client.ts:
|
|
595
|
+
Defined in: [packages/fate/src/client.ts:2195](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2195)
|
|
728
596
|
|
|
729
597
|
Keeps the records and lists reachable from a request alive until the
|
|
730
598
|
returned handle is disposed.
|
|
@@ -749,7 +617,7 @@ that must survive manual garbage collection.
|
|
|
749
617
|
|
|
750
618
|
> **retainRequestKey**(`requestKey`, `mode?`): `RetainHandle`
|
|
751
619
|
|
|
752
|
-
Defined in: [packages/fate/src/client.ts:
|
|
620
|
+
Defined in: [packages/fate/src/client.ts:2176](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2176)
|
|
753
621
|
|
|
754
622
|
#### Parameters
|
|
755
623
|
|
|
@@ -771,7 +639,7 @@ Defined in: [packages/fate/src/client.ts:2090](https://github.com/nkzw-tech/fate
|
|
|
771
639
|
|
|
772
640
|
> **rootListRef**(`entityId`, `rootView`): `Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
|
|
773
641
|
|
|
774
|
-
Defined in: [packages/fate/src/client.ts:
|
|
642
|
+
Defined in: [packages/fate/src/client.ts:975](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L975)
|
|
775
643
|
|
|
776
644
|
#### Parameters
|
|
777
645
|
|
|
@@ -793,7 +661,7 @@ Defined in: [packages/fate/src/client.ts:869](https://github.com/nkzw-tech/fate/
|
|
|
793
661
|
|
|
794
662
|
> **subscribeLiveListView**\<`V`\>(`view`, `connection`): () => `void`
|
|
795
663
|
|
|
796
|
-
Defined in: [packages/fate/src/client.ts:
|
|
664
|
+
Defined in: [packages/fate/src/client.ts:1351](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1351)
|
|
797
665
|
|
|
798
666
|
#### Type Parameters
|
|
799
667
|
|
|
@@ -821,7 +689,7 @@ Defined in: [packages/fate/src/client.ts:1198](https://github.com/nkzw-tech/fate
|
|
|
821
689
|
|
|
822
690
|
> **subscribeLiveView**\<`T`, `S`, `V`\>(`view`, `ref`): () => `void`
|
|
823
691
|
|
|
824
|
-
Defined in: [packages/fate/src/client.ts:
|
|
692
|
+
Defined in: [packages/fate/src/client.ts:1266](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L1266)
|
|
825
693
|
|
|
826
694
|
#### Type Parameters
|
|
827
695
|
|
|
@@ -857,7 +725,7 @@ Defined in: [packages/fate/src/client.ts:1114](https://github.com/nkzw-tech/fate
|
|
|
857
725
|
|
|
858
726
|
> **trackPendingRequest**\<`T`\>(`request`): `Promise`\<`T`\>
|
|
859
727
|
|
|
860
|
-
Defined in: [packages/fate/src/client.ts:
|
|
728
|
+
Defined in: [packages/fate/src/client.ts:2454](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L2454)
|
|
861
729
|
|
|
862
730
|
#### Type Parameters
|
|
863
731
|
|
|
@@ -879,9 +747,9 @@ Defined in: [packages/fate/src/client.ts:2323](https://github.com/nkzw-tech/fate
|
|
|
879
747
|
|
|
880
748
|
### write()
|
|
881
749
|
|
|
882
|
-
> **write**(`type`, `data`, `select`, `
|
|
750
|
+
> **write**(`type`, `data`, `select`, `plan?`, `insert?`): `string`
|
|
883
751
|
|
|
884
|
-
Defined in: [packages/fate/src/client.ts:
|
|
752
|
+
Defined in: [packages/fate/src/client.ts:923](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L923)
|
|
885
753
|
|
|
886
754
|
#### Parameters
|
|
887
755
|
|
|
@@ -897,30 +765,14 @@ Defined in: [packages/fate/src/client.ts:787](https://github.com/nkzw-tech/fate/
|
|
|
897
765
|
|
|
898
766
|
`ReadonlySet`\<`string`\>
|
|
899
767
|
|
|
900
|
-
##### snapshots?
|
|
901
|
-
|
|
902
|
-
`Map`\<`string`, `Readonly`\<\{ `mask?`: `FieldMask`; `record?`: [`FateRecord`](../type-aliases/FateRecord.md); \}\>\>
|
|
903
|
-
|
|
904
768
|
##### plan?
|
|
905
769
|
|
|
906
770
|
`SelectionPlan`
|
|
907
771
|
|
|
908
|
-
##### pathPrefix?
|
|
909
|
-
|
|
910
|
-
`string` \| `null`
|
|
911
|
-
|
|
912
|
-
##### blockedMask?
|
|
913
|
-
|
|
914
|
-
`FieldMask` \| `null`
|
|
915
|
-
|
|
916
772
|
##### insert?
|
|
917
773
|
|
|
918
774
|
`InsertPosition`
|
|
919
775
|
|
|
920
|
-
##### listSnapshots?
|
|
921
|
-
|
|
922
|
-
`Map`\<`string`, `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`[]; \}\>\>
|
|
923
|
-
|
|
924
776
|
#### Returns
|
|
925
777
|
|
|
926
778
|
`string`
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **clientRoot**\<`Result`, `Type`\>(`type`): `RootDefinition`\<`Type`, `Result`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/root.ts:7](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/root.ts#L7)
|
|
6
6
|
|
|
7
7
|
Defines a root query for an entity type, capturing the response shape.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createClient**\<`T`, `HydrationScope`\>(`options`): [`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\], `HydrationScope`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/client.ts:
|
|
5
|
+
Defined in: [packages/fate/src/client.ts:3501](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/client.ts#L3501)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createGraphQLTransport**\<`Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/graphqlTransport.ts:
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:579](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/graphqlTransport.ts#L579)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createHTTPTransport**\<`API`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`Mutations`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/httpTransport.ts:265](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/httpTransport.ts#L265)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createTRPCTransport**\<`AppRouter`, `Mutations`\>(`__namedParameters`): [`Transport`](../interfaces/Transport.md)\<`MutationMapFromResolvers`\<`Mutations`\>\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/transport.ts:
|
|
5
|
+
Defined in: [packages/fate/src/transport.ts:160](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/transport.ts#L160)
|
|
6
6
|
|
|
7
7
|
Builds a `Transport` backed by a tRPC client using the configured resolvers
|
|
8
8
|
for by-id queries, lists, and mutations.
|
|
@@ -33,6 +33,10 @@ for by-id queries, lists, and mutations.
|
|
|
33
33
|
|
|
34
34
|
`TRPCListResolvers`\<`AppRouter`\>
|
|
35
35
|
|
|
36
|
+
#### mutateDurably?
|
|
37
|
+
|
|
38
|
+
\<`K`\>(`proc`, `input`, `select`, `identity`) => `Promise`\<`MutationMapFromResolvers`\<`Mutations`\>\[`K`\]\[`"output"`\]\>
|
|
39
|
+
|
|
36
40
|
#### mutations?
|
|
37
41
|
|
|
38
42
|
`Mutations`
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **defer**\<`S`\>(`selection`): [`DeferredSelection`](../type-aliases/DeferredSelection.md)\<`S`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/defer.ts:9](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/defer.ts:9](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/defer.ts#L9)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **getDeferredMetadata**\<`T`\>(`deferred`): [`DeferredMetadata`](../type-aliases/DeferredMetadata.md)
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/defer.ts:28](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/defer.ts:28](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/defer.ts#L28)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **getListEntries**(`listState`): `Readonly`\<\{ `cursor?`: `string`; `id`: `string`; \}\>[]
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/list.ts:6](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/list.ts#L6)
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **getSelectionPlan**\<`T`, `S`, `V`\>(`viewComposition`, `ref`): `SelectionPlan`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/selection.ts:38](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/selection.ts:38](https://github.com/nkzw-tech/fate/blob/0dec4f3068f60a4fbf85796c9934f6112afe09a2/packages/fate/src/selection.ts#L38)
|
|
6
6
|
|
|
7
7
|
Flattens a view into a `SelectionPlan`, expanding composed views and
|
|
8
8
|
partitioning nested args so the client can fetch exactly what is declared.
|