[DOCS-3752] Event Feeds: Document page_size limit

fauna · Nov 18, 2024 · 070950f · 070950f
1 parent 57ff77a
commit 070950f
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/config.go b/config.go
@@ -193,6 +193,9 @@ func EventFeedStartTimeFromTime(ts time.Time) FeedOptFn {
 }
 
 // EventFeedPageSize set the page size for the [fauna.EventFeed]
-func EventFeedPageSize(ts int) FeedOptFn {
-	return func(req *feedOptions) { req.PageSize = &ts }
+// The page size is the maximum number of events returned per page.
+// Must be in the range 1 to 16000 (inclusive).
+// Defaults to 16.
+func EventFeedPageSize(pageSize int) FeedOptFn {
+	return func(req *feedOptions) { req.PageSize = &pageSize }
 }