voluptasmollitia
Version:
Monorepo for the Firebase JavaScript SDK
27 lines (15 loc) • 1.21 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@firebase/firestore](./firestore.md) > [lite](./firestore_lite.md) > [CollectionReference](./firestore_lite.collectionreference.md) > [withConverter](./firestore_lite.collectionreference.withconverter.md)
## CollectionReference.withConverter() method
Applies a custom data converter to this CollectionReference, allowing you to use your own custom model objects with Firestore. When you call [addDoc()](./firestore_.adddoc.md) with the returned `CollectionReference` instance, the provided converter will convert between Firestore data and your custom type `U`<!-- -->.
<b>Signature:</b>
```typescript
withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| converter | [FirestoreDataConverter](./firestore_lite.firestoredataconverter.md)<!-- --><U> | Converts objects to and from Firestore. |
<b>Returns:</b>
[CollectionReference](./firestore_lite.collectionreference.md)<!-- --><U>
A `CollectionReference<U>` that uses the provided converter.