Skip to content

Commit 87c4b43

Browse files
committed
Update jsdoc for mode option
1 parent 2d3a526 commit 87c4b43

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

packages/client/src/clients/feed/interfaces.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,11 @@ export interface FeedClientOptions {
4949
inclusive?: boolean;
5050
};
5151
/**
52-
* The mode to render the feed items in. When `mode` is `compact`, feed items will not have
53-
* `activities` and `total_activities` fields, and the `data` field will not include nested
54-
* arrays and objects.
52+
* The mode to render the feed items in. When `mode` is `compact`:
53+
*
54+
* - The `activities` and `total_activities` fields will _not_ be present on feed items
55+
* - The `data` field will _not_ include nested arrays and objects
56+
* - The `actors` field will only have up to one actor
5557
*
5658
* @default "compact"
5759
*/

0 commit comments

Comments
 (0)