DocumentReference

A DocumentReference refers to a document location in a Firestore database and can be used to write, read, or listen to the location. The document at the referenced location may or may not exist.

class DocumentReference<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> {

private constructor();

readonly converter: FirestoreDataConverter<AppModelType, DbModelType> | null;

readonly firestore: Firestore;

get id(): string;

get path(): string;

get parent(): CollectionReference<AppModelType, DbModelType>;

readonly type: string;

toJSON(): object;

withConverter<NewAppModelType, NewDbModelType extends DocumentData = DocumentData>(converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>;

withConverter(converter: null): DocumentReference<DocumentData, DocumentData>;

static fromJSON(firestore: Firestore, json: object): DocumentReference;

static fromJSON<NewAppModelType = DocumentData, NewDbModelType extends DocumentData = DocumentData>(

firestore: Firestore,

json: object,

converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>,

): DocumentReference<NewAppModelType, NewDbModelType>;

}

§Type Parameters

AppModelType = DocumentData

[src]

DbModelType extends DocumentData = DocumentData

[src]

§Constructors

new DocumentReference() private

[src]

§Properties

converter: FirestoreDataConverter<AppModelType, DbModelType> | null

[src]

If provided, the FirestoreDataConverter associated with this instance.

firestore: Firestore

[src]

The Firestore instance the document is in. This is useful for performing transactions, for example.

id: string readonly

[src]

The document's identifier within its collection.

path: string readonly

[src]

A string representing the path of the referenced document (relative to the root of the database).

parent: CollectionReference<AppModelType, DbModelType> readonly

[src]

The collection this DocumentReference belongs to.

type: string

[src]

The type of this Firestore reference.

§Methods

toJSON(): object

[src]

Returns a JSON-serializable representation of this DocumentReference instance.

@return

a JSON representation of this object.

[src]

Applies a custom data converter to this DocumentReference, allowing you to use your own custom model objects with Firestore. When you call {@link

@param converter

Converts objects to and from Firestore.

@return

A DocumentReference that uses the provided converter.

withConverter(converter: null): DocumentReference<DocumentData, DocumentData>

[src]

Removes the current converter.

@param converter

null removes the current converter.

@return

A DocumentReference<DocumentData, DocumentData> that does not use a converter.

§Static Methods

fromJSON(firestore: Firestore, json: object): DocumentReference

[src]

Builds a DocumentReference instance from a JSON object created by DocumentReference.toJSON.

@param firestore

The Firestore instance the snapshot should be loaded for.

@param json

a JSON object represention of a DocumentReference instance

@return

an instance of DocumentReference if the JSON object could be parsed. Throws a FirestoreError if an error occurs.

fromJSON<NewAppModelType = DocumentData, NewDbModelType extends DocumentData = DocumentData>(firestore: Firestore, json: object, converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>): DocumentReference<NewAppModelType, NewDbModelType>

[src]

Builds a DocumentReference instance from a JSON object created by DocumentReference.toJSON.

@param firestore

The Firestore instance the snapshot should be loaded for.

@param json

a JSON object represention of a DocumentReference instance

@param converter

Converts objects to and from Firestore.

@return

an instance of DocumentReference if the JSON object could be parsed. Throws a FirestoreError if an error occurs.