Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add documentation for FirestoreDataConverter #1059

Merged
merged 2 commits into from
Apr 30, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions dev/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,53 @@ const MAX_CONCURRENT_REQUESTS_PER_CLIENT = 100;
* @typedef {Object.<string, *>} DocumentData
*/

/**
* Converter used by [withConverter()]{@link Query#withConverter} to transform
* user objects of type T into Firestore data.
*
* Using the converter allows you to specify generic type arguments when storing
* and retrieving objects from Firestore.
*
* @example
* class Post {
* constructor(readonly title: string, readonly author: string) {}
*
* toString(): string {
* return this.title + ', by ' + this.author;
* }
* }
*
* const postConverter = {
* toFirestore(post: Post): FirebaseFirestore.DocumentData {
* return {title: post.title, author: post.author};
* },
* fromFirestore(
* data: FirebaseFirestore.QueryDocumentSnapshot
* ): Post {
* const data = snapshot.data();
* return new Post(data.title, data.author);
* }
* };
*
* const postSnap = await Firestore()
* .collection('posts')
* .withConverter(postConverter)
* .doc().get();
* const post = postSnap.data();
* if (post !== undefined) {
* post.title; // string
* post.toString(); // Should be defined
* post.someNonExistentProperty; // TS error
* }
*
* @property {Function} toFirestore Called by the Firestore SDK to convert a
* custom model object of type T into a plain Javascript object (suitable for
* writing directly to the Firestore database).
* @property {Function} fromFirestore Called by the Firestore SDK to convert
* Firestore data into an object of type T.
* @typedef {Object} FirestoreDataConverter
*/

/**
* Update data (for use with [update]{@link DocumentReference#update})
* that contains paths (e.g. 'foo' or 'foo.baz') mapped to values. Fields that
Expand Down
22 changes: 12 additions & 10 deletions dev/src/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -535,11 +535,10 @@ export class DocumentReference<T = DocumentData> implements Serializable {
}

/**
* Applies a custom data converter to this DocumentReference, allowing you
* to use your own custom model objects with Firestore. When you call
* set(), get(), etc. on the returned DocumentReference instance, the
* provided converter will convert between Firestore data and your custom
* type U.
* Applies a custom data converter to this DocumentReference, allowing you to
* use your own custom model objects with Firestore. When you call set(),
* get(), etc. on the returned DocumentReference instance, the provided
* converter will convert between Firestore data and your custom type U.
*
* Using the converter allows you to specify generic type arguments when
* storing and retrieving objects from Firestore.
Expand Down Expand Up @@ -576,7 +575,8 @@ export class DocumentReference<T = DocumentData> implements Serializable {
* post.someNonExistentProperty; // TS error
* }
*
* @param converter Converts objects to and from Firestore.
* @param {FirestoreDataConverter} converter Converts objects to and from
* Firestore.
* @return A DocumentReference<U> that uses the provided converter.
*/
withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U> {
Expand Down Expand Up @@ -2176,7 +2176,8 @@ export class Query<T = DocumentData> {
* post.someNonExistentProperty; // TS error
* }
*
* @param converter Converts objects to and from Firestore.
* @param {FirestoreDataConverter} converter Converts objects to and from
* Firestore.
* @return A Query<U> that uses the provided converter.
*/
withConverter<U>(converter: FirestoreDataConverter<U>): Query<U> {
Expand Down Expand Up @@ -2411,8 +2412,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> {

/**
* Applies a custom data converter to this CollectionReference, allowing you
* to use your own custom model objects with Firestore. When you call add()
* on the returned CollectionReference instance, the provided converter will
* to use your own custom model objects with Firestore. When you call add() on
* the returned CollectionReference instance, the provided converter will
* convert between Firestore data and your custom type U.
*
* Using the converter allows you to specify generic type arguments when
Expand Down Expand Up @@ -2450,7 +2451,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
* post.someNonExistentProperty; // TS error
* }
*
* @param converter Converts objects to and from Firestore.
* @param {FirestoreDataConverter} converter Converts objects to and from
* Firestore.
* @return A CollectionReference<U> that uses the provided converter.
*/
withConverter<U>(
Expand Down