QueryDocumentSnapshot
содержит данные, считанные из документа в вашей базе данных Firestore как часть запроса. Документ гарантированно существует, и его данные можно извлечь с помощью .data()
или .get(<field>)
для получения определенного поля.
QueryDocumentSnapshot
предлагает ту же поверхность API, что и DocumentSnapshot
. Поскольку результаты запроса содержат только существующие документы, свойство exists
всегда будет иметь значение true, а data()
никогда не вернет значение «неопределено».
Подпись:
export declare class QueryDocumentSnapshot<AppModelType = DocumentData, DbModelType extends DocumentData = DocumentData> extends DocumentSnapshot<AppModelType, DbModelType>
Расширяет: DocumentSnapshot <AppModelType, DbModelType>
Методы
Метод | Модификаторы | Описание |
---|---|---|
данные (варианты) | Извлекает все поля документа как Object . По умолчанию значения serverTimestamp() , которым еще не присвоено окончательное значение, будут возвращены как null . Вы можете переопределить это, передав объект параметров. |
QueryDocumentSnapshot.data()
Извлекает все поля документа как Object
.
По умолчанию значения serverTimestamp()
, которым еще не присвоено окончательное значение, будут возвращены как null
. Вы можете переопределить это, передав объект параметров.
Подпись:
/** @override */
data(options?: SnapshotOptions): AppModelType;
Параметры
Параметр | Тип | Описание |
---|---|---|
параметры | Параметры моментального снимка | Объект параметров для настройки способа получения данных из моментального снимка (например, желаемое поведение для временных меток сервера, которым еще не присвоено окончательное значение). |
Возврат:
AppModelType
Object
, содержащий все поля в документе.