@nkzw/fate 1.0.1 → 1.0.2
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/docs/api/classes/FateClient.md +36 -36
- package/docs/api/functions/clientRoot.md +1 -1
- package/docs/api/functions/createClient.md +1 -1
- package/docs/api/functions/createHTTPTransport.md +1 -1
- package/docs/api/functions/createTRPCTransport.md +1 -1
- package/docs/api/functions/getListEntries.md +1 -1
- package/docs/api/functions/getSelectionPlan.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/interfaces/FateThenable.md +3 -3
- package/docs/api/interfaces/Transport.md +7 -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/Entity.md +2 -2
- package/docs/api/type-aliases/EntityId.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 +1 -1
- 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/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/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/Request.md +1 -1
- package/docs/api/type-aliases/RequestMode.md +1 -1
- package/docs/api/type-aliases/RequestOptions.md +1 -1
- package/docs/api/type-aliases/RequestResult.md +1 -1
- package/docs/api/type-aliases/Selection.md +1 -1
- package/docs/api/type-aliases/Snapshot.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/lib/server/drizzle.mjs +68 -1
- package/package.json +1 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Class: FateClient\<Roots, Mutations\>
|
|
2
2
|
|
|
3
|
-
Defined in: [packages/fate/src/client.ts:361](https://github.com/nkzw-tech/fate/blob/
|
|
3
|
+
Defined in: [packages/fate/src/client.ts:361](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L361)
|
|
4
4
|
|
|
5
5
|
Core client that normalizes records, manages the view cache, and coordinates
|
|
6
6
|
data fetching.
|
|
@@ -21,7 +21,7 @@ data fetching.
|
|
|
21
21
|
|
|
22
22
|
> **new FateClient**\<`Roots`, `Mutations`\>(`options`): `FateClient`\<`Roots`, `Mutations`\>
|
|
23
23
|
|
|
24
|
-
Defined in: [packages/fate/src/client.ts:400](https://github.com/nkzw-tech/fate/blob/
|
|
24
|
+
Defined in: [packages/fate/src/client.ts:400](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L400)
|
|
25
25
|
|
|
26
26
|
#### Parameters
|
|
27
27
|
|
|
@@ -39,7 +39,7 @@ Defined in: [packages/fate/src/client.ts:400](https://github.com/nkzw-tech/fate/
|
|
|
39
39
|
|
|
40
40
|
> `readonly` **actions**: `MutationTreeFromRecord`\<`Mutations`\>
|
|
41
41
|
|
|
42
|
-
Defined in: [packages/fate/src/client.ts:396](https://github.com/nkzw-tech/fate/blob/
|
|
42
|
+
Defined in: [packages/fate/src/client.ts:396](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L396)
|
|
43
43
|
|
|
44
44
|
***
|
|
45
45
|
|
|
@@ -47,7 +47,7 @@ Defined in: [packages/fate/src/client.ts:396](https://github.com/nkzw-tech/fate/
|
|
|
47
47
|
|
|
48
48
|
> `readonly` **mutations**: `MutationTreeFromRecord`\<`Mutations`\>
|
|
49
49
|
|
|
50
|
-
Defined in: [packages/fate/src/client.ts:397](https://github.com/nkzw-tech/fate/blob/
|
|
50
|
+
Defined in: [packages/fate/src/client.ts:397](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L397)
|
|
51
51
|
|
|
52
52
|
***
|
|
53
53
|
|
|
@@ -55,7 +55,7 @@ Defined in: [packages/fate/src/client.ts:397](https://github.com/nkzw-tech/fate/
|
|
|
55
55
|
|
|
56
56
|
> `readonly` **roots**: `Roots`
|
|
57
57
|
|
|
58
|
-
Defined in: [packages/fate/src/client.ts:398](https://github.com/nkzw-tech/fate/blob/
|
|
58
|
+
Defined in: [packages/fate/src/client.ts:398](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L398)
|
|
59
59
|
|
|
60
60
|
***
|
|
61
61
|
|
|
@@ -63,7 +63,7 @@ Defined in: [packages/fate/src/client.ts:398](https://github.com/nkzw-tech/fate/
|
|
|
63
63
|
|
|
64
64
|
> `readonly` **store**: `Store`
|
|
65
65
|
|
|
66
|
-
Defined in: [packages/fate/src/client.ts:389](https://github.com/nkzw-tech/fate/blob/
|
|
66
|
+
Defined in: [packages/fate/src/client.ts:389](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L389)
|
|
67
67
|
|
|
68
68
|
## Methods
|
|
69
69
|
|
|
@@ -71,7 +71,7 @@ Defined in: [packages/fate/src/client.ts:389](https://github.com/nkzw-tech/fate/
|
|
|
71
71
|
|
|
72
72
|
> **assertLiveConnectionSupport**(): `void`
|
|
73
73
|
|
|
74
|
-
Defined in: [packages/fate/src/client.ts:845](https://github.com/nkzw-tech/fate/blob/
|
|
74
|
+
Defined in: [packages/fate/src/client.ts:845](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L845)
|
|
75
75
|
|
|
76
76
|
#### Returns
|
|
77
77
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/fate/src/client.ts:845](https://github.com/nkzw-tech/fate/
|
|
|
83
83
|
|
|
84
84
|
> **assertLiveViewSupport**(): `void`
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/fate/src/client.ts:837](https://github.com/nkzw-tech/fate/blob/
|
|
86
|
+
Defined in: [packages/fate/src/client.ts:837](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L837)
|
|
87
87
|
|
|
88
88
|
#### Returns
|
|
89
89
|
|
|
@@ -95,7 +95,7 @@ Defined in: [packages/fate/src/client.ts:837](https://github.com/nkzw-tech/fate/
|
|
|
95
95
|
|
|
96
96
|
> **clearOptimisticUpdate**(`token`): `void`
|
|
97
97
|
|
|
98
|
-
Defined in: [packages/fate/src/client.ts:1496](https://github.com/nkzw-tech/fate/blob/
|
|
98
|
+
Defined in: [packages/fate/src/client.ts:1496](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1496)
|
|
99
99
|
|
|
100
100
|
#### Parameters
|
|
101
101
|
|
|
@@ -113,7 +113,7 @@ Defined in: [packages/fate/src/client.ts:1496](https://github.com/nkzw-tech/fate
|
|
|
113
113
|
|
|
114
114
|
> **deleteRecord**(`type`, `id`, `snapshots?`, `listSnapshots?`): `void`
|
|
115
115
|
|
|
116
|
-
Defined in: [packages/fate/src/client.ts:650](https://github.com/nkzw-tech/fate/blob/
|
|
116
|
+
Defined in: [packages/fate/src/client.ts:650](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L650)
|
|
117
117
|
|
|
118
118
|
#### Parameters
|
|
119
119
|
|
|
@@ -143,7 +143,7 @@ Defined in: [packages/fate/src/client.ts:650](https://github.com/nkzw-tech/fate/
|
|
|
143
143
|
|
|
144
144
|
> **executeMutation**(`key`, `input`, `select`, `options?`): `Promise`\<`unknown`\>
|
|
145
145
|
|
|
146
|
-
Defined in: [packages/fate/src/client.ts:594](https://github.com/nkzw-tech/fate/blob/
|
|
146
|
+
Defined in: [packages/fate/src/client.ts:594](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L594)
|
|
147
147
|
|
|
148
148
|
#### Parameters
|
|
149
149
|
|
|
@@ -179,7 +179,7 @@ Defined in: [packages/fate/src/client.ts:594](https://github.com/nkzw-tech/fate/
|
|
|
179
179
|
|
|
180
180
|
> **filterSelectionForPendingOptimistics**(`entityId`, `select`, `options?`): `Set`\<`string`\>
|
|
181
181
|
|
|
182
|
-
Defined in: [packages/fate/src/client.ts:1559](https://github.com/nkzw-tech/fate/blob/
|
|
182
|
+
Defined in: [packages/fate/src/client.ts:1559](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1559)
|
|
183
183
|
|
|
184
184
|
#### Parameters
|
|
185
185
|
|
|
@@ -207,7 +207,7 @@ Defined in: [packages/fate/src/client.ts:1559](https://github.com/nkzw-tech/fate
|
|
|
207
207
|
|
|
208
208
|
> **gc**(): `void`
|
|
209
209
|
|
|
210
|
-
Defined in: [packages/fate/src/client.ts:1871](https://github.com/nkzw-tech/fate/blob/
|
|
210
|
+
Defined in: [packages/fate/src/client.ts:1871](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1871)
|
|
211
211
|
|
|
212
212
|
Removes records and lists that are not reachable from retained requests or
|
|
213
213
|
the release buffer.
|
|
@@ -226,7 +226,7 @@ memory-management flows.
|
|
|
226
226
|
|
|
227
227
|
> **getPendingOptimisticMask**(`entityId`, `options?`): `FieldMask` \| `null`
|
|
228
228
|
|
|
229
|
-
Defined in: [packages/fate/src/client.ts:1518](https://github.com/nkzw-tech/fate/blob/
|
|
229
|
+
Defined in: [packages/fate/src/client.ts:1518](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1518)
|
|
230
230
|
|
|
231
231
|
#### Parameters
|
|
232
232
|
|
|
@@ -250,7 +250,7 @@ Defined in: [packages/fate/src/client.ts:1518](https://github.com/nkzw-tech/fate
|
|
|
250
250
|
|
|
251
251
|
> **getRequestKey**(`request`): `string`
|
|
252
252
|
|
|
253
|
-
Defined in: [packages/fate/src/client.ts:2089](https://github.com/nkzw-tech/fate/blob/
|
|
253
|
+
Defined in: [packages/fate/src/client.ts:2089](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L2089)
|
|
254
254
|
|
|
255
255
|
#### Parameters
|
|
256
256
|
|
|
@@ -268,7 +268,7 @@ Defined in: [packages/fate/src/client.ts:2089](https://github.com/nkzw-tech/fate
|
|
|
268
268
|
|
|
269
269
|
> **getRequestResult**\<`R`\>(`request`): [`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
|
|
270
270
|
|
|
271
|
-
Defined in: [packages/fate/src/client.ts:2229](https://github.com/nkzw-tech/fate/blob/
|
|
271
|
+
Defined in: [packages/fate/src/client.ts:2229](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L2229)
|
|
272
272
|
|
|
273
273
|
#### Type Parameters
|
|
274
274
|
|
|
@@ -292,7 +292,7 @@ Defined in: [packages/fate/src/client.ts:2229](https://github.com/nkzw-tech/fate
|
|
|
292
292
|
|
|
293
293
|
> **getTypeConfig**(`type`): [`TypeConfig`](../type-aliases/TypeConfig.md)
|
|
294
294
|
|
|
295
|
-
Defined in: [packages/fate/src/client.ts:586](https://github.com/nkzw-tech/fate/blob/
|
|
295
|
+
Defined in: [packages/fate/src/client.ts:586](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L586)
|
|
296
296
|
|
|
297
297
|
#### Parameters
|
|
298
298
|
|
|
@@ -310,7 +310,7 @@ Defined in: [packages/fate/src/client.ts:586](https://github.com/nkzw-tech/fate/
|
|
|
310
310
|
|
|
311
311
|
> **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`\>
|
|
312
312
|
|
|
313
|
-
Defined in: [packages/fate/src/client.ts:1583](https://github.com/nkzw-tech/fate/blob/
|
|
313
|
+
Defined in: [packages/fate/src/client.ts:1583](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1583)
|
|
314
314
|
|
|
315
315
|
#### Type Parameters
|
|
316
316
|
|
|
@@ -348,7 +348,7 @@ Defined in: [packages/fate/src/client.ts:1583](https://github.com/nkzw-tech/fate
|
|
|
348
348
|
|
|
349
349
|
> **prepareRequestForRender**\<`R`\>(`request`, `options`): `Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
|
|
350
350
|
|
|
351
|
-
Defined in: [packages/fate/src/client.ts:1753](https://github.com/nkzw-tech/fate/blob/
|
|
351
|
+
Defined in: [packages/fate/src/client.ts:1753](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1753)
|
|
352
352
|
|
|
353
353
|
#### Type Parameters
|
|
354
354
|
|
|
@@ -376,7 +376,7 @@ Defined in: [packages/fate/src/client.ts:1753](https://github.com/nkzw-tech/fate
|
|
|
376
376
|
|
|
377
377
|
> **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`\>; \}\>\>
|
|
378
378
|
|
|
379
|
-
Defined in: [packages/fate/src/client.ts:713](https://github.com/nkzw-tech/fate/blob/
|
|
379
|
+
Defined in: [packages/fate/src/client.ts:713](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L713)
|
|
380
380
|
|
|
381
381
|
#### Type Parameters
|
|
382
382
|
|
|
@@ -412,7 +412,7 @@ Defined in: [packages/fate/src/client.ts:713](https://github.com/nkzw-tech/fate/
|
|
|
412
412
|
|
|
413
413
|
> **ref**\<`T`\>(`type`, `id`, `view`): [`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
|
|
414
414
|
|
|
415
|
-
Defined in: [packages/fate/src/client.ts:700](https://github.com/nkzw-tech/fate/blob/
|
|
415
|
+
Defined in: [packages/fate/src/client.ts:700](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L700)
|
|
416
416
|
|
|
417
417
|
#### Type Parameters
|
|
418
418
|
|
|
@@ -444,7 +444,7 @@ Defined in: [packages/fate/src/client.ts:700](https://github.com/nkzw-tech/fate/
|
|
|
444
444
|
|
|
445
445
|
> **registerOptimisticUpdate**(`entityId`, `select`): `number` \| `null`
|
|
446
446
|
|
|
447
|
-
Defined in: [packages/fate/src/client.ts:1477](https://github.com/nkzw-tech/fate/blob/
|
|
447
|
+
Defined in: [packages/fate/src/client.ts:1477](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1477)
|
|
448
448
|
|
|
449
449
|
#### Parameters
|
|
450
450
|
|
|
@@ -466,7 +466,7 @@ Defined in: [packages/fate/src/client.ts:1477](https://github.com/nkzw-tech/fate
|
|
|
466
466
|
|
|
467
467
|
> **registerPendingOptimisticMutation**(`entityId`, `promise`): `void`
|
|
468
468
|
|
|
469
|
-
Defined in: [packages/fate/src/client.ts:1447](https://github.com/nkzw-tech/fate/blob/
|
|
469
|
+
Defined in: [packages/fate/src/client.ts:1447](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1447)
|
|
470
470
|
|
|
471
471
|
#### Parameters
|
|
472
472
|
|
|
@@ -488,7 +488,7 @@ Defined in: [packages/fate/src/client.ts:1447](https://github.com/nkzw-tech/fate
|
|
|
488
488
|
|
|
489
489
|
> **releaseRequest**(`request`, `mode`): `void`
|
|
490
490
|
|
|
491
|
-
Defined in: [packages/fate/src/client.ts:1810](https://github.com/nkzw-tech/fate/blob/
|
|
491
|
+
Defined in: [packages/fate/src/client.ts:1810](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1810)
|
|
492
492
|
|
|
493
493
|
#### Parameters
|
|
494
494
|
|
|
@@ -510,7 +510,7 @@ Defined in: [packages/fate/src/client.ts:1810](https://github.com/nkzw-tech/fate
|
|
|
510
510
|
|
|
511
511
|
> **releaseRequestKey**(`requestKey`, `mode`): `void`
|
|
512
512
|
|
|
513
|
-
Defined in: [packages/fate/src/client.ts:1814](https://github.com/nkzw-tech/fate/blob/
|
|
513
|
+
Defined in: [packages/fate/src/client.ts:1814](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1814)
|
|
514
514
|
|
|
515
515
|
#### Parameters
|
|
516
516
|
|
|
@@ -532,7 +532,7 @@ Defined in: [packages/fate/src/client.ts:1814](https://github.com/nkzw-tech/fate
|
|
|
532
532
|
|
|
533
533
|
> **request**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
|
|
534
534
|
|
|
535
|
-
Defined in: [packages/fate/src/client.ts:1736](https://github.com/nkzw-tech/fate/blob/
|
|
535
|
+
Defined in: [packages/fate/src/client.ts:1736](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1736)
|
|
536
536
|
|
|
537
537
|
#### Type Parameters
|
|
538
538
|
|
|
@@ -560,7 +560,7 @@ Defined in: [packages/fate/src/client.ts:1736](https://github.com/nkzw-tech/fate
|
|
|
560
560
|
|
|
561
561
|
> **requestForRender**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
|
|
562
562
|
|
|
563
|
-
Defined in: [packages/fate/src/client.ts:1746](https://github.com/nkzw-tech/fate/blob/
|
|
563
|
+
Defined in: [packages/fate/src/client.ts:1746](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1746)
|
|
564
564
|
|
|
565
565
|
#### Type Parameters
|
|
566
566
|
|
|
@@ -588,7 +588,7 @@ Defined in: [packages/fate/src/client.ts:1746](https://github.com/nkzw-tech/fate
|
|
|
588
588
|
|
|
589
589
|
> **resolveOptimisticEntity**(`optimisticEntityId`, `resolvedEntityId`): `void`
|
|
590
590
|
|
|
591
|
-
Defined in: [packages/fate/src/client.ts:1472](https://github.com/nkzw-tech/fate/blob/
|
|
591
|
+
Defined in: [packages/fate/src/client.ts:1472](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1472)
|
|
592
592
|
|
|
593
593
|
#### Parameters
|
|
594
594
|
|
|
@@ -610,7 +610,7 @@ Defined in: [packages/fate/src/client.ts:1472](https://github.com/nkzw-tech/fate
|
|
|
610
610
|
|
|
611
611
|
> **restore**(`id`, `snapshot`): `void`
|
|
612
612
|
|
|
613
|
-
Defined in: [packages/fate/src/client.ts:668](https://github.com/nkzw-tech/fate/blob/
|
|
613
|
+
Defined in: [packages/fate/src/client.ts:668](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L668)
|
|
614
614
|
|
|
615
615
|
#### Parameters
|
|
616
616
|
|
|
@@ -632,7 +632,7 @@ Defined in: [packages/fate/src/client.ts:668](https://github.com/nkzw-tech/fate/
|
|
|
632
632
|
|
|
633
633
|
> **restoreList**(`name`, `list?`): `void`
|
|
634
634
|
|
|
635
|
-
Defined in: [packages/fate/src/client.ts:673](https://github.com/nkzw-tech/fate/blob/
|
|
635
|
+
Defined in: [packages/fate/src/client.ts:673](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L673)
|
|
636
636
|
|
|
637
637
|
#### Parameters
|
|
638
638
|
|
|
@@ -654,7 +654,7 @@ Defined in: [packages/fate/src/client.ts:673](https://github.com/nkzw-tech/fate/
|
|
|
654
654
|
|
|
655
655
|
> **retain**(`request`): `RetainHandle`
|
|
656
656
|
|
|
657
|
-
Defined in: [packages/fate/src/client.ts:1845](https://github.com/nkzw-tech/fate/blob/
|
|
657
|
+
Defined in: [packages/fate/src/client.ts:1845](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1845)
|
|
658
658
|
|
|
659
659
|
Keeps the records and lists reachable from a request alive until the
|
|
660
660
|
returned handle is disposed.
|
|
@@ -679,7 +679,7 @@ that must survive manual garbage collection.
|
|
|
679
679
|
|
|
680
680
|
> **retainRequestKey**(`requestKey`, `mode?`): `RetainHandle`
|
|
681
681
|
|
|
682
|
-
Defined in: [packages/fate/src/client.ts:1826](https://github.com/nkzw-tech/fate/blob/
|
|
682
|
+
Defined in: [packages/fate/src/client.ts:1826](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L1826)
|
|
683
683
|
|
|
684
684
|
#### Parameters
|
|
685
685
|
|
|
@@ -701,7 +701,7 @@ Defined in: [packages/fate/src/client.ts:1826](https://github.com/nkzw-tech/fate
|
|
|
701
701
|
|
|
702
702
|
> **rootListRef**(`entityId`, `rootView`): `Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
|
|
703
703
|
|
|
704
|
-
Defined in: [packages/fate/src/client.ts:708](https://github.com/nkzw-tech/fate/blob/
|
|
704
|
+
Defined in: [packages/fate/src/client.ts:708](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L708)
|
|
705
705
|
|
|
706
706
|
#### Parameters
|
|
707
707
|
|
|
@@ -723,7 +723,7 @@ Defined in: [packages/fate/src/client.ts:708](https://github.com/nkzw-tech/fate/
|
|
|
723
723
|
|
|
724
724
|
> **subscribeLiveListView**\<`V`\>(`view`, `connection`): () => `void`
|
|
725
725
|
|
|
726
|
-
Defined in: [packages/fate/src/client.ts:937](https://github.com/nkzw-tech/fate/blob/
|
|
726
|
+
Defined in: [packages/fate/src/client.ts:937](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L937)
|
|
727
727
|
|
|
728
728
|
#### Type Parameters
|
|
729
729
|
|
|
@@ -751,7 +751,7 @@ Defined in: [packages/fate/src/client.ts:937](https://github.com/nkzw-tech/fate/
|
|
|
751
751
|
|
|
752
752
|
> **subscribeLiveView**\<`T`, `S`, `V`\>(`view`, `ref`): () => `void`
|
|
753
753
|
|
|
754
|
-
Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/blob/
|
|
754
|
+
Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L853)
|
|
755
755
|
|
|
756
756
|
#### Type Parameters
|
|
757
757
|
|
|
@@ -787,7 +787,7 @@ Defined in: [packages/fate/src/client.ts:853](https://github.com/nkzw-tech/fate/
|
|
|
787
787
|
|
|
788
788
|
> **write**(`type`, `data`, `select`, `snapshots?`, `plan?`, `pathPrefix?`, `blockedMask?`, `insert?`, `listSnapshots?`): `string`
|
|
789
789
|
|
|
790
|
-
Defined in: [packages/fate/src/client.ts:626](https://github.com/nkzw-tech/fate/blob/
|
|
790
|
+
Defined in: [packages/fate/src/client.ts:626](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L626)
|
|
791
791
|
|
|
792
792
|
#### Parameters
|
|
793
793
|
|
|
@@ -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/2b217058fdff50f3598b704f486529cd23a8dbb6/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`\>(`options`): [`FateClient`](../classes/FateClient.md)\<`T`\[`0`\], `T`\[`1`\]\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/client.ts:3009](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/client.ts:3009](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/client.ts#L3009)
|
|
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/2b217058fdff50f3598b704f486529cd23a8dbb6/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:149](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/transport.ts:149](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L149)
|
|
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.
|
|
@@ -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/2b217058fdff50f3598b704f486529cd23a8dbb6/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:37](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/selection.ts:37](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/selection.ts#L37)
|
|
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.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **isRecord**(`value`): `value is FateRecord`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/record.ts:3](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/record.ts:3](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/record.ts#L3)
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **isViewTag**(`key`): `` key is `__fate-view__${string}` ``
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/types.ts:59](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:59](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/types.ts#L59)
|
|
6
6
|
|
|
7
7
|
Determines whether a property key is a fate view tag.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **liveConnectionTopic**(`procedure`, `args?`): `string`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/liveTopics.ts:20](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/liveTopics.ts:20](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/liveTopics.ts#L20)
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **liveEntityTopic**(`type`, `id`): `string`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/liveTopics.ts:17](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/liveTopics.ts:17](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/liveTopics.ts#L17)
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **liveGlobalConnectionTopic**(`procedure`): `string`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/liveTopics.ts:25](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/liveTopics.ts:25](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/liveTopics.ts#L25)
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **mutation**\<`T`, `I`, `R`\>(`entity`): [`MutationDefinition`](../type-aliases/MutationDefinition.md)\<`T`, `I`, `R`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/mutation.ts:28](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/mutation.ts:28](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/mutation.ts#L28)
|
|
6
6
|
|
|
7
7
|
Defines a mutation for a given entity type, preserving the input and output
|
|
8
8
|
types for transports.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **toEntityId**(`type`, `rawId`): `string`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/ref.ts:16](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/ref.ts:16](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/ref.ts#L16)
|
|
6
6
|
|
|
7
7
|
Builds the canonical cache ID for an entity.
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **view**\<`T`\>(): \<`S`\>(`select`) => [`View`](../type-aliases/View.md)\<`T`, `S`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/view.ts:111](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/view.ts:111](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/view.ts#L111)
|
|
6
6
|
|
|
7
7
|
Creates a reusable view for an object using the declared selection.
|
|
8
8
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Interface: FateThenable\<T\>
|
|
2
2
|
|
|
3
|
-
Defined in: [packages/fate/src/types.ts:484](https://github.com/nkzw-tech/fate/blob/
|
|
3
|
+
Defined in: [packages/fate/src/types.ts:484](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/types.ts#L484)
|
|
4
4
|
|
|
5
5
|
Promise-like value returned by cache reads that already have a resolved payload for React `use`.
|
|
6
6
|
|
|
@@ -20,7 +20,7 @@ Promise-like value returned by cache reads that already have a resolved payload
|
|
|
20
20
|
|
|
21
21
|
> **status**: `"fulfilled"`
|
|
22
22
|
|
|
23
|
-
Defined in: [packages/fate/src/types.ts:485](https://github.com/nkzw-tech/fate/blob/
|
|
23
|
+
Defined in: [packages/fate/src/types.ts:485](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/types.ts#L485)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,4 +28,4 @@ Defined in: [packages/fate/src/types.ts:485](https://github.com/nkzw-tech/fate/b
|
|
|
28
28
|
|
|
29
29
|
> **value**: `T`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/fate/src/types.ts:486](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [packages/fate/src/types.ts:486](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/types.ts#L486)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Interface: Transport\<Mutations\>
|
|
2
2
|
|
|
3
|
-
Defined in: [packages/fate/src/transport.ts:52](https://github.com/nkzw-tech/fate/blob/
|
|
3
|
+
Defined in: [packages/fate/src/transport.ts:52](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L52)
|
|
4
4
|
|
|
5
5
|
Contract the fate client expects from a network transport. The transport is
|
|
6
6
|
responsible for fetching records by ID, fetching lists, and executing
|
|
@@ -18,7 +18,7 @@ mutations with the provided selections.
|
|
|
18
18
|
|
|
19
19
|
> **fetchById**(`type`, `ids`, `select`, `args?`): `Promise`\<`unknown`[]\>
|
|
20
20
|
|
|
21
|
-
Defined in: [packages/fate/src/transport.ts:53](https://github.com/nkzw-tech/fate/blob/
|
|
21
|
+
Defined in: [packages/fate/src/transport.ts:53](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L53)
|
|
22
22
|
|
|
23
23
|
#### Parameters
|
|
24
24
|
|
|
@@ -48,7 +48,7 @@ Defined in: [packages/fate/src/transport.ts:53](https://github.com/nkzw-tech/fat
|
|
|
48
48
|
|
|
49
49
|
> `optional` **fetchList**(`proc`, `select`, `args?`): `Promise`\<\{ `items`: `object`[]; `pagination`: [`Pagination`](../type-aliases/Pagination.md); \}\>
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/fate/src/transport.ts:59](https://github.com/nkzw-tech/fate/blob/
|
|
51
|
+
Defined in: [packages/fate/src/transport.ts:59](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L59)
|
|
52
52
|
|
|
53
53
|
#### Parameters
|
|
54
54
|
|
|
@@ -74,7 +74,7 @@ Defined in: [packages/fate/src/transport.ts:59](https://github.com/nkzw-tech/fat
|
|
|
74
74
|
|
|
75
75
|
> `optional` **fetchQuery**(`proc`, `select`, `args?`): `Promise`\<`unknown`\>
|
|
76
76
|
|
|
77
|
-
Defined in: [packages/fate/src/transport.ts:67](https://github.com/nkzw-tech/fate/blob/
|
|
77
|
+
Defined in: [packages/fate/src/transport.ts:67](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L67)
|
|
78
78
|
|
|
79
79
|
#### Parameters
|
|
80
80
|
|
|
@@ -100,7 +100,7 @@ Defined in: [packages/fate/src/transport.ts:67](https://github.com/nkzw-tech/fat
|
|
|
100
100
|
|
|
101
101
|
> `optional` **mutate**\<`K`\>(`proc`, `input`, `select`): `Promise`\<`Mutations`\[`K`\]\[`"output"`\]\>
|
|
102
102
|
|
|
103
|
-
Defined in: [packages/fate/src/transport.ts:68](https://github.com/nkzw-tech/fate/blob/
|
|
103
|
+
Defined in: [packages/fate/src/transport.ts:68](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L68)
|
|
104
104
|
|
|
105
105
|
#### Type Parameters
|
|
106
106
|
|
|
@@ -132,7 +132,7 @@ Defined in: [packages/fate/src/transport.ts:68](https://github.com/nkzw-tech/fat
|
|
|
132
132
|
|
|
133
133
|
> `optional` **subscribeById**(`type`, `id`, `select`, `args`, `handlers`): () => `void`
|
|
134
134
|
|
|
135
|
-
Defined in: [packages/fate/src/transport.ts:73](https://github.com/nkzw-tech/fate/blob/
|
|
135
|
+
Defined in: [packages/fate/src/transport.ts:73](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L73)
|
|
136
136
|
|
|
137
137
|
#### Parameters
|
|
138
138
|
|
|
@@ -166,7 +166,7 @@ Defined in: [packages/fate/src/transport.ts:73](https://github.com/nkzw-tech/fat
|
|
|
166
166
|
|
|
167
167
|
> `optional` **subscribeConnection**(`procedure`, `type`, `args`, `select`, `selectionArgs`, `handlers`): () => `void`
|
|
168
168
|
|
|
169
|
-
Defined in: [packages/fate/src/transport.ts:80](https://github.com/nkzw-tech/fate/blob/
|
|
169
|
+
Defined in: [packages/fate/src/transport.ts:80](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/transport.ts#L80)
|
|
170
170
|
|
|
171
171
|
#### Parameters
|
|
172
172
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Class: FateRequestError
|
|
2
2
|
|
|
3
|
-
Defined in: [packages/fate/src/protocol.ts:151](https://github.com/nkzw-tech/fate/blob/
|
|
3
|
+
Defined in: [packages/fate/src/protocol.ts:151](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/protocol.ts#L151)
|
|
4
4
|
|
|
5
5
|
## Extends
|
|
6
6
|
|
|
@@ -12,7 +12,7 @@ Defined in: [packages/fate/src/protocol.ts:151](https://github.com/nkzw-tech/fat
|
|
|
12
12
|
|
|
13
13
|
> **new FateRequestError**(`code`, `message`, `options?`): `FateRequestError`
|
|
14
14
|
|
|
15
|
-
Defined in: [packages/fate/src/protocol.ts:156](https://github.com/nkzw-tech/fate/blob/
|
|
15
|
+
Defined in: [packages/fate/src/protocol.ts:156](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/protocol.ts#L156)
|
|
16
16
|
|
|
17
17
|
#### Parameters
|
|
18
18
|
|
|
@@ -48,7 +48,7 @@ Defined in: [packages/fate/src/protocol.ts:156](https://github.com/nkzw-tech/fat
|
|
|
48
48
|
|
|
49
49
|
> `readonly` **code**: `FateProtocolErrorCode`
|
|
50
50
|
|
|
51
|
-
Defined in: [packages/fate/src/protocol.ts:152](https://github.com/nkzw-tech/fate/blob/
|
|
51
|
+
Defined in: [packages/fate/src/protocol.ts:152](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/protocol.ts#L152)
|
|
52
52
|
|
|
53
53
|
***
|
|
54
54
|
|
|
@@ -56,7 +56,7 @@ Defined in: [packages/fate/src/protocol.ts:152](https://github.com/nkzw-tech/fat
|
|
|
56
56
|
|
|
57
57
|
> `readonly` `optional` **issues?**: `unknown`
|
|
58
58
|
|
|
59
|
-
Defined in: [packages/fate/src/protocol.ts:153](https://github.com/nkzw-tech/fate/blob/
|
|
59
|
+
Defined in: [packages/fate/src/protocol.ts:153](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/protocol.ts#L153)
|
|
60
60
|
|
|
61
61
|
***
|
|
62
62
|
|
|
@@ -64,4 +64,4 @@ Defined in: [packages/fate/src/protocol.ts:153](https://github.com/nkzw-tech/fat
|
|
|
64
64
|
|
|
65
65
|
> `readonly` **status**: `number`
|
|
66
66
|
|
|
67
|
-
Defined in: [packages/fate/src/protocol.ts:154](https://github.com/nkzw-tech/fate/blob/
|
|
67
|
+
Defined in: [packages/fate/src/protocol.ts:154](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/protocol.ts#L154)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createDrizzleFate**\<`Context`, `Procedure`\>(`__namedParameters`): `object`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/drizzle.ts:
|
|
5
|
+
Defined in: [packages/fate/src/server/drizzle.ts:1701](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/server/drizzle.ts#L1701)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createDrizzleSourceAdapter**\<`Context`\>(`__namedParameters`): [`DrizzleSourceAdapter`](../type-aliases/DrizzleSourceAdapter.md)\<`Context`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/drizzle.ts:
|
|
5
|
+
Defined in: [packages/fate/src/server/drizzle.ts:833](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/server/drizzle.ts#L833)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **createDrizzleSourceRegistry**\<`Context`\>(`options`): [`SourceRegistry`](../../type-aliases/SourceRegistry.md)\<`Context`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/server/drizzle.ts:
|
|
5
|
+
Defined in: [packages/fate/src/server/drizzle.ts:1697](https://github.com/nkzw-tech/fate/blob/2b217058fdff50f3598b704f486529cd23a8dbb6/packages/fate/src/server/drizzle.ts#L1697)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|