From 070950ff3c8fa009d62458a5a8faac035d51832b Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 18 Nov 2024 14:50:49 -0500 Subject: [PATCH] [DOCS-3752] Event Feeds: Document `page_size` limit --- config.go | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/config.go b/config.go index 9f98c2c..b6a5a94 100644 --- 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 } }