API reference · generated from source
Function: reconcileConvexDocuments()#
function reconcileConvexDocuments<TDoc>(): IStateReconciler<TDoc[]>;Defined in: retree-convex/src/reconcile.ts:66
Create a reconciler for Convex document arrays using each document's _id.
Type Parameters#
| Type Parameter |
|---|
TDoc extends object |
Returns#
IStateReconciler<TDoc[]>
A reconciler that updates matching Convex documents in place.
Remarks#
Use this for Convex document arrays when you want explicit reconciliation.
ConvexQueryNode also tries Convex _id reconciliation by default for
document arrays, but passing this reconciler makes the behavior clear at the
call site.
Example#
this.tasks = this.query(api.tasks.list, {
args: { projectId },
reconcile: reconcileConvexDocuments(),
});