AMT-Cheif
/
drift
mirror of https://github.com/AMT-Cheif/drift.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

normalize example methods based on docs elsewhere

This commit is contained in:
micimize 2021-04-04 11:12:48 -05:00
parent eb0c5da412
commit 7f83898d00
No known key found for this signature in database
GPG Key ID: 88F30E5F5F5D64A1
2 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/pages/docs/Getting started/writing_queries.md
View File

@ -107,11 +107,11 @@ MultiSelectable<Todo> pageOfTodos(int page, {int pageSize = 10}) {
}
// Exposes `getSingle` and `watchSingle`
SingleSelectable<Todo> todoById(int id) =>
SingleSelectable<Todo> entryById(int id) =>
select(todos)..where((t) => t.id.equals(id));
// Exposes `getSingleOrNull` and `watchSingleOrNull`
SingleOrNullSelectable<Todo> todoFromExternalLink(int id) =>
SingleOrNullSelectable<Todo> entryFromExternalLink(int id) =>
select(todos)..where((t) => t.id.equals(id));
```
These base classes don't have query-building or `map` methods, signaling to the consumer

11
moor/lib/src/runtime/query_builder/statements/query.dart
View File

@ -104,9 +104,8 @@ abstract class MultiSelectable<T> {
/// {@template moor_single_selectable_example}
/// ```dart
/// // Retrieve a todo known to exist.
/// SingleSelectable<Todo> entryById(int id) {
/// return (select(todos)..where((t) => t.id.equals(id)));
/// }
/// SingleSelectable<Todo> entryById(int id) =>
/// select(todos)..where((t) => t.id.equals(id));
/// final idGuaranteedToExist = 10;
/// entryById(idGuaranteedToExist).getSingle();
/// entryById(idGuaranteedToExist).watchSingle();
@ -161,12 +160,12 @@ abstract class SingleSelectable<T> {
/// {@template moor_single_or_null_selectable_example}
///```dart
/// // Retrieve a todo from an external link that may not be valid.
/// SingleOrNullSelectable<Todo> todoFromExternalLink(int id) =>
/// SingleOrNullSelectable<Todo> entryFromExternalLink(int id) =>
/// select(todos)..where((t) => t.id.equals(id));
///
/// final idFromEmailLink = 100;
/// todoFromExternalLink(idFromEmailLink).getSingleOrNull();
/// todoFromExternalLink(idFromEmailLink).watchSingleOrNull();
/// entryFromExternalLink(idFromEmailLink).getSingleOrNull();
/// entryFromExternalLink(idFromEmailLink).watchSingleOrNull();
/// ```
/// {@endtemplate}
///