Skip to content

Commit

Permalink
Apply suggestions for comments from code review
Browse files Browse the repository at this point in the history
Co-authored-by: blagoev <lubo@blagoev.com>
  • Loading branch information
nielsenko and blagoev authored Feb 8, 2022
1 parent 1ab4616 commit acc2624
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ vNext
* Primary key annotation no longer requires field to be final.

### Enhancements
* Allow query on lists
* Support query on lists of realm objects


0.2.0+alpha Release notes (2022-01-31)
Expand Down
10 changes: 9 additions & 1 deletion lib/src/list.dart
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,15 @@ class RealmList<T extends Object> extends collection.ListBase<T> {
// The query operations on lists only work for list of objects (core restriction),
// so we add it as an extension method to allow the compiler to prevent misuse.
extension RealmListOfObject<T extends RealmObject> on RealmList<T> {
/// Filter list.
/// Filters the list and returns a new [RealmResults] according to the provided query.
///
/// Only works for lists of Realm objects.
///
/// @param query The query used to filter the list
/// @param args Optional parameters for substitution in the query
///
/// The Realm Dart and Realm Flutter SDKs supports querying based on a language inspired by [NSPredicate](https://academy.realm.io/posts/nspredicate-cheatsheet/)
/// and [Predicate Programming Guide.](https://developer.apple.com/library/archive/documentation/Cocoa/Conceptual/Predicates/AdditionalChapters/Introduction.html#//apple_ref/doc/uid/TP40001789)
///
/// @param query The query
/// @param args Possible parameters for substition in query
Expand Down

0 comments on commit acc2624

Please sign in to comment.