Yust class
Yust is the easiest way to connect full stack Dart app to Firebase.
It is supporting Firebase Auth, Cloud Firestore and Cloud Storage. You can use Yust in a flutter and for a server app.
Constructors
- Yust({required bool forUI, DatabaseLogCallback? dbLogCallback, bool useSubcollections = false, String envCollectionName = 'envs', OnChangeCallback? onChange})
- Initializes Yust. If you will use yust in combination with e.g. YustUI in a flutter app set forUI to true.
- Yust.mocked({required bool forUI, bool useSubcollections = false, String envCollectionName = 'envs', DatabaseLogCallback? dbLogCallback, OnChangeCallback? onChange})
- Initializes Yust in a mocked way => use in memory db instead of a real connection to firebase. If you will use yust in combination with e.g. YustUI in a flutter app set forUI to true.
Properties
- dbLogCallback → DatabaseLogCallback?
-
final
- dbService ↔ YustDatabaseService
-
getter/setter pair
- envCollectionName → String
-
final
- forUI ↔ bool
-
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- mocked ↔ bool
-
getter/setter pair
- onChange → OnChangeCallback?
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useSubcollections → bool
-
final
Methods
-
closeClient(
) → dynamic -
initialize(
{Map< String, String> ? firebaseOptions, String? pathToServiceAccountJson, required String projectId, String? emulatorAddress, YustDocSetup<YustUser> ? userSetup, DatabaseLogCallback? dbLogCallback, AccessCredentials? credentials}) → Future<void> -
Initializes Yust.
This method should be called before any usage of the yust package.
Use
firebaseOptions
to connect to Firebase if your are using Flutter. UsepathToServiceAccountJson
if you are connecting directly with Dart. Set theemulatorAddress
, if you want to emulate Firebase.userSetup
let you overwrite the defaultUserSetup
. If useSubcollections is set to true (default), Yust is creating subcollections for each tannant automatically. envCollectionName represents the collection name for the tannants. UseprojectId
to override / set the project id otherwise gathered from the execution environment. UsedbLogCallback
to provide a function that will get called on each DatabaseCall -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- authClient ↔ Client?
-
getter/setter pair
- authService ↔ YustAuthService
-
getter/setter pair
- databaseService → YustDatabaseService
-
When using Yust with Flutter, you can access the databaseService of the
only instance of Yust with this getter._
no setter
- fileService ↔ YustFileService
-
getter/setter pair
- helpers ↔ YustHelpers
-
getter/setter pair
- instance → Yust
-
When using Yust with Flutter, you can access the instance of Yust with
this getter.
no setter
- projectId ↔ String
-
getter/setter pair
-
userSetup
↔ YustDocSetup<
YustUser> -
getter/setter pair