firestore namespace

Функции

Функция Описание
onDocumentCreated (документ, обработчик) Обработчик событий, который срабатывает при создании документа в Firestore.
onDocumentCreated (опции, обработчик) Обработчик событий, который срабатывает при создании документа в Firestore.
onDocumentDeleted (документ, обработчик) Обработчик событий, который срабатывает при удалении документа в Firestore.
onDocumentDeleted (опции, обработчик) Обработчик событий, который срабатывает при удалении документа в Firestore.
onDocumentUpdated (документ, обработчик) Обработчик событий, который срабатывает при обновлении документа в Firestore.
onDocumentUpdated (опции, обработчик) Обработчик событий, который срабатывает при обновлении документа в Firestore.
onDocumentWritten (документ, обработчик) Обработчик событий, который срабатывает при создании, обновлении или удалении документа в Firestore.
onDocumentWritten (опции, обработчик) Обработчик событий, который срабатывает при создании, обновлении или удалении документа в Firestore.

Классы

Сорт Описание
Изменять Интерфейс облачных функций для событий, которые меняют состояние, таких как события onWrite и onUpdate для базы данных реального времени или Cloud Firestore. Дополнительные сведения о формате, используемом для создания объектов Change , см. ниже.

Интерфейсы

Интерфейс Описание
Параметры документа DocumentOptions расширяет EventHandlerOptions предоставленным документом, а также дополнительной базой данных и пространством имен.
FirestoreEvent CloudEvent, содержащий моментальный снимок документа или изменение.

Введите псевдонимы

Введите псевдоним Описание
Снимок документа Снимок документа Firestore
Снимок документа запроса Снимок документа Firestore QueryDocumentSnapshot

firestore.onDocumentCreated()

Обработчик событий, который срабатывает при создании документа в Firestore.

Подпись:

export declare function onDocumentCreated<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
документ Документ Путь к документу Firestore для запуска.
обработчик (событие: FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз при создании Firestore.

Возврат:

Облачная функция < FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>>

firestore.onDocumentCreated()

Обработчик событий, который срабатывает при создании документа в Firestore.

Подпись:

export declare function onDocumentCreated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
выбирает Параметры документа <Документ> Параметры, которые можно установить для отдельной функции обработки событий.
обработчик (событие: FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз при создании Firestore.

Возврат:

Облачная функция < FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>>

firestore.onDocumentDeleted()

Обработчик событий, который срабатывает при удалении документа в Firestore.

Подпись:

export declare function onDocumentDeleted<Document extends string>(document: Document, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
документ Документ Путь к документу Firestore для запуска.
обработчик (событие: FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз, когда происходит удаление Firestore.

Возврат:

Облачная функция < FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>>

firestore.onDocumentDeleted()

Обработчик событий, который срабатывает при удалении документа в Firestore.

Подпись:

export declare function onDocumentDeleted<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<QueryDocumentSnapshot | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
выбирает Параметры документа <Документ> Параметры, которые можно установить для отдельной функции обработки событий.
обработчик (событие: FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз, когда происходит удаление Firestore.

Возврат:

Облачная функция < FirestoreEvent < Снимок QueryDocumentSnapshot | не определено, ПарамсОф <Документ>>>

firestore.onDocumentUpdated()

Обработчик событий, который срабатывает при обновлении документа в Firestore.

Подпись:

export declare function onDocumentUpdated<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
документ Документ Путь к документу Firestore для запуска.
обработчик (событие: FirestoreEvent < Изменить < Снимок QueryDocument > | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз при обновлении Firestore.

Возврат:

Облачная функция < FirestoreEvent < Изменить < Снимок QueryDocument > | не определено, ПарамсОф <Документ>>>

firestore.onDocumentUpdated()

Обработчик событий, который срабатывает при обновлении документа в Firestore.

Подпись:

export declare function onDocumentUpdated<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<QueryDocumentSnapshot> | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
выбирает Параметры документа <Документ> Параметры, которые можно установить для отдельной функции обработки событий.
обработчик (событие: FirestoreEvent < Изменить < Снимок QueryDocument > | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз при обновлении Firestore.

Возврат:

Облачная функция < FirestoreEvent < Изменить < Снимок QueryDocument > | не определено, ПарамсОф <Документ>>>

firestore.onDocumentWritten()

Обработчик событий, который срабатывает при создании, обновлении или удалении документа в Firestore.

Подпись:

export declare function onDocumentWritten<Document extends string>(document: Document, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
документ Документ Путь к документу Firestore для запуска.
обработчик (событие: FirestoreEvent < Изменить < Снимок документа > | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз, когда происходит создание, обновление или удаление Firestore.

Возврат:

Облачная функция < FirestoreEvent < Изменить < Снимок документа > | не определено, ПарамсОф <Документ>>>

firestore.onDocumentWritten()

Обработчик событий, который срабатывает при создании, обновлении или удалении документа в Firestore.

Подпись:

export declare function onDocumentWritten<Document extends string>(opts: DocumentOptions<Document>, handler: (event: FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>) => any | Promise<any>): CloudFunction<FirestoreEvent<Change<DocumentSnapshot> | undefined, ParamsOf<Document>>>;

Параметры

Параметр Тип Описание
выбирает Параметры документа <Документ> Параметры, которые можно установить для отдельной функции обработки событий.
обработчик (событие: FirestoreEvent < Изменить < Снимок документа > | не определено, ПарамсОф <Документ>>) => любой | Обещание <любое> Обработчик событий, который запускается каждый раз, когда происходит создание, обновление или удаление Firestore.

Возврат:

Облачная функция < FirestoreEvent < Изменить < Снимок документа > | не определено, ПарамсОф <Документ>>>

firestore.DocumentSnapshot

Снимок документа Firestore

Подпись:

export type DocumentSnapshot = firestore.DocumentSnapshot;

firestore.QueryDocumentSnapshot

Снимок документа Firestore QueryDocumentSnapshot

Подпись: 

export type QueryDocumentSnapshot = firestore.QueryDocumentSnapshot;