-
-
Notifications
You must be signed in to change notification settings - Fork 0
Add standalone document mutation functions #10
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
aa482ab
Add standalone document mutation functions
0x80 10e632e
Document standalone write functions in README and CLAUDE.md
0x80 6f84926
Use overloads for set functions to match Firebase's setDoc signature
0x80 597e783
Fix README formatting
0x80 cf882e1
Widen implementation signature to accept both overload data types
0x80 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| import { | ||
| doc, | ||
| setDoc, | ||
| updateDoc, | ||
| deleteDoc, | ||
| type CollectionReference, | ||
| type DocumentData, | ||
| type DocumentReference, | ||
| type PartialWithFieldValue, | ||
| type SetOptions, | ||
| type UpdateData, | ||
| type WithFieldValue, | ||
| } from "firebase/firestore"; | ||
|
|
||
| export function setDocument<T extends DocumentData>( | ||
| collectionRef: CollectionReference<T>, | ||
| documentId: string, | ||
| data: WithFieldValue<T>, | ||
| ): Promise<void>; | ||
| export function setDocument<T extends DocumentData>( | ||
| collectionRef: CollectionReference<T>, | ||
| documentId: string, | ||
| data: PartialWithFieldValue<T>, | ||
| options: SetOptions, | ||
| ): Promise<void>; | ||
| export function setDocument<T extends DocumentData>( | ||
| collectionRef: CollectionReference<T>, | ||
| documentId: string, | ||
| data: WithFieldValue<T> | PartialWithFieldValue<T>, | ||
| options?: SetOptions, | ||
| ): Promise<void> { | ||
| if (options) { | ||
| return setDoc(doc(collectionRef, documentId), data as PartialWithFieldValue<T>, options); | ||
| } | ||
| return setDoc(doc(collectionRef, documentId), data as WithFieldValue<T>); | ||
| } | ||
|
|
||
| export function setSpecificDocument<T extends DocumentData>( | ||
| documentRef: DocumentReference<T>, | ||
| data: WithFieldValue<T>, | ||
| ): Promise<void>; | ||
| export function setSpecificDocument<T extends DocumentData>( | ||
| documentRef: DocumentReference<T>, | ||
| data: PartialWithFieldValue<T>, | ||
| options: SetOptions, | ||
| ): Promise<void>; | ||
| export function setSpecificDocument<T extends DocumentData>( | ||
| documentRef: DocumentReference<T>, | ||
| data: WithFieldValue<T> | PartialWithFieldValue<T>, | ||
| options?: SetOptions, | ||
| ): Promise<void> { | ||
| if (options) { | ||
| return setDoc(documentRef, data as PartialWithFieldValue<T>, options); | ||
| } | ||
| return setDoc(documentRef, data as WithFieldValue<T>); | ||
| } | ||
|
|
||
| export function updateDocument<T extends DocumentData>( | ||
| collectionRef: CollectionReference<T>, | ||
| documentId: string, | ||
| data: UpdateData<T>, | ||
| ): Promise<void> { | ||
| return updateDoc(doc(collectionRef, documentId), data); | ||
| } | ||
|
|
||
| export function updateSpecificDocument<T extends DocumentData>( | ||
| documentRef: DocumentReference<T>, | ||
| data: UpdateData<T>, | ||
| ): Promise<void> { | ||
| return updateDoc(documentRef, data); | ||
| } | ||
|
|
||
| export function deleteDocument<T extends DocumentData>( | ||
| collectionRef: CollectionReference<T>, | ||
| documentId: string, | ||
| ): Promise<void> { | ||
| return deleteDoc(doc(collectionRef, documentId)); | ||
| } | ||
|
|
||
| export function deleteSpecificDocument<T extends DocumentData>( | ||
| documentRef: DocumentReference<T>, | ||
| ): Promise<void> { | ||
| return deleteDoc(documentRef); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.