typed_firestore 0.0.2

  • README.md
  • CHANGELOG.md
  • Installing
  • Versions
  • new57

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.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.2

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.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]
29
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]
57
Learn more about scoring.

We analyzed this package on Oct 10, 2018, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.0.0
  • pana: 0.12.4
  • Flutter: 0.9.5

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 description is too short. (-20 points)

Add more detail about the package, what it does and what is its target use case. Try to write at least 60 characters.

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package. Common file name patterns include: main.dart, example.dart or you could also use typed_firestore.dart.

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

While there is nothing inherently wrong with versions of 0.0.*, it usually means 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.1.4
cloud_firestore ^0.8.0 0.8.1
flutter 0.0.0
quiver ^2.0.0 2.0.0+1
Transitive dependencies
built_collection 4.0.0
collection 1.14.11
firebase_core 0.2.5+1
fixnum 0.10.8
matcher 0.12.4
meta 1.1.6
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