Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kikuchy/stove
Strongly typed wrapper library for cloud_firestore for Flutter. Happy yummy Firestore life for you! 🔥🍳
https://github.com/kikuchy/stove
dart firebase firestore flutter
Last synced: 20 days ago
JSON representation
Strongly typed wrapper library for cloud_firestore for Flutter. Happy yummy Firestore life for you! 🔥🍳
- Host: GitHub
- URL: https://github.com/kikuchy/stove
- Owner: kikuchy
- License: other
- Created: 2020-05-07T16:49:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-05-13T04:59:23.000Z (over 4 years ago)
- Last Synced: 2024-12-20T05:02:13.006Z (24 days ago)
- Topics: dart, firebase, firestore, flutter
- Language: Dart
- Homepage: https://pub.dev/packages/stove
- Size: 81.1 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Stove 🔥🍳
*Stove* is the thin, but strongly typed wrapper library for [cloud_firestore](https://pub.dev/packages/cloud_firestore).
Now you can,
* take advantages of the type checker of Dart language
* avoid runtime errors due to `dynamic` arguments of `cloud_firestore`
* avoid typos due to using raw String literals for the name of document's fields
Stove provides you a happy yummy Firestore life for you! 🔥🍳
## Using
### Define the document class
```dart
/// User document
class User {}
```
That's it!
Also, you can add fields for this class if you want.
### Define fields of the document
```dart
// The document `User` has fields named `name` and `gender`.
class UserField implements Field {
final String name;
final Converter storeToLocal;
final Converter localToStore;
const UserField._(this.name, this.storeToLocal, this.localToStore);
static const name$ = UserField._("name", identity, identity);
static final gender = UserField._(
"gender",
(f) => Gender.values.where((g) => g.toString().contains(f)).first,
(l) => l.toString().split(".")[1]);
}
```
The class represents the field of the document should extend `Field`.
`T` should be unique by each document.
`FT` means "Type in Firesore".
`LT` means "Type in the local environment".
You can define your own converters that converts `FT` and `LT`.
You can use all type of instance if you write converters.
If you don't want to convert the value, put `identity` converter (it through arguments).
### Define children of the document
```dart
// The document `User` has a child (sub collection) named `friends`.
class UserChildren implements SubCollection {
final String name;
const UserChildren._(this.name);
static const friends = UserChildren._("friends");
}
```
The class represents the child (sub collection) should extend `SubCollection`.
`C` is the class represents the document of the element of that collection.
### Using document reference
```dart
// Create the reference of new document
final userReference = Stove.instance.collection("/users").document();
// Save data
await userReference.setData(DocumentDifference()
..set(UserFields.name$, "Bob")
..set(UserFields.gender, Gender.male)
);
// Update data
await userReference.updateData(DocumentDifference()
..set(UserFields.name$, "John")
..delete(UserFields.gender)
);
// Delete data
await userReference.delete();
// Get the snapshot
final userSnapshot = await userReference.get();
final name = userSnapshot.data.get(UserFields.name$); // name: String
final gender = userSnapshot.data.get(UserFields.gender); // gender: Gender (automatically converted!)
switch (gender) {
case Gender.male:
......
}
// Access sub collection
final friendsReference = userReference.SubCollection(UserChildren.friends);
```
### Using sub collection reference
```dart
final usersReference = Stove.instance.collection("/users");
// Get all documents
final snapshots = usersReference.documents();
// Listen all documents
usersReference.snapshots()
.listen((/*List>*/ snapshots) {
doYourStuff(snapshots)
});
// Query documents
usersReference
.where(UserFields.gender, isEqualTo: Gender.female)
.order(UserFields.name$)
.documents();
```