voluptasmollitia
Version:
Monorepo for the Firebase JavaScript SDK
35 lines (19 loc) • 1.53 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@firebase/firestore](./firestore.md) > [/](./firestore_.md) > [terminate](./firestore_.terminate.md)
## 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()](./firestore_.getfirestore.md)<!-- -->.
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.
<b>Signature:</b>
```typescript
export declare function terminate(firestore: FirebaseFirestore): Promise<void>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| firestore | [FirebaseFirestore](./firestore_.firebasefirestore.md) | |
<b>Returns:</b>
Promise<void>
A promise that is resolved when the instance has been successfully terminated.