Home > @firebase/firestore > / > terminate

terminate() function

Terminates the provided Firestore instance.

After calling terminate() only the clearIndexedDbPersistence() function may be used. Any other function will throw a FirestoreError.

To restart after termination, create a new instance of FirebaseFirestore with getFirestore().

Termination does not cancel any pending writes, and any promises that are awaiting a response from the server will not be resolved. If you have persistence enabled, the next time you start this instance, it will resume sending these writes to the server.

Note: Under normal circumstances, calling terminate() is not required. This function is useful only when you want to force this instance to release all of its resources or in combination with clearIndexedDbPersistence() to ensure that all local state is destroyed between test runs.

Signature:

export declare function terminate(firestore: FirebaseFirestore): Promise<void>;

Parameters

Parameter	Type	Description
firestore	FirebaseFirestore

Returns:

Promise<void>

A promise that is resolved when the instance has been successfully terminated.