modifyDocument<T> method

Future<NimbostratusDocumentSnapshot<T?>> modifyDocument<T>(
  1. DocumentReference<T> ref,
  2. T modifyFn(
    1. T? currentValue
    ), {
  3. WritePolicy writePolicy = WritePolicy.serverFirst,
  4. ToFirestore<T>? toFirestore,
  5. 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,
  );
}