@mathrunet/masamune/dist/lib/src/firestore_triggered_process_function_base.d.ts

Manages packages for the server portion (NodeJS) of the Masamune framework.

import * as functions from "firebase-functions/v2";
import { DatabasePathFunctionsOptions, FunctionsBase } from "./functions_base";
/**
 * Base class for defining Function data for Firestore triggers.
 *
 * Firestoreのトリガー用のFunctionのデータを定義するためのベースクラス。
 */
export declare abstract class FirestoreTriggeredProcessFunctionBase extends FunctionsBase {
    /**
     * Base class for defining Function data for Firestore triggers.
     *
     * Firestoreのトリガー用のFunctionのデータを定義するためのベースクラス。
     */
    constructor(options?: DatabasePathFunctionsOptions);
    /**
     * Specifies the path to be processed.
     *
     * 処理を実行する対象のパスを指定します。
     *
     * https://firebase.google.com/docs/functions/firestore-events
     */
    abstract path: string;
    /**
     * Specifies the database.
     *
     * データベースを指定します。
     */
    database: string | undefined | null;
    /**
     * Specify the actual contents of the process.
     *
     * 実際の処理の中身を指定します。
     */
    abstract process(event: functions.firestore.FirestoreEvent<functions.firestore.Change<functions.firestore.DocumentSnapshot> | undefined, Record<string, string>>): Promise<void>;
    abstract id: string;
    data: {
        [key: string]: any;
    };
    build(regions: string[]): Function;
}