Skip to content

Commit 89378c4

Browse files
KyleAMathewsclaude
andcommitted
docs: add JSDoc clarifying batch-level cursor semantics on DeltaEvent
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 9143af1 commit 89378c4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

packages/db/src/query/effect.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ export type DeltaEvent<
4949
key: TKey
5050
/** Current value for the entering row */
5151
value: TRow
52+
/** Batch-level high-water cursor — the maximum cursor observed across all source changes in this batch. Use for checkpointing via startAfter. */
5253
cursor?: CollectionCursor
5354
metadata?: Record<string, unknown>
5455
}
@@ -57,6 +58,7 @@ export type DeltaEvent<
5758
key: TKey
5859
/** Current value for the exiting row */
5960
value: TRow
61+
/** Batch-level high-water cursor — the maximum cursor observed across all source changes in this batch. Use for checkpointing via startAfter. */
6062
cursor?: CollectionCursor
6163
metadata?: Record<string, unknown>
6264
}
@@ -67,6 +69,7 @@ export type DeltaEvent<
6769
value: TRow
6870
/** Previous value before the batch */
6971
previousValue: TRow
72+
/** Batch-level high-water cursor — the maximum cursor observed across all source changes in this batch. Use for checkpointing via startAfter. */
7073
cursor?: CollectionCursor
7174
metadata?: Record<string, unknown>
7275
}

0 commit comments

Comments
 (0)