Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://cloud.google.com/nodejs/docs/reference/firestore/6.3.0/firestore/documentreference below:

Class DocumentReference (6.3.0) | Node.js client library

Stay organized with collections Save and categorize content based on your preferences.

• 7.11.0 (latest)
• 7.9.0
• 7.7.0
• 7.6.0
• 7.5.0
• 7.4.0
• 7.3.1
• 7.2.0
• 7.1.0
• 6.4.1
• 6.3.0
• 6.0.0
• 5.0.2
• 4.15.1
• 4.14.2
• 4.9.8

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. A DocumentReference can also be used to create a [CollectionReference]CollectionReference to a subcollection.

DocumentReference

constructor(_firestore: Firestore, 
    _path: ResourcePath, 
    _converter?: firestore.FirestoreDataConverter<T>);

Constructs a new instance of the DocumentReference class

The Firestore Database client.

The Path of this reference.

The converter to use when serializing data.

readonly _converter: firestore.FirestoreDataConverter<T>;

readonly _path: ResourcePath;

get firestore(): Firestore;

The [Firestore]Firestore instance for the Firestore database (useful for performing transactions, etc.).

{Firestore} DocumentReference#firestore

let collectionRef = firestore.collection('col');

collectionRef.add({foo: 'bar'}).then(documentReference => {
  let firestore = documentReference.firestore;
  console.log(`Root location for document is ${firestore.formattedName}`);
});

The last path element of the referenced document.

{string} DocumentReference#id

let collectionRef = firestore.collection('col');

collectionRef.add({foo: 'bar'}).then(documentReference => {
  console.log(`Added document with name '${documentReference.id}'`);
});

get parent(): CollectionReference<T>;

A reference to the collection to which this DocumentReference belongs.

DocumentReference#parent {CollectionReference}

let documentRef = firestore.doc('col/doc');
let collectionRef = documentRef.parent;

collectionRef.where('foo', '==', 'bar').get().then(results => {
  console.log(`Found ${results.size} matches in parent collection`);
}):

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

{string} DocumentReference#path

let collectionRef = firestore.collection('col');

collectionRef.add({foo: 'bar'}).then(documentReference => {
  console.log(`Added document at '${documentReference.path}'`);
});

collection(collectionPath: string): CollectionReference;

Gets a [CollectionReference]CollectionReference instance that refers to the collection at the specified path.

A slash-separated path to a collection.

{CollectionReference} A reference to the new subcollection.

let documentRef = firestore.doc('col/doc');
let subcollection = documentRef.collection('subcollection');
console.log(`Path to subcollection: ${subcollection.path}`);

create(data: firestore.WithFieldValue<T>): Promise<WriteResult>;

Create a document with the provided object values. This will fail the write if a document exists at its location.

An object that contains the fields and data to serialize as the document.

let documentRef = firestore.collection('col').doc();

documentRef.create({foo: 'bar'}).then((res) => {
  console.log(`Document created at ${res.updateTime}`);
}).catch((err) => {
  console.log(`Failed to create document: ${err}`);
});

delete(precondition?: firestore.Precondition): Promise<WriteResult>;

Deletes the document referred to by this DocumentReference.

A delete for a non-existing document is treated as a success (unless lastUptimeTime is provided).

A precondition to enforce for this delete.

let documentRef = firestore.doc('col/doc');

documentRef.delete().then(() => {
  console.log('Document successfully deleted.');
});

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

Reads the document referred to by this DocumentReference.

let documentRef = firestore.doc('col/doc');

documentRef.get().then(documentSnapshot => {
  if (documentSnapshot.exists) {
    console.log('Document retrieved successfully.');
  }
});

isEqual(other: firestore.DocumentReference<T>): boolean;

Returns true if this DocumentReference is equal to the provided value.

The value to compare against. {boolean} true if this DocumentReference is equal to the provided value.

listCollections(): Promise<Array<CollectionReference<firestore.DocumentData>>>;

Fetches the subcollections that are direct children of this document.

{Promise.<Array.

let documentRef = firestore.doc('col/doc');

documentRef.listCollections().then(collections => {
  for (let collection of collections) {
    console.log(`Found subcollection with id: ${collection.id}`);
  }
});

onSnapshot(onNext: (snapshot: firestore.DocumentSnapshot<T>) => void, onError?: (error: Error) => void): () => void;

Attaches a listener for DocumentSnapshot events.

A callback to be called every time a new DocumentSnapshot is available.

A callback to be called if the listen fails or is cancelled. No further callbacks will occur. If unset, errors will be logged to the console.

{function()} An unsubscribe function that can be called to cancel the snapshot listener.

let documentRef = firestore.doc('col/doc');

let unsubscribe = documentRef.onSnapshot(documentSnapshot => {
  if (documentSnapshot.exists) {
    console.log(documentSnapshot.data());
  }
}, err => {
  console.log(`Encountered error: ${err}`);
});

// Remove this listener.
unsubscribe();

set(data: firestore.PartialWithFieldValue<T>, options: firestore.SetOptions): Promise<WriteResult>;

set(data: firestore.WithFieldValue<T>): Promise<WriteResult>;

update(dataOrField: firestore.UpdateData<T> | string | firestore.FieldPath, ...preconditionOrValues: Array<unknown | string | firestore.FieldPath | firestore.Precondition>): Promise<WriteResult>;

Updates fields in the document referred to by this DocumentReference. If the document doesn't yet exist, the update fails and the returned Promise will be rejected.

The update() method accepts either an object with field paths encoded as keys and field values encoded as values, or a variable number of arguments that alternate between field paths and field values.

A Precondition restricting this update can be specified as the last argument.

An object containing the fields and values with which to update the document or the path of the first field to update.

An alternating list of field paths and values to update or a Precondition to restrict this update.

let documentRef = firestore.doc('col/doc');

documentRef.update({foo: 'bar'}).then(res => {
  console.log(`Document updated at ${res.updateTime}`);
});

withConverter(converter: null): DocumentReference<firestore.DocumentData>;

withConverter<U>(converter: firestore.FirestoreDataConverter<U>): DocumentReference<U>;

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4