@nkzw/fate 1.5.0 → 1.5.1
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 +5 -7
- package/docs/api/classes/FateClient.md +38 -38
- 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 +1 -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 +2 -0
- package/docs/api/interfaces/FateThenable.md +3 -3
- package/docs/api/interfaces/Persistence.md +1 -19
- package/docs/api/interfaces/PersistenceSession.md +10 -10
- package/docs/api/interfaces/Transport.md +8 -8
- 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 +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/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 +12 -12
- 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 +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/PersistedMutationStatus.md +5 -0
- package/docs/api/type-aliases/PersistenceSnapshot.md +2 -2
- 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/RequestPersistenceOptions.md +5 -0
- 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/persistence.md +5 -7
- package/lib/{executor-DoiTBiVv.d.mts → executor-oPTYqgQV.d.mts} +1 -1
- package/lib/{graphqlTransport-DGLYyRxL.d.mts → graphqlTransport-CGYE4NdD.d.mts} +1 -1
- package/lib/graphqlTransport.d.mts +1 -1
- package/lib/idempotency-types-DuqJ7KSd.d.mts +16 -0
- package/lib/idempotency.d.mts +7 -7
- package/lib/index.d.mts +5 -5
- package/lib/index.mjs +25 -15
- package/lib/{list-BRT1VtiT.d.mts → list-5hrTVoiB.d.mts} +1 -1
- package/lib/list.d.mts +1 -1
- package/lib/persistence.d.mts +20 -18
- package/lib/persistence.mjs +553 -352
- package/lib/{record-DITM4zb_.d.mts → record-Dxjvpsep.d.mts} +3 -3
- package/lib/server/drizzle.d.mts +2 -2
- package/lib/server/prisma.d.mts +2 -2
- package/lib/server.d.mts +3 -3
- package/lib/{store-CeatPJeK.mjs → store-CakBBzWG.mjs} +47 -11
- package/lib/{transport-DqjhjLfC.d.mts → transport-DR0fwleU.d.mts} +29 -16
- package/package.json +1 -1
- package/lib/idempotency-types-CqA-BFpn.d.mts +0 -15
package/README.md
CHANGED
|
@@ -1354,13 +1354,13 @@ Then pass `persistence` when creating the client:
|
|
|
1354
1354
|
|
|
1355
1355
|
```tsx
|
|
1356
1356
|
import { createPersistence } from '@nkzw/fate/persistence';
|
|
1357
|
-
import {
|
|
1357
|
+
import { createIndexedDBStorage } from '@nkzw/fate-indexeddb';
|
|
1358
1358
|
import { createFateClient } from 'react-fate/client';
|
|
1359
1359
|
|
|
1360
1360
|
const fate = createFateClient({
|
|
1361
1361
|
persistence: createPersistence({
|
|
1362
1362
|
key: `workspace:${workspaceId}:user:${userId}`,
|
|
1363
|
-
storage:
|
|
1363
|
+
storage: createIndexedDBStorage(),
|
|
1364
1364
|
}),
|
|
1365
1365
|
url: '/api/fate',
|
|
1366
1366
|
});
|
|
@@ -1373,7 +1373,7 @@ persistence: createPersistence({
|
|
|
1373
1373
|
key: `workspace:${workspaceId}:user:${userId}`,
|
|
1374
1374
|
maxAge: 24 * 60 * 60 * 1000,
|
|
1375
1375
|
maxBytes: 25 * 1024 * 1024,
|
|
1376
|
-
storage:
|
|
1376
|
+
storage: createIndexedDBStorage(),
|
|
1377
1377
|
}),
|
|
1378
1378
|
```
|
|
1379
1379
|
|
|
@@ -1545,7 +1545,7 @@ const durableHTTP = createHTTPTransport<MyAPI>({
|
|
|
1545
1545
|
|
|
1546
1546
|
const fate = createFateClient({
|
|
1547
1547
|
// ...your generated tRPC or GraphQL client options...
|
|
1548
|
-
persistence: createPersistence({ key: accountKey, storage:
|
|
1548
|
+
persistence: createPersistence({ key: accountKey, storage: createIndexedDBStorage() }),
|
|
1549
1549
|
mutateDurably: durableHTTP.mutateDurably,
|
|
1550
1550
|
});
|
|
1551
1551
|
```
|
|
@@ -1635,7 +1635,6 @@ The core persistence layer has no IndexedDB dependency. You can use another back
|
|
|
1635
1635
|
```ts
|
|
1636
1636
|
interface PersistenceStorage {
|
|
1637
1637
|
read(key: string): Promise<unknown>;
|
|
1638
|
-
write(key: string, value: unknown): Promise<void>;
|
|
1639
1638
|
scan(
|
|
1640
1639
|
prefix: string,
|
|
1641
1640
|
after?: string,
|
|
@@ -1650,9 +1649,8 @@ interface PersistenceStorage {
|
|
|
1650
1649
|
Values use fate's hydration codec and can be stored as JSON. The adapter handles storage and coordination:
|
|
1651
1650
|
|
|
1652
1651
|
- `read` returns the saved value for a key.
|
|
1653
|
-
- `write` replaces one value atomically and resolves after it has committed.
|
|
1654
1652
|
- `scan` returns keys under a prefix in ascending order, strictly after the optional cursor, up to the limit (64 by default). Use your backend's ordered index to keep each scan small.
|
|
1655
|
-
- `writeBatch` commits all entries atomically. An `undefined` value deletes the key.
|
|
1653
|
+
- `writeBatch` commits all entries atomically and resolves after they have committed. An `undefined` value deletes the key. Use a one-entry batch for a single write.
|
|
1656
1654
|
- `exclusive` coordinates every tab or process sharing the backend. Different lock names are independent: fate holds a delivery lock during network work and acquires a separate write lock when updating storage. Your adapter must allow that nesting.
|
|
1657
1655
|
- `subscribe` notifies other clients after a change commits, including keys changed by `writeBatch`. Without notifications, clients check saved mutations during delivery attempts and explicit `retry()` calls.
|
|
1658
1656
|
|
|
@@ -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:426](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L426)
|
|
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:487](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L487)
|
|
29
29
|
|
|
30
30
|
#### Parameters
|
|
31
31
|
|
|
@@ -43,7 +43,7 @@ Defined in: [packages/fate/src/client.ts:479](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:483](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L483)
|
|
47
47
|
|
|
48
48
|
***
|
|
49
49
|
|
|
@@ -51,7 +51,7 @@ Defined in: [packages/fate/src/client.ts:475](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:484](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L484)
|
|
55
55
|
|
|
56
56
|
***
|
|
57
57
|
|
|
@@ -59,7 +59,7 @@ Defined in: [packages/fate/src/client.ts:476](https://github.com/nkzw-tech/fate/
|
|
|
59
59
|
|
|
60
60
|
> `readonly` `optional` **persistence?**: [`PersistenceSession`](../interfaces/PersistenceSession.md)
|
|
61
61
|
|
|
62
|
-
Defined in: [packages/fate/src/client.ts:
|
|
62
|
+
Defined in: [packages/fate/src/client.ts:482](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L482)
|
|
63
63
|
|
|
64
64
|
***
|
|
65
65
|
|
|
@@ -67,7 +67,7 @@ Defined in: [packages/fate/src/client.ts:474](https://github.com/nkzw-tech/fate/
|
|
|
67
67
|
|
|
68
68
|
> `readonly` **roots**: `Roots`
|
|
69
69
|
|
|
70
|
-
Defined in: [packages/fate/src/client.ts:
|
|
70
|
+
Defined in: [packages/fate/src/client.ts:485](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L485)
|
|
71
71
|
|
|
72
72
|
***
|
|
73
73
|
|
|
@@ -75,7 +75,7 @@ Defined in: [packages/fate/src/client.ts:477](https://github.com/nkzw-tech/fate/
|
|
|
75
75
|
|
|
76
76
|
> `readonly` **store**: `Store`
|
|
77
77
|
|
|
78
|
-
Defined in: [packages/fate/src/client.ts:
|
|
78
|
+
Defined in: [packages/fate/src/client.ts:464](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L464)
|
|
79
79
|
|
|
80
80
|
## Methods
|
|
81
81
|
|
|
@@ -83,7 +83,7 @@ Defined in: [packages/fate/src/client.ts:456](https://github.com/nkzw-tech/fate/
|
|
|
83
83
|
|
|
84
84
|
> **assertLiveConnectionSupport**(): `void`
|
|
85
85
|
|
|
86
|
-
Defined in: [packages/fate/src/client.ts:
|
|
86
|
+
Defined in: [packages/fate/src/client.ts:1276](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1276)
|
|
87
87
|
|
|
88
88
|
#### Returns
|
|
89
89
|
|
|
@@ -95,7 +95,7 @@ Defined in: [packages/fate/src/client.ts:1258](https://github.com/nkzw-tech/fate
|
|
|
95
95
|
|
|
96
96
|
> **assertLiveViewSupport**(): `void`
|
|
97
97
|
|
|
98
|
-
Defined in: [packages/fate/src/client.ts:
|
|
98
|
+
Defined in: [packages/fate/src/client.ts:1268](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1268)
|
|
99
99
|
|
|
100
100
|
#### Returns
|
|
101
101
|
|
|
@@ -107,7 +107,7 @@ Defined in: [packages/fate/src/client.ts:1250](https://github.com/nkzw-tech/fate
|
|
|
107
107
|
|
|
108
108
|
> **dehydrate**(): [`FateDehydratedState`](../type-aliases/FateDehydratedState.md)\<`HydrationScope`\>
|
|
109
109
|
|
|
110
|
-
Defined in: [packages/fate/src/client.ts:
|
|
110
|
+
Defined in: [packages/fate/src/client.ts:590](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L590)
|
|
111
111
|
|
|
112
112
|
Exports the durable normalized cache as an opaque JSON-safe value for SSR
|
|
113
113
|
transfer or persistence. Runtime requests, subscriptions, retainers, and
|
|
@@ -123,7 +123,7 @@ optimistic state are intentionally excluded.
|
|
|
123
123
|
|
|
124
124
|
> **deleteRecord**(`type`, `id`): `void`
|
|
125
125
|
|
|
126
|
-
Defined in: [packages/fate/src/client.ts:
|
|
126
|
+
Defined in: [packages/fate/src/client.ts:950](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L950)
|
|
127
127
|
|
|
128
128
|
#### Parameters
|
|
129
129
|
|
|
@@ -145,7 +145,7 @@ Defined in: [packages/fate/src/client.ts:933](https://github.com/nkzw-tech/fate/
|
|
|
145
145
|
|
|
146
146
|
> **executeMutation**(`key`, `input`, `select`, `options?`): `Promise`\<`unknown`\>
|
|
147
147
|
|
|
148
|
-
Defined in: [packages/fate/src/client.ts:
|
|
148
|
+
Defined in: [packages/fate/src/client.ts:902](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L902)
|
|
149
149
|
|
|
150
150
|
#### Parameters
|
|
151
151
|
|
|
@@ -185,7 +185,7 @@ Defined in: [packages/fate/src/client.ts:885](https://github.com/nkzw-tech/fate/
|
|
|
185
185
|
|
|
186
186
|
> **gc**(): `void`
|
|
187
187
|
|
|
188
|
-
Defined in: [packages/fate/src/client.ts:
|
|
188
|
+
Defined in: [packages/fate/src/client.ts:2240](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2240)
|
|
189
189
|
|
|
190
190
|
Removes records and lists that are not reachable from retained requests or
|
|
191
191
|
the release buffer.
|
|
@@ -204,7 +204,7 @@ memory-management flows.
|
|
|
204
204
|
|
|
205
205
|
> **getRequestKey**(`request`): `string`
|
|
206
206
|
|
|
207
|
-
Defined in: [packages/fate/src/client.ts:
|
|
207
|
+
Defined in: [packages/fate/src/client.ts:2525](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2525)
|
|
208
208
|
|
|
209
209
|
#### Parameters
|
|
210
210
|
|
|
@@ -222,7 +222,7 @@ Defined in: [packages/fate/src/client.ts:2505](https://github.com/nkzw-tech/fate
|
|
|
222
222
|
|
|
223
223
|
> **getRequestResult**\<`R`\>(`request`): [`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>
|
|
224
224
|
|
|
225
|
-
Defined in: [packages/fate/src/client.ts:
|
|
225
|
+
Defined in: [packages/fate/src/client.ts:2702](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2702)
|
|
226
226
|
|
|
227
227
|
#### Type Parameters
|
|
228
228
|
|
|
@@ -246,7 +246,7 @@ Defined in: [packages/fate/src/client.ts:2681](https://github.com/nkzw-tech/fate
|
|
|
246
246
|
|
|
247
247
|
> **getTypeConfig**(`type`): [`TypeConfig`](../type-aliases/TypeConfig.md)
|
|
248
248
|
|
|
249
|
-
Defined in: [packages/fate/src/client.ts:
|
|
249
|
+
Defined in: [packages/fate/src/client.ts:839](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L839)
|
|
250
250
|
|
|
251
251
|
#### Parameters
|
|
252
252
|
|
|
@@ -264,7 +264,7 @@ Defined in: [packages/fate/src/client.ts:830](https://github.com/nkzw-tech/fate/
|
|
|
264
264
|
|
|
265
265
|
> **hydrate**(`state`, `options?`): `void`
|
|
266
266
|
|
|
267
|
-
Defined in: [packages/fate/src/client.ts:
|
|
267
|
+
Defined in: [packages/fate/src/client.ts:617](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L617)
|
|
268
268
|
|
|
269
269
|
Restores a durable normalized cache snapshot without restoring runtime
|
|
270
270
|
request handles, retainers, subscriptions, or optimistic update state.
|
|
@@ -290,7 +290,7 @@ Hydrate before rendering SSR content. Replaying the same snapshot is safe.
|
|
|
290
290
|
|
|
291
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`\>
|
|
292
292
|
|
|
293
|
-
Defined in: [packages/fate/src/client.ts:
|
|
293
|
+
Defined in: [packages/fate/src/client.ts:1928](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1928)
|
|
294
294
|
|
|
295
295
|
#### Type Parameters
|
|
296
296
|
|
|
@@ -328,7 +328,7 @@ Defined in: [packages/fate/src/client.ts:1910](https://github.com/nkzw-tech/fate
|
|
|
328
328
|
|
|
329
329
|
> **prepareRequestForRender**\<`R`\>(`request`, `options`): `Readonly`\<\{ `promise`: `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>; `requestKey`: `string`; \}\>
|
|
330
330
|
|
|
331
|
-
Defined in: [packages/fate/src/client.ts:
|
|
331
|
+
Defined in: [packages/fate/src/client.ts:2101](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2101)
|
|
332
332
|
|
|
333
333
|
#### Type Parameters
|
|
334
334
|
|
|
@@ -344,7 +344,7 @@ Defined in: [packages/fate/src/client.ts:2083](https://github.com/nkzw-tech/fate
|
|
|
344
344
|
|
|
345
345
|
##### options
|
|
346
346
|
|
|
347
|
-
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`:
|
|
347
|
+
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`: `Readonly`\<\{ `maxAge`: `number`; \}\>; \}\> \| `undefined`
|
|
348
348
|
|
|
349
349
|
#### Returns
|
|
350
350
|
|
|
@@ -356,7 +356,7 @@ Defined in: [packages/fate/src/client.ts:2083](https://github.com/nkzw-tech/fate
|
|
|
356
356
|
|
|
357
357
|
> **readDeferred**\<`T`\>(`deferred`): `PromiseLike`\<`Readonly`\<\{ `coverage`: readonly readonly \[`string`, `ReadonlySet`\<`string`\>\][]; `data`: `T`; \}\>\>
|
|
358
358
|
|
|
359
|
-
Defined in: [packages/fate/src/client.ts:
|
|
359
|
+
Defined in: [packages/fate/src/client.ts:1171](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1171)
|
|
360
360
|
|
|
361
361
|
#### Type Parameters
|
|
362
362
|
|
|
@@ -380,7 +380,7 @@ Defined in: [packages/fate/src/client.ts:1153](https://github.com/nkzw-tech/fate
|
|
|
380
380
|
|
|
381
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`\>; \}\>\>
|
|
382
382
|
|
|
383
|
-
Defined in: [packages/fate/src/client.ts:
|
|
383
|
+
Defined in: [packages/fate/src/client.ts:997](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L997)
|
|
384
384
|
|
|
385
385
|
#### Type Parameters
|
|
386
386
|
|
|
@@ -416,7 +416,7 @@ Defined in: [packages/fate/src/client.ts:980](https://github.com/nkzw-tech/fate/
|
|
|
416
416
|
|
|
417
417
|
> **ref**\<`T`\>(`type`, `id`, `view`): [`ViewRef`](../type-aliases/ViewRef.md)\<`T`\[`"__typename"`\]\>
|
|
418
418
|
|
|
419
|
-
Defined in: [packages/fate/src/client.ts:
|
|
419
|
+
Defined in: [packages/fate/src/client.ts:984](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L984)
|
|
420
420
|
|
|
421
421
|
#### Type Parameters
|
|
422
422
|
|
|
@@ -448,7 +448,7 @@ Defined in: [packages/fate/src/client.ts:967](https://github.com/nkzw-tech/fate/
|
|
|
448
448
|
|
|
449
449
|
> **registerPendingOptimisticMutation**(`entityId`, `promise`): `void`
|
|
450
450
|
|
|
451
|
-
Defined in: [packages/fate/src/client.ts:
|
|
451
|
+
Defined in: [packages/fate/src/client.ts:1891](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1891)
|
|
452
452
|
|
|
453
453
|
#### Parameters
|
|
454
454
|
|
|
@@ -470,7 +470,7 @@ Defined in: [packages/fate/src/client.ts:1873](https://github.com/nkzw-tech/fate
|
|
|
470
470
|
|
|
471
471
|
> **releaseRequest**(`request`, `mode`): `void`
|
|
472
472
|
|
|
473
|
-
Defined in: [packages/fate/src/client.ts:
|
|
473
|
+
Defined in: [packages/fate/src/client.ts:2179](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2179)
|
|
474
474
|
|
|
475
475
|
#### Parameters
|
|
476
476
|
|
|
@@ -492,7 +492,7 @@ Defined in: [packages/fate/src/client.ts:2160](https://github.com/nkzw-tech/fate
|
|
|
492
492
|
|
|
493
493
|
> **releaseRequestKey**(`requestKey`, `mode`): `void`
|
|
494
494
|
|
|
495
|
-
Defined in: [packages/fate/src/client.ts:
|
|
495
|
+
Defined in: [packages/fate/src/client.ts:2183](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2183)
|
|
496
496
|
|
|
497
497
|
#### Parameters
|
|
498
498
|
|
|
@@ -514,7 +514,7 @@ Defined in: [packages/fate/src/client.ts:2164](https://github.com/nkzw-tech/fate
|
|
|
514
514
|
|
|
515
515
|
> **request**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
|
|
516
516
|
|
|
517
|
-
Defined in: [packages/fate/src/client.ts:
|
|
517
|
+
Defined in: [packages/fate/src/client.ts:2079](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2079)
|
|
518
518
|
|
|
519
519
|
#### Type Parameters
|
|
520
520
|
|
|
@@ -530,7 +530,7 @@ Defined in: [packages/fate/src/client.ts:2061](https://github.com/nkzw-tech/fate
|
|
|
530
530
|
|
|
531
531
|
##### options?
|
|
532
532
|
|
|
533
|
-
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`:
|
|
533
|
+
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`: `Readonly`\<\{ `maxAge`: `number`; \}\>; \}\>
|
|
534
534
|
|
|
535
535
|
#### Returns
|
|
536
536
|
|
|
@@ -542,7 +542,7 @@ Defined in: [packages/fate/src/client.ts:2061](https://github.com/nkzw-tech/fate
|
|
|
542
542
|
|
|
543
543
|
> **requestForRender**\<`R`\>(`request`, `options?`): `Promise`\<[`RequestResult`](../type-aliases/RequestResult.md)\<`Roots`, `R`\>\>
|
|
544
544
|
|
|
545
|
-
Defined in: [packages/fate/src/client.ts:
|
|
545
|
+
Defined in: [packages/fate/src/client.ts:2094](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2094)
|
|
546
546
|
|
|
547
547
|
#### Type Parameters
|
|
548
548
|
|
|
@@ -558,7 +558,7 @@ Defined in: [packages/fate/src/client.ts:2076](https://github.com/nkzw-tech/fate
|
|
|
558
558
|
|
|
559
559
|
##### options?
|
|
560
560
|
|
|
561
|
-
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`:
|
|
561
|
+
`Readonly`\<\{ `mode?`: [`RequestMode`](../type-aliases/RequestMode.md); `persist?`: `Readonly`\<\{ `maxAge`: `number`; \}\>; \}\>
|
|
562
562
|
|
|
563
563
|
#### Returns
|
|
564
564
|
|
|
@@ -570,7 +570,7 @@ Defined in: [packages/fate/src/client.ts:2076](https://github.com/nkzw-tech/fate
|
|
|
570
570
|
|
|
571
571
|
> **resolveOptimisticEntity**(`optimisticEntityId`, `resolvedEntityId`): `void`
|
|
572
572
|
|
|
573
|
-
Defined in: [packages/fate/src/client.ts:
|
|
573
|
+
Defined in: [packages/fate/src/client.ts:1916](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1916)
|
|
574
574
|
|
|
575
575
|
#### Parameters
|
|
576
576
|
|
|
@@ -592,7 +592,7 @@ Defined in: [packages/fate/src/client.ts:1898](https://github.com/nkzw-tech/fate
|
|
|
592
592
|
|
|
593
593
|
> **retain**(`request`): `RetainHandle`
|
|
594
594
|
|
|
595
|
-
Defined in: [packages/fate/src/client.ts:
|
|
595
|
+
Defined in: [packages/fate/src/client.ts:2214](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2214)
|
|
596
596
|
|
|
597
597
|
Keeps the records and lists reachable from a request alive until the
|
|
598
598
|
returned handle is disposed.
|
|
@@ -617,7 +617,7 @@ that must survive manual garbage collection.
|
|
|
617
617
|
|
|
618
618
|
> **retainRequestKey**(`requestKey`, `mode?`): `RetainHandle`
|
|
619
619
|
|
|
620
|
-
Defined in: [packages/fate/src/client.ts:
|
|
620
|
+
Defined in: [packages/fate/src/client.ts:2195](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2195)
|
|
621
621
|
|
|
622
622
|
#### Parameters
|
|
623
623
|
|
|
@@ -639,7 +639,7 @@ Defined in: [packages/fate/src/client.ts:2176](https://github.com/nkzw-tech/fate
|
|
|
639
639
|
|
|
640
640
|
> **rootListRef**(`entityId`, `rootView`): `Readonly`\<\{ `__typename`: `string`; `[ViewsTag]`: `Set`\<`string`\>; `id`: `string` \| `number`; \}\>
|
|
641
641
|
|
|
642
|
-
Defined in: [packages/fate/src/client.ts:
|
|
642
|
+
Defined in: [packages/fate/src/client.ts:992](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L992)
|
|
643
643
|
|
|
644
644
|
#### Parameters
|
|
645
645
|
|
|
@@ -661,7 +661,7 @@ Defined in: [packages/fate/src/client.ts:975](https://github.com/nkzw-tech/fate/
|
|
|
661
661
|
|
|
662
662
|
> **subscribeLiveListView**\<`V`\>(`view`, `connection`): () => `void`
|
|
663
663
|
|
|
664
|
-
Defined in: [packages/fate/src/client.ts:
|
|
664
|
+
Defined in: [packages/fate/src/client.ts:1369](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1369)
|
|
665
665
|
|
|
666
666
|
#### Type Parameters
|
|
667
667
|
|
|
@@ -689,7 +689,7 @@ Defined in: [packages/fate/src/client.ts:1351](https://github.com/nkzw-tech/fate
|
|
|
689
689
|
|
|
690
690
|
> **subscribeLiveView**\<`T`, `S`, `V`\>(`view`, `ref`): () => `void`
|
|
691
691
|
|
|
692
|
-
Defined in: [packages/fate/src/client.ts:
|
|
692
|
+
Defined in: [packages/fate/src/client.ts:1284](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L1284)
|
|
693
693
|
|
|
694
694
|
#### Type Parameters
|
|
695
695
|
|
|
@@ -725,7 +725,7 @@ Defined in: [packages/fate/src/client.ts:1266](https://github.com/nkzw-tech/fate
|
|
|
725
725
|
|
|
726
726
|
> **trackPendingRequest**\<`T`\>(`request`): `Promise`\<`T`\>
|
|
727
727
|
|
|
728
|
-
Defined in: [packages/fate/src/client.ts:
|
|
728
|
+
Defined in: [packages/fate/src/client.ts:2474](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L2474)
|
|
729
729
|
|
|
730
730
|
#### Type Parameters
|
|
731
731
|
|
|
@@ -749,7 +749,7 @@ Defined in: [packages/fate/src/client.ts:2454](https://github.com/nkzw-tech/fate
|
|
|
749
749
|
|
|
750
750
|
> **write**(`type`, `data`, `select`, `plan?`, `insert?`): `string`
|
|
751
751
|
|
|
752
|
-
Defined in: [packages/fate/src/client.ts:
|
|
752
|
+
Defined in: [packages/fate/src/client.ts:940](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L940)
|
|
753
753
|
|
|
754
754
|
#### Parameters
|
|
755
755
|
|
|
@@ -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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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:3522](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/client.ts#L3522)
|
|
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:579](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:579](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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:160](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/transport.ts:160](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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.
|
|
@@ -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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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.
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **graphqlMutation**\<`T`, `Input`, `Output`\>(`entity`, `options`): [`GraphQLMutationDefinition`](../type-aliases/GraphQLMutationDefinition.md)\<`T`, `Input`, `Output`\>
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/graphqlTransport.ts:568](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/graphqlTransport.ts:568](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/graphqlTransport.ts#L568)
|
|
6
6
|
|
|
7
7
|
## Type Parameters
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> **isDeferred**(`value`): `value is Deferred<unknown>`
|
|
4
4
|
|
|
5
|
-
Defined in: [packages/fate/src/defer.ts:25](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/defer.ts:25](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/defer.ts#L25)
|
|
6
6
|
|
|
7
7
|
## Parameters
|
|
8
8
|
|
|
@@ -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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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:65](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/types.ts:65](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/types.ts#L65)
|
|
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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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:27](https://github.com/nkzw-tech/fate/blob/
|
|
5
|
+
Defined in: [packages/fate/src/mutation.ts:27](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/mutation.ts#L27)
|
|
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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/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/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/view.ts#L111)
|
|
6
6
|
|
|
7
7
|
Creates a reusable view for an object using the declared selection.
|
|
8
8
|
|
package/docs/api/index.md
CHANGED
|
@@ -58,10 +58,12 @@ import { view } from '@nkzw/fate';
|
|
|
58
58
|
- [MutationResult](type-aliases/MutationResult.md)
|
|
59
59
|
- [NodesItem](type-aliases/NodesItem.md)
|
|
60
60
|
- [Pagination](type-aliases/Pagination.md)
|
|
61
|
+
- [PersistedMutationStatus](type-aliases/PersistedMutationStatus.md)
|
|
61
62
|
- [PersistenceSnapshot](type-aliases/PersistenceSnapshot.md)
|
|
62
63
|
- [Request](type-aliases/Request.md)
|
|
63
64
|
- [RequestMode](type-aliases/RequestMode.md)
|
|
64
65
|
- [RequestOptions](type-aliases/RequestOptions.md)
|
|
66
|
+
- [RequestPersistenceOptions](type-aliases/RequestPersistenceOptions.md)
|
|
65
67
|
- [RequestResult](type-aliases/RequestResult.md)
|
|
66
68
|
- [Selection](type-aliases/Selection.md)
|
|
67
69
|
- [TypeConfig](type-aliases/TypeConfig.md)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Interface: FateThenable\<T\>
|
|
2
2
|
|
|
3
|
-
Defined in: [packages/fate/src/types.ts:512](https://github.com/nkzw-tech/fate/blob/
|
|
3
|
+
Defined in: [packages/fate/src/types.ts:512](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/types.ts#L512)
|
|
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:513](https://github.com/nkzw-tech/fate/blob/
|
|
23
|
+
Defined in: [packages/fate/src/types.ts:513](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/types.ts#L513)
|
|
24
24
|
|
|
25
25
|
***
|
|
26
26
|
|
|
@@ -28,4 +28,4 @@ Defined in: [packages/fate/src/types.ts:513](https://github.com/nkzw-tech/fate/b
|
|
|
28
28
|
|
|
29
29
|
> **value**: `T`
|
|
30
30
|
|
|
31
|
-
Defined in: [packages/fate/src/types.ts:514](https://github.com/nkzw-tech/fate/blob/
|
|
31
|
+
Defined in: [packages/fate/src/types.ts:514](https://github.com/nkzw-tech/fate/blob/4d2c828cce4c513c8e424ff1ffe320bb387c49f2/packages/fate/src/types.ts#L514)
|