Skip to content

Commit 97b1938

Browse files
committed
feat: update docs to reflect new EventWithAuthContext type
1 parent 9a80483 commit 97b1938

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Diff for: src/firebase_functions/firestore_fn.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -277,13 +277,13 @@ def on_document_written_with_auth_context(**kwargs
277277
.. code-block:: python
278278
279279
@on_document_written_with_auth_context(document="*")
280-
def example(event: Event[Change[DocumentSnapshot]]) -> None:
280+
def example(event: EventWithAuthContext[Change[DocumentSnapshot]]) -> None:
281281
pass
282282
283283
:param \\*\\*kwargs: Firestore options.
284284
:type \\*\\*kwargs: as :exc:`firebase_functions.options.FirestoreOptions`
285285
:rtype: :exc:`typing.Callable`
286-
\\[ \\[ :exc:`firebase_functions.firestore_fn.Event` \\[
286+
\\[ \\[ :exc:`firebase_functions.firestore_fn.EventWithAuthContext` \\[
287287
:exc:`firebase_functions.db.Change` \\] \\], `None` \\]
288288
A function that takes a Firestore event and returns ``None``.
289289
"""
@@ -375,13 +375,13 @@ def on_document_updated_with_auth_context(**kwargs
375375
.. code-block:: python
376376
377377
@on_document_updated_with_auth_context(document="*")
378-
def example(event: Event[Change[DocumentSnapshot]]) -> None:
378+
def example(event: EventWithAuthContext[Change[DocumentSnapshot]]) -> None:
379379
pass
380380
381381
:param \\*\\*kwargs: Firestore options.
382382
:type \\*\\*kwargs: as :exc:`firebase_functions.options.FirestoreOptions`
383383
:rtype: :exc:`typing.Callable`
384-
\\[ \\[ :exc:`firebase_functions.firestore_fn.Event` \\[
384+
\\[ \\[ :exc:`firebase_functions.firestore_fn.EventWithAuthContext` \\[
385385
:exc:`firebase_functions.db.Change` \\] \\], `None` \\]
386386
A function that takes a Firestore event and returns ``None``.
387387
"""
@@ -473,13 +473,13 @@ def on_document_created_with_auth_context(**kwargs
473473
.. code-block:: python
474474
475475
@on_document_created_with_auth_context(document="*")
476-
def example(event: Event[DocumentSnapshot]):
476+
def example(event: EventWithAuthContext[DocumentSnapshot]):
477477
pass
478478
479479
:param \\*\\*kwargs: Firestore options.
480480
:type \\*\\*kwargs: as :exc:`firebase_functions.options.FirestoreOptions`
481481
:rtype: :exc:`typing.Callable`
482-
\\[ \\[ :exc:`firebase_functions.firestore_fn.Event` \\[
482+
\\[ \\[ :exc:`firebase_functions.firestore_fn.EventWithAuthContext` \\[
483483
:exc:`object` \\] \\], `None` \\]
484484
A function that takes a Firestore event and returns ``None``.
485485
"""
@@ -571,13 +571,13 @@ def on_document_deleted_with_auth_context(**kwargs
571571
.. code-block:: python
572572
573573
@on_document_deleted_with_auth_context(document="*")
574-
def example(event: Event[DocumentSnapshot]) -> None:
574+
def example(event: EventWithAuthContext[DocumentSnapshot]) -> None:
575575
pass
576576
577577
:param \\*\\*kwargs: Firestore options.
578578
:type \\*\\*kwargs: as :exc:`firebase_functions.options.FirestoreOptions`
579579
:rtype: :exc:`typing.Callable`
580-
\\[ \\[ :exc:`firebase_functions.firestore_fn.Event` \\[
580+
\\[ \\[ :exc:`firebase_functions.firestore_fn.EventWithAuthContext` \\[
581581
:exc:`object` \\] \\], `None` \\]
582582
A function that takes a Firestore event and returns ``None``.
583583
"""

0 commit comments

Comments
 (0)