DocumentSnapshot class

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

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

Подпись:

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

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

Конструктор Модификаторы Описание
(конструктор)() Создает новый экземпляр класса DocumentSnapshot .

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

Свойство Модификаторы Тип Описание
идентификатор нить Свойство DocumentSnapshot , предоставляющее идентификатор документа.
ссылка Ссылка на документ <AppModelType, DbModelType> DocumentReference для документа, включенного в DocumentSnapshot .

Методы

Метод Модификаторы Описание
данные() Извлекает все поля документа как Object . Возвращает undefined , если документ не существует.
существует() Сигнализирует о том, существует ли документ в месте снимка.
получить (путь к полю) Извлекает поле, указанное в fieldPath . Возвращает undefined , если документ или поле не существует.

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

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

Подпись:

protected constructor();

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

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

Подпись:

get id(): string;

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

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

Подпись:

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

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

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

Подпись:

data(): AppModelType | undefined;

Возврат:

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

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

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

Сигнализирует о том, существует ли документ в месте снимка.

Подпись:

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

Возврат:

это QueryDocumentSnapshot <AppModelType, DbModelType>

true, если документ существует.

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

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

Подпись:

get(fieldPath: string | FieldPath): any;

Параметры

Параметр Тип Описание
полеПуть строка | ФилдПат Путь (например, «foo» или «foo.bar») к определенному полю.

Возврат:

любой

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