Class DocumentReference

Represents a Document in a Firestore A DocumentReference does not gaurantee a Document exists

Hierarchy

DocumentReference

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new DocumentReference(firestore: Firestore, path: string): DocumentReference

- Defined in src/DocumentReference.ts:21
Parameters
- firestore: Firestore
- path: string
Returns DocumentReference

Properties

Private firestore

firestore: Firestore

Firestore to which the Document belongs

path

path: string

Document path

Methods

collection

collection(path: string): CollectionReference

- Defined in src/DocumentReference.ts:32
Get a subcollection of the document

Parameters
- path: string
  
  Path to subcollection
Returns CollectionReference

delete

delete(): Promise<boolean>

- Defined in src/DocumentReference.ts:84
Deletes a Document from Firestore

Returns Promise<boolean>

get

get(): Promise<DocumentSnapshot>

- Defined in src/DocumentReference.ts:39
Read the Document from Firestore

Returns Promise<DocumentSnapshot>

Private parseResponse

parseResponse(response: RequestAsyncResponse): DocumentSnapshot

- Defined in src/DocumentReference.ts:102
Decodes a JSON-formatted response into a DocumentSnapshot

Parameters
- response: RequestAsyncResponse
  
  JSON-formatted response
Returns DocumentSnapshot

set

set(data: DocumentData): Promise<DocumentSnapshot>

- Defined in src/DocumentReference.ts:57
Updates the document in Firestore Creates the document if it does not exist

Parameters
- data: DocumentData
  
  Data for the document
Returns Promise<DocumentSnapshot>

Generated using TypeDoc