Подпись:
export declare class DocumentBuilder<Path extends string>
Конструкторы
| Конструктор | Модификаторы | Описание |
|---|---|---|
| (конструктор) (triggerResource, параметры) | Создает новый экземпляр класса DocumentBuilder . |
Методы
| Метод | Модификаторы | Описание |
|---|---|---|
| onCreate (обработчик) | Реагируйте только на создание документов. | |
| onDelete (обработчик) | Реагировать только на удаление документов. | |
| onUpdate (обработчик) | Отвечайте только на обновления документов. | |
| onWrite (обработчик) | Реагировать на все записи документов (создание, обновление или удаление). |
firestore.DocumentBuilder.(конструктор)
Создает новый экземпляр класса DocumentBuilder .
Подпись:
constructor(triggerResource: () => string, options: DeploymentOptions);
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| триггерРесурс | () => строка | |
| параметры | Параметры развертывания |
firestore.DocumentBuilder.onCreate()
Реагируйте только на создание документов.
Подпись:
onCreate(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| обработчик | (снимок: QueryDocumentSnapshot , контекст: EventContext <ParamsOf<Path>>) => PromiseLike<any> | любой |
Возврат:
Облачная функция < Снимок QueryDocument >
firestore.DocumentBuilder.onDelete()
Реагировать только на удаление документов.
Подпись:
onDelete(handler: (snapshot: QueryDocumentSnapshot, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<QueryDocumentSnapshot>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| обработчик | (снимок: QueryDocumentSnapshot , контекст: EventContext <ParamsOf<Path>>) => PromiseLike<any> | любой |
Возврат:
Облачная функция < Снимок QueryDocument >
firestore.DocumentBuilder.onUpdate()
Отвечайте только на обновления документов.
Подпись:
onUpdate(handler: (change: Change<QueryDocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<QueryDocumentSnapshot>>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| обработчик | (изменение: Изменить < Снимок QueryDocument >, контекст: EventContext <ParamsOf<Path>>) => PromiseLike<any> | любой |
Возврат:
Облачная функция < Изменить < Снимок QueryDocument >>
firestore.DocumentBuilder.onWrite()
Реагировать на все записи документов (создание, обновление или удаление).
Подпись:
onWrite(handler: (change: Change<DocumentSnapshot>, context: EventContext<ParamsOf<Path>>) => PromiseLike<any> | any): CloudFunction<Change<DocumentSnapshot>>;
Параметры
| Параметр | Тип | Описание |
|---|---|---|
| обработчик | (изменение: Изменить < Снимок документа >, контекст: EventContext <ParamsOf<Path>>) => PromiseLike<any> | любой |
Возврат:
Облачная функция < Изменить < Снимок документа >>