DocumentSnapshot class

DocumentSnapshot содержит данные, считанные из документа в вашей базе данных Firestore. Данные можно извлечь с помощью .data() или .get(<field>) для получения определенного поля.

Для DocumentSnapshot , который указывает на несуществующий документ, любой доступ к данным вернет «неопределенное». Вы можете использовать метод exists() для явной проверки существования документа.

Подпись:

export declare class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> 

Конструкторы

Характеристики

Методы

DocumentSnapshot.(конструктор)

Создает новый экземпляр класса DocumentSnapshot

Подпись:

protected constructor();

ДокументСнапшот.id

Свойство DocumentSnapshot , предоставляющее идентификатор документа.

Подпись:

get id(): string;

DocumentSnapshot.metadata

Метаданные о DocumentSnapshot , включая информацию о его источнике и локальных модификациях.

Подпись:

readonly metadata: SnapshotMetadata;

ДокументСнапшот.ref

DocumentReference для документа, включенного в DocumentSnapshot .

Подпись:

get ref(): DocumentReference<AppModelType, DbModelType>;

ДокументСнапшот.данные()

Извлекает все поля документа как Object . Возвращает undefined если документ не существует.

По умолчанию значения serverTimestamp() , которым еще не присвоено окончательное значение, будут возвращены как null . Вы можете переопределить это, передав объект параметров.

Подпись:

data(options?: SnapshotOptions): AppModelType | undefined;

Параметры

Возврат:

ТипМодели Приложения | неопределенный

Object , содержащий все поля в документе или undefined если документ не существует.

ДокументСнапшот.exists()

Возвращает, существуют ли данные. Истинно, если документ существует.

Подпись:

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;

Возврат:

это QueryDocumentSnapshot <AppModelType, DbModelType>

ДокументСнапшот.get()

Получает поле, указанное в fieldPath . Возвращает undefined если документ или поле не существует.

По умолчанию для serverTimestamp() , которому еще не присвоено окончательное значение, будет возвращено значение null . Вы можете переопределить это, передав объект параметров.

Подпись:

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;

Параметры

Возврат:

любой

Данные в указанном местоположении поля или неопределенные, если такое поле не существует в документе.