firebase-admin.functions package

Firebase Functions サービスとして識別されます。

関数

関数	説明
getFunctions（アプリ）	デフォルト アプリまたは特定のアプリの Functions サービスを取得します。getFunctions() は、引数なしでデフォルト アプリの Functions サービスにアクセスするか、getFunctions(app) として呼び出して、特定のアプリに関連付けられた Functions サービスにアクセスできます。

クラス

クラス	説明
関数	Firebase Functions サービス インターフェース。
タスクキュー	TaskQueue インターフェース。

インターフェース

インターフェース	説明
AbsoluteDelivery	絶対配信によるタスク オプションを表すインターフェース。
DelayDelivery	配信の遅延があるタスク オプションを表すインターフェース。
TaskOptions 試験運用版	試験運用版（ベータ版）のタスク オプションを表すタイプ。

型エイリアス

型エイリアス	説明
配信スケジュール	配信スケジュール オプションを表すタイプ。DeliverySchedule は、DelayDelivery タイプと AbsoluteDelivery タイプのユニオン型です。
TaskOptions	タスク オプションを表す型。

getFunctions（アプリ）

デフォルト アプリまたは特定のアプリの Functions サービスを取得します。

getFunctions() を引数なしで呼び出すと、デフォルト アプリの Functions サービスにアクセスできます。getFunctions(app) として呼び出すと、特定のアプリに関連付けられた Functions サービスにアクセスできるようになります。

署名:

export declare function getFunctions(app?: App): Functions;

パラメータ

パラメータ	型	説明
アプリ	アプリ	Functions サービスを返すオプションのアプリ。指定しない場合は、デフォルトの Functions サービスが返されます。

戻り値:

関数

アプリが指定されていない場合は、デフォルトの Functions サービス、または指定されたアプリに関連付けられた Functions サービス。

例 1

// Get the `Functions` service for the default app
const defaultFunctions = getFunctions();

例 2

// Get the `Functions` service for a given app
const otherFunctions = getFunctions(otherApp);

配信スケジュール

配信スケジュール オプションを表すタイプ。DeliverySchedule は、DelayDelivery タイプと AbsoluteDelivery タイプのユニオン型です。

署名:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

TaskOptions

タスク オプションを表す型。

署名:

export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
    dispatchDeadlineSeconds?: number;
    id?: string;
    headers?: Record<string, string>;
};