Skip to content

Commit

Permalink
[DOCS-3753] Event Feeds: Document pageSize limit (#228)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Nov 18, 2024
1 parent 358ad00 commit f6142aa
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions Fauna/Core/FeedOptions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,8 @@ public class FeedOptions : EventOptions
/// Initializes a new instance of the <see cref="FeedOptions"/> class with the specified cursor and optional page size.
/// </summary>
/// <param name="cursor">The cursor for the feed. Used to resume the Feed.</param>
/// <param name="pageSize">Optional page size for the feed.</param>
/// <param name="pageSize">Optional page size for the feed. Sets the maximum number of events returned per page. Must
/// be in the range 1 to 16000 (inclusive). Defaults to 16.</param>
/// <seealso href="https://docs.fauna.com/fauna/current/reference/cdc/#get-events-after-a-specific-cursor"/>
public FeedOptions(string cursor, int? pageSize = null)
{
Expand All @@ -23,7 +24,8 @@ public FeedOptions(string cursor, int? pageSize = null)
/// Initializes a new instance of the <see cref="FeedOptions"/> class with the specified start timestamp and optional page size.
/// </summary>
/// <param name="startTs">The start timestamp for the feed. Used to resume the Feed.</param>
/// <param name="pageSize">Optional page size for the feed.</param>
/// <param name="pageSize">Optional page size for the feed. Sets the maximum number of events returned per page. Must
/// be in the range 1 to 16000 (inclusive). Defaults to 16.</param>
/// <seealso href="https://docs.fauna.com/fauna/current/reference/cdc/#get-events-after-a-specific-cursor"/>
public FeedOptions(long startTs, int? pageSize = null)
{
Expand All @@ -34,7 +36,8 @@ public FeedOptions(long startTs, int? pageSize = null)
/// <summary>
/// Initializes a new instance of the <see cref="FeedOptions"/> class with the specified page size.
/// </summary>
/// <param name="pageSize">The page size for the feed.</param>
/// <param name="pageSize">Maximum number of events returned per page. Must
/// be in the range 1 to 16000 (inclusive). Defaults to 16.</param>
public FeedOptions(int pageSize)
{
PageSize = pageSize;
Expand Down

0 comments on commit f6142aa

Please sign in to comment.