typed_firestore 0.0.3

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • 74

typed_firestore #

Typed firestore entity.

Usage #


abstract class Car extends DocData implements Built<Car, CarBuilder> {
  static Serializer<Car> get serializer => _$carSerializer;

  String get title;

  @nullable
  String get nullableField;

  Car._();

  factory Car([updates(CarBuilder b)]) = _$Car;
}

@SerializersFor(const [
  Car,
])
Serializers serializers = _$serializers;


final firestore = new TypedFirestore(
  Firestore.instance,
  (serializers.toBuilder()..addPlugin(StandardJsonPlugin())).build(),
);

final CollRef<Car> cars = firestore.collection<Car>('cars');


[0.0.3] - 2019-03-24

Support non-existent docs.

[0.0.1] - 2018-09-24

  • First release.

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  typed_firestore: ^0.0.3

2. Install it

You can install packages from the command line:

with Flutter:


$ flutter packages get

Alternatively, your editor might support flutter packages get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:typed_firestore/typed_firestore.dart';
  
Version Uploaded Documentation Archive
0.1.1 May 16, 2019 Go to the documentation of typed_firestore 0.1.1 Download typed_firestore 0.1.1 archive
0.1.0 May 15, 2019 Go to the documentation of typed_firestore 0.1.0 Download typed_firestore 0.1.0 archive
0.0.4 Mar 26, 2019 Go to the documentation of typed_firestore 0.0.4 Download typed_firestore 0.0.4 archive
0.0.3 Mar 24, 2019 Go to the documentation of typed_firestore 0.0.3 Download typed_firestore 0.0.3 archive
0.0.2 Sep 26, 2018 Go to the documentation of typed_firestore 0.0.2 Download typed_firestore 0.0.2 archive
0.0.1 Sep 25, 2018 Go to the documentation of typed_firestore 0.0.1 Download typed_firestore 0.0.1 archive
Popularity:
Describes how popular the package is relative to other packages. [more]
65
Health:
Code health derived from static analysis. [more]
100
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
60
Overall:
Weighted score of the above. [more]
74
Learn more about scoring.

We analyzed this package on May 8, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.3.0
  • pana: 0.12.15
  • Flutter: 1.5.8

Platforms

Detected platforms: Flutter

References Flutter, and has no conflicting libraries.

Health suggestions

Format lib/src/typed_firestore.dart.

Run flutter format to format lib/src/typed_firestore.dart.

Maintenance suggestions

The package description is too short. (-20 points)

Add more detail to the description field of pubspec.yaml. Use 60 to 180 characters to describe the package, what it does, and its target use case.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and typed_firestore.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Package is pre-v0.1 release. (-10 points)

While nothing is inherently wrong with versions of 0.0.*, it might mean that the author is still experimenting with the general direction of the API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.0.0-dev.54 <3.0.0
built_value ^6.1.3 6.5.0
cloud_firestore ^0.8.0 0.8.2+3 0.11.0+1
flutter 0.0.0
quiver ^2.0.0 2.0.3
Transitive dependencies
built_collection 4.2.1
collection 1.14.11
firebase_core 0.2.5+1 0.4.0
fixnum 0.10.9
matcher 0.12.5
meta 1.1.6 1.1.7
path 1.6.2
sky_engine 0.0.99
stack_trace 1.9.3
typed_data 1.1.6
vector_math 2.0.8
Dev dependencies
build_runner ^0.10.2
built_value_generator ^6.1.3
flutter_test
mockito ^3.0.0