Home > @firebase/firestore > / > onSnapshot

onSnapshot() function

Attaches a listener for DocumentSnapshot events. You may either pass individual onNext and onError callbacks or pass a single observer object with next and error callbacks.

NOTE: Although an onCompletion callback can be provided, it will never be called because the snapshot stream is never-ending.

Signature:

export declare function onSnapshot<T>(reference: DocumentReference<T>, options: SnapshotListenOptions, onNext: (snapshot: DocumentSnapshot<T>) => void, onError?: (error: FirestoreError) => void, onCompletion?: () => void): Unsubscribe;

Parameters

Parameter	Type	Description
reference	DocumentReference<T>	A reference to the document to listen to.
options	SnapshotListenOptions	Options controlling the listen behavior.
onNext	(snapshot: DocumentSnapshot<T>) => void	A callback to be called every time a new DocumentSnapshot is available.
onError	(error: FirestoreError) => void	A callback to be called if the listen fails or is cancelled. No further callbacks will occur.
onCompletion	() => void	Can be provided, but will not be called since streams are never ending.

Returns:

Unsubscribe

An unsubscribe function that can be called to cancel the snapshot listener.