updateDocument<T> method

Future<NimbostratusDocumentSnapshot<T?>> updateDocument<T>(
  1. DocumentReference<T> ref,
  2. T data, {
  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.

Implementation

Future<NimbostratusDocumentSnapshot<T?>> updateDocument<T>(
  DocumentReference<T> ref,
  T data, {
  WritePolicy writePolicy = WritePolicy.serverFirst,

  /// A serialization function for the data sent to Firestore.
  ToFirestore<T>? toFirestore,

  /// A merge function for merging an incoming server response from Firestore
  /// into the Nimbostratus cache.
  NimbostratusFromFirestore<T>? fromFirestore,
}) {
  return _updateDocument(
    ref,
    data,
    writePolicy: writePolicy,
    toFirestore: toFirestore,
    fromFirestore: fromFirestore,
  );
}