Skip to content
This repository was archived by the owner on Mar 4, 2026. It is now read-only.

docs: Improve documentation for DocumentReference.create. #1926

Merged
ehsannas merged 2 commits into from
Oct 25, 2023
Merged

docs: Improve documentation for DocumentReference.create. #1926

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22490d3
docs: Improve documentation for `DocumentReference.create`.
ehsannas Oct 23, 2023
a8cbc1d
Merge branch 'main' into ehsann/improve-create-documentation
MarkDuckworth Oct 24, 2023
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
2 changes: 1 addition & 1 deletion dev/src/reference.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ export class DocumentReference<
*
* @param {DocumentData} data An object that contains the fields and data to
* serialize as the document.
* @throws {Error} If the provided input is not a valid Firestore document.
* @throws {Error} If the provided input is not a valid Firestore document or if the document already exists.
* @returns {Promise.<WriteResult>} A Promise that resolves with the
* write time of this create.
*
Expand Down
2 changes: 1 addition & 1 deletion types/firestore.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1273,7 +1273,7 @@ declare namespace FirebaseFirestore {
* provided object values. The write fails if the document already exists
*
* @param data The object data to serialize as the document.
* @throws Error If the provided input is not a valid Firestore document.
* @throws {Error} If the provided input is not a valid Firestore document or if the document already exists.
* @return A Promise resolved with the write time of this create.
*/
create(data: WithFieldValue<AppModelType>): Promise<WriteResult>;
Expand Down