modifyDocument<T> method
Future<NimbostratusDocumentSnapshot<T?> >
modifyDocument<T>(
- DocumentReference<
T> ref, - T modifyFn(
- T? currentValue
- WritePolicy writePolicy = WritePolicy.serverFirst,
- ToFirestore<
T> ? toFirestore, - NimbostratusFromFirestore<
T> ? fromFirestore,
Updates a Firestore document and updates the in-memory cache according to the specified WritePolicy. Convenience wrapper around the updateDocument API that provides an update callback which is given the current document value.
Implementation
Future<NimbostratusDocumentSnapshot<T?>> modifyDocument<T>(
DocumentReference<T> ref,
T Function(T? currentValue) modifyFn, {
WritePolicy writePolicy = WritePolicy.serverFirst,
ToFirestore<T>? toFirestore,
NimbostratusFromFirestore<T>? fromFirestore,
}) async {
return _modifyDocument<T>(
ref,
modifyFn,
toFirestore: toFirestore,
writePolicy: writePolicy,
fromFirestore: fromFirestore,
);
}