update docstrings

Author: blidd-google

src/v2/providers/firestore.ts

@@ -137,7 +137,7 @@ export interface DocumentOptions<Document extends string = string> extends Event
 }
 
 /**
- * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ * Event handler that triggers when a document is created, updated, or deleted in Firestore.
  *
  * @param document - The Firestore document path to trigger on.
  * @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
@@ -150,7 +150,7 @@ export function onDocumentWritten<Document extends string>(
 ): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ * Event handler that triggers when a document is created, updated, or deleted in Firestore.
  *
  * @param opts - Options that can be set on an individual event-handling function.
  * @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
@@ -163,7 +163,7 @@ export function onDocumentWritten<Document extends string>(
 ): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ * Event handler that triggers when a document is created, updated, or deleted in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore create, update, or delete occurs.
@@ -178,7 +178,7 @@ export function onDocumentWritten<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ * Event handler that triggers when a document is created, updated, or deleted in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param document - The Firestore document path to trigger on.
@@ -192,7 +192,7 @@ export function onDocumentWrittenWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ * Event handler that triggers when a document is created, updated, or deleted in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param opts - Options that can be set on an individual event-handling function.
@@ -206,7 +206,7 @@ export function onDocumentWrittenWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created, updated, or deleted in Firestore.
+ * Event handler that triggers when a document is created, updated, or deleted in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param opts - Options or a string document path.
@@ -222,7 +222,7 @@ export function onDocumentWrittenWithAuthContext<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is created in Firestore.
+ * Event handler that triggers when a document is created in Firestore.
  *
  * @param document - The Firestore document path to trigger on.
  * @param handler - Event handler which is run every time a Firestore create occurs.
@@ -235,7 +235,7 @@ export function onDocumentCreated<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created in Firestore.
+ * Event handler that triggers when a document is created in Firestore.
  *
  * @param opts - Options that can be set on an individual event-handling function.
  * @param handler - Event handler which is run every time a Firestore create occurs.
@@ -248,7 +248,7 @@ export function onDocumentCreated<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created in Firestore.
+ * Event handler that triggers when a document is created in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore create occurs.
@@ -263,7 +263,7 @@ export function onDocumentCreated<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is created in Firestore.
+ * Event handler that triggers when a document is created in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param document - The Firestore document path to trigger on.
@@ -277,7 +277,7 @@ export function onDocumentCreatedWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created in Firestore.
+ * Event handler that triggers when a document is created in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param opts - Options that can be set on an individual event-handling function.
@@ -291,7 +291,7 @@ export function onDocumentCreatedWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is created in Firestore.
+ * Event handler that triggers when a document is created in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore create occurs.
@@ -306,7 +306,7 @@ export function onDocumentCreatedWithAuthContext<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is updated in Firestore.
+ * Event handler that triggers when a document is updated in Firestore.
  *
  * @param document - The Firestore document path to trigger on.
  * @param handler - Event handler which is run every time a Firestore update occurs.
@@ -318,7 +318,7 @@ export function onDocumentUpdated<Document extends string>(
   ) => any | Promise<any>
 ): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
 /**
- * Event handler which triggers when a document is updated in Firestore.
+ * Event handler that triggers when a document is updated in Firestore.
  *
  * @param opts - Options that can be set on an individual event-handling function.
  * @param handler - Event handler which is run every time a Firestore update occurs.
@@ -331,7 +331,7 @@ export function onDocumentUpdated<Document extends string>(
 ): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is updated in Firestore.
+ * Event handler that triggers when a document is updated in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore update occurs.
@@ -346,7 +346,7 @@ export function onDocumentUpdated<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is updated in Firestore.
+ * Event handler that triggers when a document is updated in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param document - The Firestore document path to trigger on.
@@ -359,7 +359,7 @@ export function onDocumentUpdatedWithAuthContext<Document extends string>(
   ) => any | Promise<any>
 ): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
 /**
- * Event handler which triggers when a document is updated in Firestore.
+ * Event handler that triggers when a document is updated in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param opts - Options that can be set on an individual event-handling function.
@@ -373,7 +373,7 @@ export function onDocumentUpdatedWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is updated in Firestore.
+ * Event handler that triggers when a document is updated in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore update occurs.
@@ -388,7 +388,7 @@ export function onDocumentUpdatedWithAuthContext<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is deleted in Firestore.
+ * Event handler that triggers when a document is deleted in Firestore.
  *
  * @param document - The Firestore document path to trigger on.
  * @param handler - Event handler which is run every time a Firestore delete occurs.
@@ -401,7 +401,7 @@ export function onDocumentDeleted<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is deleted in Firestore.
+ * Event handler that triggers when a document is deleted in Firestore.
  *
  * @param opts - Options that can be set on an individual event-handling function.
  * @param handler - Event handler which is run every time a Firestore delete occurs.
@@ -414,7 +414,7 @@ export function onDocumentDeleted<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is deleted in Firestore.
+ * Event handler that triggers when a document is deleted in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore delete occurs.
@@ -429,7 +429,7 @@ export function onDocumentDeleted<Document extends string>(
 }
 
 /**
- * Event handler which triggers when a document is deleted in Firestore.
+ * Event handler that triggers when a document is deleted in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param document - The Firestore document path to trigger on.
@@ -443,7 +443,7 @@ export function onDocumentDeletedWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is deleted in Firestore.
+ * Event handler that triggers when a document is deleted in Firestore.
  * This trigger will also provide the authentication context of the principal who triggered the event.
  *
  * @param opts - Options that can be set on an individual event-handling function.
@@ -457,7 +457,7 @@ export function onDocumentDeletedWithAuthContext<Document extends string>(
 ): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;
 
 /**
- * Event handler which triggers when a document is deleted in Firestore.
+ * Event handler that triggers when a document is deleted in Firestore.
  *
  * @param documentOrOpts - Options or a string document path.
  * @param handler - Event handler which is run every time a Firestore delete occurs.