voluptasmollitia/docs-exp/firestore_lite.refequal.md

Monorepo for the Firebase JavaScript SDK

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [lite](./firestore_lite.md) &gt; [refEqual](./firestore_lite.refequal.md)

## refEqual() function

Returns true if the provided references are equal.

<b>Signature:</b>

```typescript
export declare function refEqual<T>(left: DocumentReference<T> | CollectionReference<T>, right: DocumentReference<T> | CollectionReference<T>): boolean;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  left | [DocumentReference](./firestore_lite.documentreference.md)<!-- -->&lt;T&gt; \| [CollectionReference](./firestore_lite.collectionreference.md)<!-- -->&lt;T&gt; | A reference to compare. |
|  right | [DocumentReference](./firestore_lite.documentreference.md)<!-- -->&lt;T&gt; \| [CollectionReference](./firestore_lite.collectionreference.md)<!-- -->&lt;T&gt; | A reference to compare. |

<b>Returns:</b>

boolean

true if the references point to the same location in the same Firestore database.