Class DocumentReference<T>

constructor

• new DocumentReference<T = DocumentData>(
      _firestore: FirestoreClientInterface,
      path: string,
  ): DocumentReference<T>

  Type Parameters

  • T = DocumentData

  Parameters

  • _firestore: FirestoreClientInterface
  • path: string

  Returns DocumentReference<T>

Readonlyid

Readonlypath

parent

• get parent(): CollectionReference<T>

  Get the parent collection reference.

  Returns CollectionReference<T>

collection

• collection(collectionPath: string): CollectionReference

  Get a subcollection of this document.

  Parameters

  • collectionPath: string

  Returns CollectionReference

delete

• delete(): Promise<void>

  Delete the document.

  Returns Promise<void>

get

• get(): Promise<DocumentSnapshot<T>>

  Get the document.

  Returns Promise<DocumentSnapshot<T>>

set

• set(data: T, options?: { merge?: boolean }): Promise<WriteResult>

  Set the document data.

  Parameters

  • data: T
  • Optionaloptions: { merge?: boolean }

  Returns Promise<WriteResult>

update

• update(data: Partial<T>): Promise<WriteResult>

  Update the document data.

  Parameters

  • data: Partial<T>

  Returns Promise<WriteResult>