docs: Add example for Precondition (#601)

googleapis · Apr 16, 2019 · 89afaeb · 89afaeb
1 parent dac6246
commit 89afaeb
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/dev/src/index.ts b/dev/src/index.ts
@@ -133,6 +133,16 @@ const GRPC_UNAVAILABLE = 14;
  * can be restricted to only apply to documents that match the specified
  * conditions.
  *
+ * @example
+ * const documentRef = firestore.doc('coll/doc');
+ *
+ * documentRef.get().then(snapshot => {
+ *   const updateTime = snapshot.updateTime;
+ *
+ *   console.log(`Deleting document at update time: ${updateTime.toDate()}`);
+ *   return documentRef.delete({ lastUpdateTime: updateTime });
+ * });
+ *
  * @property {string} lastUpdateTime The update time to enforce (specified as
  * an ISO 8601 string).
  * @typedef {Object} Precondition