diff --git a/packages/stream_chat/lib/src/models/filter.dart b/packages/stream_chat/lib/src/models/filter.dart index 6cda6f91..2356c57b 100644 --- a/packages/stream_chat/lib/src/models/filter.dart +++ b/packages/stream_chat/lib/src/models/filter.dart @@ -164,19 +164,25 @@ class Filter extends Equatable { String? key, }) = Filter.__; - /// Operator to use in filter. + /// An operator used for the filter. The operator string must start with `$` final String operator; + /// The "left-hand" side of the filter. + /// Specifies the name of the field the filter should match. /// + /// Some operators like `and` or `or`, + /// don't require the key value to be present. + /// see-more : [_groupOperators] final String? key; - /// + /// The "right-hand" side of the filter. + /// Specifies the [value] the filter should match. final Object /*List|List|String*/ value; @override List get props => [operator, key, value]; - /// + /// Serializes to json object Map toJson() { final json = {}; final groupOperators = _groupOperators.map((it) => it.rawValue);