More docs, try to fix pana warnings

This commit is contained in:
Simon Binder 2019-12-24 13:48:51 +01:00
parent d41097d8e5
commit b79c1c1f57
No known key found for this signature in database
GPG Key ID: 7891917E4147B8C0
4 changed files with 14 additions and 8 deletions

View File

@ -115,7 +115,7 @@ class Batch {
rethrow; rethrow;
} }
} else { } else {
return _runWith(_engine.executor); await _runWith(_engine.executor);
} }
_engine.markTablesUpdated(_affectedTables); _engine.markTablesUpdated(_affectedTables);

View File

@ -6,6 +6,7 @@ part of 'runtime_api.dart';
/// migration logic can live in the main [GeneratedDatabase] class, but code /// migration logic can live in the main [GeneratedDatabase] class, but code
/// can be extracted into [DatabaseAccessor]s outside of that database. /// can be extracted into [DatabaseAccessor]s outside of that database.
/// For details on how to write a dao, see [UseDao]. /// For details on how to write a dao, see [UseDao].
/// [T] should be the associated database class you wrote.
abstract class DatabaseAccessor<T extends GeneratedDatabase> abstract class DatabaseAccessor<T extends GeneratedDatabase>
extends DatabaseConnectionUser with QueryEngine { extends DatabaseConnectionUser with QueryEngine {
@override @override

View File

@ -5,6 +5,7 @@ import 'package:moor/moor.dart';
/// Common interface for objects which can be inserted or updated into a /// Common interface for objects which can be inserted or updated into a
/// database. /// database.
/// [D] is the associated data class.
@optionalTypeArgs @optionalTypeArgs
abstract class Insertable<D extends DataClass> { abstract class Insertable<D extends DataClass> {
/// Converts this object into a companion that can be used for inserts. On /// Converts this object into a companion that can be used for inserts. On
@ -44,6 +45,8 @@ abstract class DataClass {
/// An update companion for a [DataClass] which is used to write data into a /// An update companion for a [DataClass] which is used to write data into a
/// database using [InsertStatement.insert] or [UpdateStatement.write]. /// database using [InsertStatement.insert] or [UpdateStatement.write].
/// ///
/// [D] is the associated data class for this companion.
///
/// See also: /// See also:
/// - the explanation in the changelog for 1.5 /// - the explanation in the changelog for 1.5
/// - https://github.com/simolus3/moor/issues/25 /// - https://github.com/simolus3/moor/issues/25

View File

@ -5,7 +5,7 @@ import 'package:convert/convert.dart';
part 'custom_type.dart'; part 'custom_type.dart';
part 'type_system.dart'; part 'type_system.dart';
/// A type that can be mapped from Dart to sql. The generic type parameter here /// A type that can be mapped from Dart to sql. The generic type parameter [T]
/// denotes the resolved dart type. /// denotes the resolved dart type.
abstract class SqlType<T> { abstract class SqlType<T> {
/// Constant constructor so that subclasses can be constant /// Constant constructor so that subclasses can be constant
@ -57,8 +57,9 @@ class BoolType extends SqlType<bool> {
} }
@override @override
dynamic mapToSqlVariable(bool content) { int mapToSqlVariable(bool content) {
if (content == null) { if (content == null) {
// ignore: avoid_returning_null
return null; return null;
} }
return content ? 1 : 0; return content ? 1 : 0;
@ -85,7 +86,7 @@ class StringType extends SqlType<String> implements Monoid<String> {
} }
@override @override
dynamic mapToSqlVariable(String content) => content; String mapToSqlVariable(String content) => content;
} }
/// Maps [int] values from and to sql /// Maps [int] values from and to sql
@ -100,7 +101,7 @@ class IntType extends SqlType<int> implements FullArithmetic<int> {
String mapToSqlConstant(int content) => content?.toString() ?? 'NULL'; String mapToSqlConstant(int content) => content?.toString() ?? 'NULL';
@override @override
dynamic mapToSqlVariable(int content) { int mapToSqlVariable(int content) {
return content; return content;
} }
} }
@ -128,7 +129,8 @@ class DateTimeType extends SqlType<DateTime>
} }
@override @override
dynamic mapToSqlVariable(DateTime content) { int mapToSqlVariable(DateTime content) {
// ignore: avoid_returning_null
if (content == null) return null; if (content == null) return null;
return content.millisecondsSinceEpoch ~/ 1000; return content.millisecondsSinceEpoch ~/ 1000;
@ -151,7 +153,7 @@ class BlobType extends SqlType<Uint8List> {
} }
@override @override
dynamic mapToSqlVariable(Uint8List content) => content; Uint8List mapToSqlVariable(Uint8List content) => content;
} }
/// Maps [double] values from and to sql /// Maps [double] values from and to sql
@ -173,5 +175,5 @@ class RealType extends SqlType<double> implements FullArithmetic<double> {
} }
@override @override
dynamic mapToSqlVariable(num content) => content; num mapToSqlVariable(num content) => content;
} }