Skip to content

Commit e92241e

Browse files
authored
Merge pull request #508 from GetStream/update-docs
docs: update docs
2 parents 1483d4b + b32538c commit e92241e

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

projects/stream-chat-angular/src/lib/channel.service.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,11 @@ export class ChannelService<
295295
message: StreamMessage<T>
296296
) => StreamMessage<T> | Promise<StreamMessage<T>>;
297297
/**
298-
* By default the SDK uses an offset based pagination, you can change/extend this by providing your own custom paginator method. It will be called with the result of the latest channel query.
298+
* By default the SDK uses an offset based pagination, you can change/extend this by providing your own custom paginator method.
299+
*
300+
* The method will be called with the result of the latest channel query.
301+
*
302+
* You can return either an offset, or a filter using the [`$lte`/`$gte` operator](https://getstream.io/chat/docs/javascript/query_syntax_operators/). If you return a filter, it will be merged with the filter provided for the `init` method.
299303
*/
300304
customPaginator?: (channelQueryResult: Channel<T>[]) => NextPageConfiguration;
301305
private channelsSubject = new BehaviorSubject<Channel<T>[] | undefined>(

0 commit comments

Comments
 (0)